fret-ui-kit 0.1.0

Component authoring toolkit for Fret with declarative policies and reusable building blocks.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

# `fret-ui-kit`

Component authoring toolkit for Fret with declarative policies and reusable building blocks.

This is the ecosystem layer that sits above `crates/fret-ui` (mechanisms/contracts). It provides:

- token-driven layout/style surfaces (`UiBuilder`, `LayoutRefinement`, `ChromeRefinement`)
- reusable policy/toolbox primitives (overlays, tooltips, tables, scrolling)
- declarative authoring helpers (`use fret_ui_kit::prelude::*;`)

Use `fret-ui-kit`'s broad prelude when you depend on this crate directly as a substrate/policy
layer. If you are intentionally consuming the higher-level `fret` facade for reusable component
code, prefer `use fret::component::prelude::*;` so app-facing builder/runtime names stay off the
default teaching surface.

## Status

Experimental learning project (not production-ready).

## Features

Default features are minimal. Opt in as needed:

- `icons`: integrate with the shared icon registry (`fret-icons`)
- `dnd`: headless drag-and-drop toolbox integration (`fret-dnd`)
- `imui`: integration helpers for immediate-mode authoring frontends
- `recipes`: opinionated helpers closer to recipes than substrate

## Icons

- Enabling the `icons` feature exposes semantic `IconId` integration and icon authoring helpers
  against the shared registry contract; it does not install a default icon pack.
- App/bootstrap code should compose an explicit provider (`fret_icons_lucide::app::install`,
  `fret_icons_radix::app::install`, or a higher-level dependency bundle surface) when semantic
  `ui.*` ids need to resolve.
- Reusable crates built on `fret-ui-kit` should keep component APIs on semantic `IconId` / `ui.*`
  ids and leave icon-pack selection to app/bootstrap code or one named installer/bundle surface.

Example:

```rust
use fret_icons::ids;
use fret_ui_kit::prelude::*;

fret_icons_lucide::app::install(app);

let _icon = icon(ids::ui::SEARCH);
```

## References / Thanks

This project is inspired by many open-source projects. Thanks to the authors and contributors of:

- shadcn/ui: https://github.com/shadcn-ui/ui
- Radix UI Primitives: https://github.com/radix-ui/primitives
- MUI Base UI: https://github.com/mui/base-ui
- Floating UI: https://github.com/floating-ui/floating-ui
- Animata: https://github.com/codse/animata
- Motion (motion.dev): https://github.com/motiondivision/motion
- Flutter: https://github.com/flutter/flutter
- Dear ImGui: https://github.com/ocornut/imgui
- dear-imgui-rs: https://github.com/Latias94/dear-imgui-rs