|
@@ -0,0 +1,69 @@
|
|
|
|
|
+<div align="center">
|
|
|
|
|
+
|
|
|
|
|
+ <img src="https://stdf.design/assets/images/stdf_512px.png" alt="logo" width="100" height="auto" />
|
|
|
|
|
+ <h1>S T D F</h1>
|
|
|
|
|
+
|
|
|
|
|
+[](https://www.npmjs.com/package/stdf) [](https://www.npmjs.com/package/stdf)
|
|
|
|
|
+
|
|
|
|
|
+ <h4>
|
|
|
|
|
+ <a href="https://github.com/dufu1991/stdf/blob/main/README.md" target="_blank">中文文档</a>
|
|
|
|
|
+ <span> · </span>
|
|
|
|
|
+ <a href="https://stdf.design?lang=zh_CN" target="_blank">Chinese website</a>
|
|
|
|
|
+ <span> · </span>
|
|
|
|
|
+ <a href="https://stdf.design?lang=en_US" target="_blank">English website</a>
|
|
|
|
|
+ </h4>
|
|
|
|
|
+</div>
|
|
|
|
|
+
|
|
|
|
|
+# 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;
|
|
|
|
|
+- 🍭 Supports dark mode;
|
|
|
|
|
+- 📖 Provides extensive Chinese and English documentation and component examples;
|
|
|
|
|
+- 🌍 Supports internationalization, with 60+ built-in language packages;
|
|
|
|
|
+- ✍ Based on Svelte and Tailwind, coding is quick and easy;
|
|
|
|
|
+- 🫰 User-friendly interaction, animation parameters can be configured, and custom themes are supported;
|
|
|
|
|
+- 🤝 Supports Tailwind libraries such as Windi CSS and UnoCSS.
|
|
|
|
|
+
|
|
|
|
|
+# Getting Started
|
|
|
|
|
+
|
|
|
|
|
+## Installation
|
|
|
|
|
+
|
|
|
|
|
+If you have a project configured with Svelte and Tailwind, install directly.
|
|
|
|
|
+
|
|
|
|
|
+```bash
|
|
|
|
|
+npm i stdf
|
|
|
|
|
+# or
|
|
|
|
|
+yarn add stdf
|
|
|
|
|
+# or
|
|
|
|
|
+pnpm i stdf
|
|
|
|
|
+```
|
|
|
|
|
+
|
|
|
|
|
+## Usage
|
|
|
|
|
+
|
|
|
|
|
+```xml
|
|
|
|
|
+<!-- Button Demo -->
|
|
|
|
|
+<script>
|
|
|
|
|
+import { Button } from 'stdf';
|
|
|
|
|
+</script>
|
|
|
|
|
+
|
|
|
|
|
+<Button>Default</Button>
|
|
|
|
|
+```
|
|
|
|
|
+
|
|
|
|
|
+😓 No project? Create a project with Vite and reference the [Vite documentation](https://vitejs.dev/guide/#scaffolding-your-first-vite-project) and the [Tailwind CSS documentation](https://tailwindcss.com/docs/guides/vite) for CSS configuration.
|
|
|
|
|
+
|
|
|
|
|
+# Mobile Preview
|
|
|
|
|
+
|
|
|
|
|
+You can scan the QR code below on your mobile phone to access the mobile demo:
|
|
|
|
|
+
|
|
|
|
|
+<img src="https://stdf.design/assets/qr/demo_qr_en.png" width="220" height="220" >
|
|
|
|
|
+
|
|
|
|
|
+# License
|
|
|
|
|
+
|
|
|
|
|
+This project is licensed under the [MIT License](https://github.com/dufu1991/stdf/blob/main/LICENSE). Feel free to enjoy and contribute to this open-source project.
|