@flux-ui/dashboard 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.
Files changed (2) hide show
  1. package/README.md +25 -5
  2. package/package.json +4 -4
package/README.md CHANGED
@@ -1,6 +1,18 @@
1
1
  # `@flux-ui/dashboard`
2
2
 
3
- Contains Flux UI components for creating dashboards.
3
+ Layout components for building dashboards with [Flux UI](https://flux-ui.dev).
4
+
5
+ ## Highlights
6
+
7
+ Composable shell components:
8
+
9
+ - `FluxDashboard` — root container.
10
+ - `FluxDashboardContent` — main content region.
11
+ - `FluxDashboardSide` — sidebar slot.
12
+ - `FluxDashboardNavigation` — navigation rail.
13
+ - `FluxDashboardTopBar` — top bar.
14
+ - `FluxDashboardHeader` — page-level header.
15
+ - `FluxDashboardMenu` — menu primitive.
4
16
 
5
17
  ## ⭐️ Prerequisites
6
18
 
@@ -9,8 +21,16 @@ Contains Flux UI components for creating dashboards.
9
21
 
10
22
  ## 🚀 Getting started
11
23
 
12
- 1. Make sure that the monorepo of Flux is used.
13
- 2. Run `bun install` in the root of the project.
14
- 3. Run `bun --cwd packages/dashboard build` to build the project.
15
- 4. To link Flux Dashboard globally, using Bun, run `bun link --cwd packages/dashboard`.
24
+ 1. Make sure the Flux monorepo is checked out.
25
+ 2. Run `bun install` in the project root.
26
+ 3. Run `bun run --cwd packages/dashboard build` to build the package (runs `vue-tsc` then `vite build`).
27
+ 4. To link Flux Dashboard globally with Bun, run `bun link --cwd packages/dashboard`.
16
28
  - In another project, use `link:@flux-ui/dashboard` as the dependency version in `package.json`.
29
+
30
+ ## 📦 Sibling packages
31
+
32
+ - [`@flux-ui/components`](../components)
33
+ - [`@flux-ui/types`](../types)
34
+ - [`@flux-ui/internals`](../internals)
35
+ - [`@flux-ui/statistics`](../statistics)
36
+ - [`@flux-ui/application`](../application)
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@flux-ui/dashboard",
3
3
  "description": "Contains components to create dashboards with Flux UI.",
4
- "version": "3.0.0-next.48",
4
+ "version": "3.0.0-next.51",
5
5
  "type": "module",
6
6
  "license": "MIT",
7
7
  "funding": "https://github.com/sponsors/basmilius",
@@ -49,9 +49,9 @@
49
49
  "types": "./dist/index.d.ts",
50
50
  "sideEffects": false,
51
51
  "dependencies": {
52
- "@flux-ui/components": "3.0.0-next.48",
53
- "@flux-ui/internals": "3.0.0-next.48",
54
- "@flux-ui/types": "3.0.0-next.48",
52
+ "@flux-ui/components": "3.0.0-next.51",
53
+ "@flux-ui/internals": "3.0.0-next.51",
54
+ "@flux-ui/types": "3.0.0-next.51",
55
55
  "vue": "^3.6.0-beta.10"
56
56
  },
57
57
  "devDependencies": {