@flux-ui/types 3.0.0-next.48 → 3.0.0-next.51
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +37 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,3 +1,39 @@
|
|
|
1
1
|
# `@flux-ui/types`
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Public TypeScript types shared across the Flux UI packages.
|
|
4
|
+
|
|
5
|
+
This package has **no build step** — it ships its TypeScript sources directly.
|
|
6
|
+
|
|
7
|
+
## Highlights
|
|
8
|
+
|
|
9
|
+
| File | Contents |
|
|
10
|
+
|-----------------|-------------------------------------------------------------------------|
|
|
11
|
+
| `common.ts` | Cross-cutting types — `FluxColor`, `FluxSize`, `FluxIconName`, `FluxTo` |
|
|
12
|
+
| `components.ts` | Per-component `Props`, `Emits`, and `Slots` types |
|
|
13
|
+
| `form.ts` | Form-related types |
|
|
14
|
+
| `filter.ts` | Filter component types |
|
|
15
|
+
| `notify.ts` | Snackbar, alert, confirm, and prompt types |
|
|
16
|
+
| `statistics.ts` | Types for `@flux-ui/statistics` |
|
|
17
|
+
|
|
18
|
+
> Component-owned types live next to their component as inline `defineProps` / `defineEmits` / `defineSlots`.
|
|
19
|
+
> Only types with cross-package or cross-component reuse belong here.
|
|
20
|
+
|
|
21
|
+
## ⭐️ Prerequisites
|
|
22
|
+
|
|
23
|
+
- Bun >= 1.2.13
|
|
24
|
+
- Node >= 23
|
|
25
|
+
|
|
26
|
+
## 🚀 Getting started
|
|
27
|
+
|
|
28
|
+
1. Make sure the Flux monorepo is checked out.
|
|
29
|
+
2. Run `bun install` in the project root.
|
|
30
|
+
|
|
31
|
+
There is no build step; consumers import directly from `./src/index.ts`.
|
|
32
|
+
|
|
33
|
+
## 📦 Sibling packages
|
|
34
|
+
|
|
35
|
+
- [`@flux-ui/components`](../components)
|
|
36
|
+
- [`@flux-ui/internals`](../internals)
|
|
37
|
+
- [`@flux-ui/statistics`](../statistics)
|
|
38
|
+
- [`@flux-ui/dashboard`](../dashboard)
|
|
39
|
+
- [`@flux-ui/application`](../application)
|
package/package.json
CHANGED