Skip to content

fuzdev/fuz_ui

Repository files navigation

fuz_ui

a friendly brown spider facing you

friendly user zystem 🧶 fuz.dev

fuz_ui is a Svelte UI library with components and helpers for making zippy websites. It's built on fuz_css and provides a documentation system built on svelte-docinfo. fuz_ui emphasizes capability and efficiency and tries to be simple for those goals, while following idiomatic Svelte patterns.

To learn more see the docs and contributing.md. Feel free to take the ideas and code for your own purposes.

The Svelte components and helpers:

  • builds on fuz_css
  • plain CSS and minimal abstraction
  • near-zero dependencies except for Svelte, SvelteKit, fuz_css, and my utility library @fuzdev/fuz_util (not all components require SvelteKit but some do import its modules, needs more consideration)
  • not a fully-featured enterprise-ready set of components, it's being developed for the needs of specific projects, though eventually it will fill out
  • should be easy to copy/paste into your projects when you need full control like shadcn-svelte, I'll look into smoothing this pattern out in the future

Usage

⚠️ Expect breaking changes. If you want to help stabilize the API, please see contributing.md and thank you.

npm i -D @fuzdev/fuz_ui

Fuz uses my style framework fuz_css. Import modules at their full paths:

// fuz_css has one main plain CSS stylesheet:
import '@fuzdev/fuz_css/style.css';

// and import a fuz_css theme:
import '@fuzdev/fuz_css/theme.css'; // or bring your own

// the fuz_css Vite plugin exposes the generated utility classes as a virtual module:
import 'virtual:fuz.css';

// then import Fuz Svelte components:
import ThemeRoot from '@fuzdev/fuz_ui/ThemeRoot.svelte';

// and Fuz TypeScript modules:
import {type Theme, theme_state_context} from '@fuzdev/fuz_ui/theme_state.svelte.ts';

See the library for more.

Contributing

See contributing.md.

Develop

npm i # node >=20.10

# development
npm run dev

# production
npm run build
npm start

Fuz uses Gro, my CLI and toolkit that I use to run tasks in all of my projects. If you're not allergic it's handy to install globally.

License 🐦

MIT

About

Svelte UI library 🧶 friendly user zystem

Topics

Resources

License

Contributing

Stars

0 stars

Watchers

1 watching

Forks

Sponsor this project

  •  

Contributors

Generated from fuzdev/fuz_template