Skip to content
elluzionPublic

About

Svelte 5 UI Theme/Component library for my own projects

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

iv-ui

A Svelte 5 component library with a monochrome dark design system.

Components

All components follow the design system in DESIGN.md and the API contract in COMPONENTS.md.

  • Form & Input — Button, ButtonGroup, Input, Textarea, InputGroup, Field, Checkbox, RadioGroup, Switch, Slider, Select, NativeSelect
  • Layout & Navigation — Card, Article, Tabs (+ TabList, Tab, TabPanel), Accordion (+ AccordionItem), Separator, Breadcrumb, Collapsible
  • Overlays — Dialog, AlertDialog, Sheet, Popover, Tooltip, Menu, ContextMenu, Toast
  • Feedback — Alert, Progress, Skeleton, LoadingSpinner, EmptyState, Badge
  • Display & Misc — Avatar, Shortcut, Toggle, ToggleGroup

Installation

bun add @elluzion/iv-ui @tabler/icons-svelte

@tabler/icons-svelte is a peer dependency and must be installed by consumers.

Svelte 5 runes are required (like this project's components, the package is authored with runes).

Usage

import { Button, Dialog, showToast } from '@elluzion/iv-ui';
import '@elluzion/iv-ui/theme.css';

CSS can also be imported piecemeal:

import '@elluzion/iv-ui/tokens.css';
import '@elluzion/iv-ui/base.css';
import '@elluzion/iv-ui/typeset.css';

Developing

bun dev               # docs site at :5173 (regenerates docs data)
bun run storybook     # component explorer at :6006

The docs site is a prerendered SvelteKit app in this repo. Its content lives in src/docs/ (outside src/lib, so it is not part of the published package), and scripts/docs-gen.ts turns that content into the component pages, Markdown mirrors, API JSON, search index, and llms*.txt corpora at build time.

src/lib/ is the library; src/routes/ serves the docs site and its machine-readable endpoints (not part of the distributed package).

Building

bun run build         # vite build + svelte-package + publint

Linting & Type-Checking

bun run lint          # oxfmt --check + oxlint
bun run check         # svelte-check type-check
bun run format        # oxfmt --write

Testing

bun run test          # standalone Vitest browser tests (Playwright/Chromium)
bun run test:watch    # same, in watch mode
bun run docs:check    # validate docs content (examples, API ids, related links)

Component tests live in src/lib/test/*.test.ts and use Testing Library plus axe (expectAccessible()), so they run without Storybook. Storybook stories remain the interactive documentation and are checked by @storybook/addon-a11y when browsing them.

Publishing

This package is published to GitHub Packages. To release:

  1. Log in / configure auth for https://npm.pkg.github.com (a NODE_AUTH_TOKEN with write:packages in CI).
  2. Create a version commit + v* tag (e.g. v0.2.0) and push; the release workflow builds and publishes.

License

MIT

About

Svelte 5 UI Theme/Component library for my own projects

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages