STDF mirror - Mobile web component library based on Svelte and Tailwind

dufu1991 0e825289c6 [doc]Fix NumKeyboard api 2 years ago
.github 4c3dc57abf [action]Change build demo 2 years ago
demo fe6d32820c [demo]Add script mode 2 years ago
doc 0e825289c6 [doc]Fix NumKeyboard api 2 years ago
packages 6e1043cdd6 [stdf]@v0.3.0 Add NumKeyboard 2 years ago
.eslintignore 5750ba48ea format 3 years ago
.eslintrc.js 5750ba48ea format 3 years ago
.gitignore f3432d5d06 [demo]Add NumKeyboard demo 2 years ago
.prettierrc.js 5750ba48ea format 3 years ago
LICENSE 16a309bc4c Initial commit 3 years ago
README.md c85ae41c53 Add Sponsors 2 years ago
README_CN.md c85ae41c53 Add Sponsors 2 years ago
package.json 5750ba48ea format 3 years ago

README.md

[![Public STDF Status](https://github.com/dufu1991/stdf/actions/workflows/publish-stdf.yml/badge.svg)](https://github.com/dufu1991/stdf/actions/workflows/publish-stdf.yml) [![Releases Status](https://github.com/dufu1991/stdf/actions/workflows/releases.yml/badge.svg)](https://github.com/dufu1991/stdf/actions/workflows/releases.yml) [![Sync Status](https://github.com/dufu1991/stdf/actions/workflows/sync-demo.yml/badge.svg)](https://github.com/dufu1991/stdf/actions/workflows/sync-demo.yml) [![Build Status](https://github.com/dufu1991/stdf/actions/workflows/build-demo.yml/badge.svg)](https://github.com/dufu1991/stdf/actions/workflows/build-demo.yml) [![Public Create Status](https://github.com/dufu1991/stdf/actions/workflows/publish-create.yml/badge.svg)](https://github.com/dufu1991/stdf/actions/workflows/publish-create.yml) [![Public Icon Status](https://github.com/dufu1991/stdf/actions/workflows/publish-icon.yml/badge.svg)](https://github.com/dufu1991/stdf/actions/workflows/publish-icon.yml) [![Public VS Code Extension Status](https://github.com/dufu1991/stdf/actions/workflows/publish-vscode.yml/badge.svg)](https://github.com/dufu1991/stdf/actions/workflows/publish-vscode.yml) [![Sync Gitee Status](https://github.com/dufu1991/stdf/actions/workflows/sync-gitee.yml/badge.svg)](https://github.com/dufu1991/stdf/actions/workflows/sync-gitee.yml) logo

S T D F

[![npm](https://img.shields.io/npm/v/stdf?logo=npm&label=stdf&style=flat-square)](https://www.npmjs.com/package/stdf) [![npm](https://img.shields.io/npm/dt/stdf?logo=npm&label=installs&style=flat-square)](https://www.npmjs.com/package/stdf) [![npm bundle size](https://img.shields.io/bundlephobia/minzip/stdf?logo=npm&label=minzip&style=flat-square)](https://www.npmjs.com/package/stdf) [![GitHub stars](https://img.shields.io/github/stars/dufu1991/stdf?logo=github&label=stars&style=flat-square)](https://github.com/dufu1991/stdf) [![GitHub license](https://img.shields.io/github/license/dufu1991/stdf?logo=github&style=flat-square)](https://github.com/dufu1991/stdf) [![npm](https://img.shields.io/npm/v/create-stdf?logo=npm&label=create&style=flat-square)](https://www.npmjs.com/package/create-stdf) [![npm](https://img.shields.io/npm/v/rollup-plugin-stdf-icon?logo=npm&label=icon&style=flat-square)](https://www.npmjs.com/package/rollup-plugin-stdf-icon) [![Visual Studio Marketplace Version (including pre-releases)](https://img.shields.io/visual-studio-marketplace/v/STDF.stdf-vscode-extension?logo=visualstudiocode&label=extension&style=flat-square)](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.
  • 📖 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=dufu1991/stdf&type=Timeline&theme=dark" />
<img alt="Star History Chart" width="100%" src="https://api.star-history.com/svg?repos=dufu1991/stdf&type=Timeline" />