@flux-ui/dashboard 3.0.0-next.7 → 3.0.0-next.70

package/README.md

@@ -1,45 +1,36 @@
-# Flux
+# `@flux-ui/dashboard`
 
-This repository contains the source code for the basic components that are used throughout our front-end projects. It
-targets Vue 3+. Please read the following instructions and checks in order to proceed.
+Layout components for building dashboards with [Flux UI](https://flux-ui.dev).
 
-## 📦 Registry
+## Highlights
 
-- The UI library package is available under `@flux-ui/components`.
-- The Dashboard library package is available under `@flux-ui/dashboard`.
-- The internal package is available under `@flux-ui/internals`.
+Composable shell components:
 
-## ⚠️ Requirements
+- `FluxDashboard` — root container.
+- `FluxDashboardContent` — main content region.
+- `FluxDashboardSide` — sidebar slot.
+- `FluxDashboardNavigation` — navigation rail.
+- `FluxDashboardTopBar` — top bar.
+- `FluxDashboardHeader` — page-level header.
+- `FluxDashboardMenu` — menu primitive.
 
-- Install Node.js ^22
-- Install pnpm using `npm i -g pnpm`.
-- Configure a new environment variable `FONTAWESOME_NPM_AUTH_TOKEN`. This should be a valid Font Awesome private npm auth token.
-- Use `pnpm install` to install the required packages.
-- Use `pnpm dev` to start a build watcher for both targets.
-- Use `pnpm build` to build a production bundle.
-- Use `pnpm link` to link the dist folder of flux to your global node_modules.
+## ⭐️ Prerequisites
 
-## 🪵 Git
+- Bun >= 1.2.13
+- Node >= 23
 
-All commit messages and branches will be in English.
+## 🚀 Getting started
 
-### Branches
+1. Make sure the Flux monorepo is checked out.
+2. Run `bun install` in the project root.
+3. Run `bun run --cwd packages/dashboard build` to build the package (runs `vue-tsc` then `vite build`).
+4. To link Flux Dashboard globally with Bun, run `bun link --cwd packages/dashboard`.
+    - In another project, use `link:@flux-ui/dashboard` as the dependency version in `package.json`.
 
-- **Main** — Contains the latest stable release and is the exact source that is running in production.
-- **Develop** — Contains the latest staging release that is marked for deployment and is the exact source that is running on staging.
-- **Feature branches** — Any feature should have its own feature branch. Once complete, the branch should be merged into the _develop_ branch and the feature branch should be deleted.
-- **Bugfix branches** — When a bug is found, it should be fixed within a bugfix branch. Once complete the branch should be merged into the _develop_ branch and the feature branch should be deleted.
+## 📦 Sibling packages
 
-### Commit messages
-
-Commit messages are bound to the following templates:
-
-- `<type>: <message> `
-- `<type>(<feature>): <message>`
-- `<type>(<feature>): <message> [<issue-number>]`
-
-#### Examples
-
-- `feat(expandable): adds header slot to expandable.`
-- `feat(expandable): adds header slot to expandable. [FLUX-123]`
-- `chore: adds vue 3 build target.`
+- [`@flux-ui/components`](../components)
+- [`@flux-ui/types`](../types)
+- [`@flux-ui/internals`](../internals)
+- [`@flux-ui/statistics`](../statistics)
+- [`@flux-ui/application`](../application)

package/dist/component/FluxDashboard.vue.d.ts

@@ -1,29 +1,17 @@
-import { VNode } from 'vue';
-declare function __VLS_template(): {
-    attrs: Partial<{}>;
-    slots: Readonly<{
-        default(): VNode;
-        header?(): VNode;
-        navigation?(): VNode;
-        menu?(): VNode;
-        side?(): VNode;
-    }> & {
-        default(): VNode;
-        header?(): VNode;
-        navigation?(): VNode;
-        menu?(): VNode;
-        side?(): VNode;
-    };
-    refs: {};
-    rootEl: HTMLDivElement;
+import { VNode, DefineComponent, ComponentOptionsMixin, PublicProps, ComponentProvideOptions } from 'vue';
+type __VLS_Slots = {
+    default(): VNode;
+    header?(): VNode;
+    navigation?(): VNode;
+    menu?(): VNode;
+    side?(): VNode;
 };
-type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
-declare const __VLS_component: import('vue').DefineComponent<{}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, HTMLDivElement>;
-declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
+declare const __VLS_base: DefineComponent<{}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
+declare const _default: typeof __VLS_export;
 export default _default;
-type __VLS_WithTemplateSlots<T, S> = T & {
+type __VLS_WithSlots<T, S> = T & {
     new (): {
         $slots: S;
     };
 };
-//# sourceMappingURL=FluxDashboard.vue.d.ts.map

package/dist/component/FluxDashboardContent.vue.d.ts

@@ -1,18 +1,14 @@
-declare function __VLS_template(): {
-    attrs: Partial<{}>;
-    slots: {
-        default?(_: {}): any;
-    };
-    refs: {};
-    rootEl: HTMLElement;
+import { DefineComponent, ComponentOptionsMixin, PublicProps, ComponentProvideOptions } from 'vue';
+declare var __VLS_1: {};
+type __VLS_Slots = {} & {
+    default?: (props: typeof __VLS_1) => any;
 };
-type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
-declare const __VLS_component: import('vue').DefineComponent<{}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, HTMLElement>;
-declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
+declare const __VLS_base: DefineComponent<{}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
+declare const _default: typeof __VLS_export;
 export default _default;
-type __VLS_WithTemplateSlots<T, S> = T & {
+type __VLS_WithSlots<T, S> = T & {
     new (): {
         $slots: S;
     };
 };
-//# sourceMappingURL=FluxDashboardContent.vue.d.ts.map

package/dist/component/FluxDashboardHeader.vue.d.ts

@@ -1,24 +1,21 @@
 import { FluxIconName } from '@flux-ui/types';
+import { DefineComponent, ComponentOptionsMixin, PublicProps, ComponentProvideOptions } from 'vue';
 type __VLS_Props = {
     readonly icon?: FluxIconName;
     readonly title?: string;
 };
-declare function __VLS_template(): {
-    attrs: Partial<{}>;
-    slots: {
-        start?(_: {}): any;
-        end?(_: {}): any;
-    };
-    refs: {};
-    rootEl: HTMLElement;
+declare var __VLS_8: {}, __VLS_20: {};
+type __VLS_Slots = {} & {
+    start?: (props: typeof __VLS_8) => any;
+} & {
+    end?: (props: typeof __VLS_20) => any;
 };
-type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
-declare const __VLS_component: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLElement>;
-declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
+declare const __VLS_base: DefineComponent<__VLS_Props, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
+declare const _default: typeof __VLS_export;
 export default _default;
-type __VLS_WithTemplateSlots<T, S> = T & {
+type __VLS_WithSlots<T, S> = T & {
     new (): {
         $slots: S;
     };
 };
-//# sourceMappingURL=FluxDashboardHeader.vue.d.ts.map

package/dist/component/FluxDashboardMenu.vue.d.ts

@@ -1,25 +1,23 @@
 import { FluxIconName } from '@flux-ui/types';
+import { DefineComponent, ComponentOptionsMixin, PublicProps, ComponentProvideOptions } from 'vue';
 type __VLS_Props = {
     readonly icon?: FluxIconName;
-    readonly title: string;
+    readonly title?: string;
 };
-declare function __VLS_template(): {
-    attrs: Partial<{}>;
-    slots: {
-        'top-bar-start'?(_: {}): any;
-        'top-bar-end'?(_: {}): any;
-        default?(_: {}): any;
-    };
-    refs: {};
-    rootEl: HTMLElement;
+declare var __VLS_7: {}, __VLS_19: {}, __VLS_21: {};
+type __VLS_Slots = {} & {
+    'top-bar-start'?: (props: typeof __VLS_7) => any;
+} & {
+    'top-bar-end'?: (props: typeof __VLS_19) => any;
+} & {
+    default?: (props: typeof __VLS_21) => any;
 };
-type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
-declare const __VLS_component: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLElement>;
-declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
+declare const __VLS_base: DefineComponent<__VLS_Props, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
+declare const _default: typeof __VLS_export;
 export default _default;
-type __VLS_WithTemplateSlots<T, S> = T & {
+type __VLS_WithSlots<T, S> = T & {
     new (): {
         $slots: S;
     };
 };
-//# sourceMappingURL=FluxDashboardMenu.vue.d.ts.map

package/dist/component/FluxDashboardNavigation.vue.d.ts

@@ -1,26 +1,18 @@
 import { FluxTo } from '@flux-ui/types';
+import { DefineComponent, ComponentOptionsMixin, PublicProps, ComponentProvideOptions } from 'vue';
 type __VLS_Props = {
     logoLocation?: FluxTo;
 };
-declare function __VLS_template(): {
-    attrs: Partial<{}>;
-    slots: Readonly<{
-        default(): any;
-        logo?(): any;
-    }> & {
-        default(): any;
-        logo?(): any;
-    };
-    refs: {};
-    rootEl: any;
+type __VLS_Slots = {
+    default(): any;
+    logo?(): any;
 };
-type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
-declare const __VLS_component: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
-declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
+declare const __VLS_base: DefineComponent<__VLS_Props, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
+declare const _default: typeof __VLS_export;
 export default _default;
-type __VLS_WithTemplateSlots<T, S> = T & {
+type __VLS_WithSlots<T, S> = T & {
     new (): {
         $slots: S;
     };
 };
-//# sourceMappingURL=FluxDashboardNavigation.vue.d.ts.map

package/dist/component/FluxDashboardSide.vue.d.ts

@@ -1,23 +1,21 @@
+import { DefineComponent, ComponentOptionsMixin, PublicProps, ComponentProvideOptions } from 'vue';
 type __VLS_Props = {
     readonly title: string;
 };
-declare function __VLS_template(): {
-    attrs: Partial<{}>;
-    slots: {
-        'top-bar-start'?(_: {}): any;
-        'top-bar-end'?(_: {}): any;
-        default?(_: {}): any;
-    };
-    refs: {};
-    rootEl: HTMLElement;
+declare var __VLS_7: {}, __VLS_14: {}, __VLS_16: {};
+type __VLS_Slots = {} & {
+    'top-bar-start'?: (props: typeof __VLS_7) => any;
+} & {
+    'top-bar-end'?: (props: typeof __VLS_14) => any;
+} & {
+    default?: (props: typeof __VLS_16) => any;
 };
-type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
-declare const __VLS_component: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLElement>;
-declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
+declare const __VLS_base: DefineComponent<__VLS_Props, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>;
+declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
+declare const _default: typeof __VLS_export;
 export default _default;
-type __VLS_WithTemplateSlots<T, S> = T & {
+type __VLS_WithSlots<T, S> = T & {
     new (): {
         $slots: S;
     };
 };
-//# sourceMappingURL=FluxDashboardSide.vue.d.ts.map

package/dist/component/FluxDashboardTopBar.vue.d.ts

@@ -1,18 +1,14 @@
-declare function __VLS_template(): {
-    attrs: Partial<{}>;
-    slots: {
-        default?(_: {}): any;
-    };
-    refs: {};
-    rootEl: HTMLElement;
+import { DefineComponent, ComponentOptionsMixin, PublicProps, ComponentProvideOptions } from 'vue';
+declare var __VLS_1: {};
+type __VLS_Slots = {} & {
+    default?: (props: typeof __VLS_1) => any;
 };
-type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
-declare const __VLS_component: import('vue').DefineComponent<{}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, HTMLElement>;
-declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
+declare const __VLS_base: DefineComponent<{}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
+declare const __VLS_export: __VLS_WithSlots<typeof __VLS_base, __VLS_Slots>;
+declare const _default: typeof __VLS_export;
 export default _default;
-type __VLS_WithTemplateSlots<T, S> = T & {
+type __VLS_WithSlots<T, S> = T & {
     new (): {
         $slots: S;
     };
 };
-//# sourceMappingURL=FluxDashboardTopBar.vue.d.ts.map

package/dist/component/index.d.ts

@@ -4,4 +4,3 @@ export { default as FluxDashboardHeader } from './FluxDashboardHeader.vue';
 export { default as FluxDashboardMenu } from './FluxDashboardMenu.vue';
 export { default as FluxDashboardNavigation } from './FluxDashboardNavigation.vue';
 export { default as FluxDashboardSide } from './FluxDashboardSide.vue';
-//# sourceMappingURL=index.d.ts.map

package/dist/composable/index.d.ts

@@ -1,2 +1 @@
 export { default as useDashboardInjection } from './useDashboardInjection';
-//# sourceMappingURL=index.d.ts.map

package/dist/composable/useDashboardInjection.d.ts

@@ -1,3 +1,2 @@
 import { FluxDashboardInjection } from '../data';
 export default function (): FluxDashboardInjection;
-//# sourceMappingURL=useDashboardInjection.d.ts.map

package/dist/data/index.d.ts

@@ -4,4 +4,3 @@ export type FluxDashboardInjection = {
     readonly isMenuCollapsed: Ref<boolean>;
     readonly isNavigationCollapsed: Ref<boolean>;
 };
-//# sourceMappingURL=index.d.ts.map