Skip to content

any-tdf/stdf

Repository files navigation

Public STDF Status Releases Status Sync Status Public Create Status Public Icon Status Public VS Code Extension Status Sync Gitee Status Releases Site Releases Demo

logo

S T D F

npm GitHub stars GitHub license npm npm bundle size npm npm Visual Studio Marketplace Version (including pre-releases)

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 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.
  • 🔧 Props supports type prompts and detection.

Getting Started

Installation

If you have a project configured with Svelte and Tailwind, install directly.

pnpm i stdf -D
# or
npm i stdf -D
# or
bun 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.

pnpm create stdf
# or
npm create stdf@latest
# or
npm init stdf@latest
# or
npx create-stdf@latest
# or
bun create stdf

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

Star History Chart