You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
A lightweight, composable UI component library for building web interfaces using Rune.
4
+
5
+
## Overview
6
+
7
+
Rune UI is a headless component library that leverages state machines for reliable UI behavior. It focuses on creating reusable, composable UI components with predictable state management.
8
+
9
+
## Features
10
+
11
+
-**State Machine Based**: Every component is built on a finite state machine for predictable behavior
12
+
-**Lightweight**: Minimal dependencies with a focus on performance
13
+
-**Composable**: Components can be easily combined and extended
14
+
-**Accessible**: Built with accessibility in mind
15
+
-**Customizable**: Flexible styling options through CSS
16
+
17
+
## Getting Started
18
+
19
+
```bash
20
+
# Install with npm
21
+
npm install @rune-ui/archetype
22
+
23
+
# Or with yarn
24
+
yarn add @rune-ui/archetype
25
+
26
+
# Or with pnpm
27
+
pnpm add @rune-ui/archetype
28
+
```
29
+
30
+
## Basic Usage
31
+
32
+
```tsx
33
+
import { Toggle } from"@rune-ui/archetype";
34
+
import { View } from"rune-ts";
35
+
import { createHtml } from"@rune-ui/jsx";
36
+
37
+
classMyToggleextendsView {
38
+
override template() {
39
+
return (
40
+
<Toggle.Root>
41
+
<Toggle.Track>
42
+
<Toggle.Thumb />
43
+
</Toggle.Track>
44
+
<Toggle.Label>Enable notifications</Toggle.Label>
45
+
</Toggle.Root>
46
+
);
47
+
}
48
+
}
49
+
```
50
+
51
+
## Packages
52
+
Rune UI is built on several core packages:
53
+
54
+
*@rune-ui/archetype: Core UI components
55
+
*@rune-ui/machine: State machine implementation
56
+
*@rune-ui/jsx: JSX renderer for component templates
0 commit comments