STDF mirror - Mobile web component library based on Svelte and Tailwind
dufu1991
336031e365
[stdf]Add JSDoc
|
2 anni fa | |
|---|---|---|
| .github | 2 anni fa | |
| demo | 2 anni fa | |
| doc | 2 anni fa | |
| packages | 2 anni fa | |
| .eslintignore | 3 anni fa | |
| .eslintrc.js | 2 anni fa | |
| .gitignore | 2 anni fa | |
| .prettierrc.js | 3 anni fa | |
| LICENSE | 3 anni fa | |
| README.md | 2 anni fa | |
| README_CN.md | 2 anni fa | |
| jsconfig.json | 2 anni fa | |
| package.json | 3 anni fa |
README.md
[](https://github.com/any-tdf/stdf/actions/workflows/publish-stdf.yml)
[](https://github.com/any-tdf/stdf/actions/workflows/releases.yml)
[](https://github.com/any-tdf/stdf/actions/workflows/sync-demo.yml)
[](https://github.com/any-tdf/stdf/actions/workflows/build-demo.yml)
[](https://github.com/any-tdf/stdf/actions/workflows/publish-create.yml)
[](https://github.com/any-tdf/stdf/actions/workflows/publish-icon.yml)
[](https://github.com/any-tdf/stdf/actions/workflows/publish-vscode.yml)
[](https://github.com/any-tdf/stdf/actions/workflows/sync-gitee.yml)
S T D F
[](https://www.npmjs.com/package/stdf) [](https://github.com/any-tdf/stdf) [](https://github.com/any-tdf/stdf) [](https://www.npmjs.com/package/stdf) [](https://www.npmjs.com/package/stdf) [](https://www.npmjs.com/package/create-stdf) [](https://www.npmjs.com/package/rollup-plugin-stdf-icon) [](https://marketplace.visualstudio.com/items?itemName=STDF.stdf-vscode-extension)简体中文 • Website
Introduction
Mobile web component library based on Svelte and Tailwind .
Simple • Thin • Design • Fast
Features
- 🚀 No runtime, no virtual DOM, runs faster online.
- 🧰 Rich API, easily configure component styles that meet your needs.
- ✍ Based on Svelte and Tailwind, coding is quick and easy.
- 🍭 Supports dark mode and multiple theme configuration.
- 📖 Provides extensive Chinese and English documentation and component examples.
- 🌍 Supports internationalization, with 60+ built-in language packages.
- 🫰 User-friendly interaction, animation parameters can be configured, and custom themes are supported.
- 🤝 Supports Tailwind libraries such as Windi CSS and UnoCSS.
- 🫡 No three -party dependence, no need to worry about the three -party library version and security issues.
- 📦 Supports on-demand import to reduce bundle size.
- 🪜 Comes with a scaffolding tool for quick project creation.
- 🔗 Comes with an SVG merging plugin for quickly merging SVG files.
- 🍺 IDE plugin for quickly viewing component APIs.
Getting Started
Installation
If you have a project configured with Svelte and Tailwind, install directly.
bun i stdf -D
# or
pnpm i stdf -D
# or
npm i stdf -D
Usage
<!-- Button Demo -->
<script>
import { Button } from 'stdf';
</script>
<Button>Default</Button>
😓 No project? Create one
You can try using create-stdf to quickly create a project. (beta version)
bun create stdf
# or
pnpm create stdf
# or
npm create stdf@latest
# or
npm init stdf@latest
# or
npx create-stdf@latest
Alternatively, you can create a Vite project and configure it to use Tailwind CSS and the configurations used by STDF. Refer to Vite & Tailwind CSS & STDF for more information.
Preview
Please scan the QR code to access the mobile demo:
Quick Try
You can quickly try STDF on StackBlitz's STDF Demo.
Feedback and Communication
We recommend using GitHub Issues for direct and effective feedback and communication. Contributions of code are also highly appreciated. You can also choose from the following options:
Contributors
Sponsors
License
This project is licensed under the MIT License. Feel free to enjoy and contribute to this open-source project.
Star History
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=any-tdf/stdf&type=Timeline&theme=dark" />
<img alt="Star History Chart" width="100%" src="https://api.star-history.com/svg?repos=any-tdf/stdf&type=Timeline" />