README_en.md 2.2 KB

logo

S T D F

[![npm (tag)](https://img.shields.io/npm/v/stdf)](https://www.npmjs.com/package/stdf) [![npm](https://img.shields.io/npm/dw/stdf)](https://www.npmjs.com/package/stdf)

中文文档 · Chinese website · English 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;
  • 📖 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.

Getting Started

Installation

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

npm i stdf
# or
yarn add stdf
# or
pnpm i stdf

Usage

<!-- Button Demo -->
<script>
import { Button } from 'stdf';
</script>

<Button>Default</Button>

😓 No project? Create a project with Vite and reference the Vite documentation and the Tailwind CSS documentation for CSS configuration.

Mobile Preview

You can scan the QR code below on your mobile phone to access the mobile demo:

License

This project is licensed under the MIT License. Feel free to enjoy and contribute to this open-source project.