@omnitend/dashboard-for-laravel 0.22.0 → 0.24.0

package/dist/components/extended/DXDashboard.vue.d.ts

@@ -67,7 +67,18 @@ type __VLS_Slots = {} & {
 } & {
     default?: (props: typeof __VLS_37) => any;
 };
-declare const __VLS_component: import("vue").DefineComponent<Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<Props> & Readonly<{}>, {
+declare const __VLS_component: import("vue").DefineComponent<Props, {
+    /**
+     * Show/hide the sidebar (same as clicking the navbar's hamburger). The
+     * dashboard owns the visibility state, so this is the supported way to drive
+     * it from outside — page content, a custom brand row, a keyboard shortcut.
+     * Also available as a slot binding on every forwarded `sidebar-*`/`navbar-*`
+     * slot, which is usually more convenient.
+     */
+    toggleSidebar: () => void;
+    /** Whether the sidebar is currently hidden. */
+    sidebarHidden: import("vue").ComputedRef<boolean>;
+}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<Props> & Readonly<{}>, {
     title: string;
     collapsibleGroups: boolean;
     autoCollapseInactiveGroups: boolean;

package/dist/components/extended/DXDashboardNavbar.vue.d.ts

@@ -32,7 +32,12 @@ declare var __VLS_11: {}, __VLS_13: {}, __VLS_15: {
     } | null;
 }, __VLS_22: {
     initial: string;
-}, __VLS_24: {
+    user: {
+        [key: string]: any;
+        name: string;
+        email: string;
+    };
+}, __VLS_27: {
     user: {
         [key: string]: any;
         name: string;
@@ -50,7 +55,7 @@ type __VLS_Slots = {} & {
 } & {
     'user-icon'?: (props: typeof __VLS_22) => any;
 } & {
-    'user-menu-items'?: (props: typeof __VLS_24) => any;
+    'user-menu-items'?: (props: typeof __VLS_27) => any;
 };
 declare const __VLS_component: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
     toggleSidebar: () => any;

package/dist/components/extended/DXField.vue.d.ts

@@ -112,10 +112,10 @@ declare var __VLS_1: {
     model: any;
     value: any;
     update: typeof setValue;
-}, __VLS_179: {
+}, __VLS_198: {
     field: FieldDefinition;
     model: any;
-}, __VLS_184: {
+}, __VLS_203: {
     field: FieldDefinition;
     model: any;
 };
@@ -160,9 +160,9 @@ type __VLS_Slots = {} & {
 } & {
     value?: (props: typeof __VLS_133) => any;
 } & {
-    info?: (props: typeof __VLS_179) => any;
+    info?: (props: typeof __VLS_198) => any;
 } & {
-    hint?: (props: typeof __VLS_184) => any;
+    hint?: (props: typeof __VLS_203) => any;
 };
 declare const __VLS_component: import("vue").DefineComponent<Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
 declare const _default: __VLS_WithSlots<typeof __VLS_component, __VLS_Slots>;

package/dist/components/extended/DXTable.vue.d.ts

@@ -6,6 +6,24 @@ export interface FilterOption {
 export interface TableField {
     key: string;
     label?: string;
+    /**
+     * The key this column's filter is sent under, when it differs from the
+     * column's own key (default: `key`). Lets a *display* column filter on a
+     * different server param — e.g. a "Customer" column rendering a name but
+     * filtering on `customer_id` — instead of forcing the column to be named
+     * after the server's filter param and the human-facing value into a
+     * `#cell` slot.
+     */
+    filterKey?: string;
+    /**
+     * For a `select` filter: adds an option meaning "has no value", e.g.
+     * `filterNullText: "Unassigned"` on an assignee column. Selecting it sends
+     * `filterNullValue` (default `"null"`) as the filter value; client-side, it
+     * matches rows whose value is null, undefined or empty.
+     */
+    filterNullText?: string;
+    /** The value sent when the `filterNullText` option is chosen. Default `"null"`. */
+    filterNullValue?: string;
     sortable?: boolean;
     hint?: string;
     filter?: FilterType;
@@ -142,6 +160,40 @@ export interface Props<TItem = any> {
     deleteGuard?: (item: TItem) => string | null | undefined;
     /** API endpoint for creating new items (e.g., "/api/products") — enables "New" button */
     createUrl?: string;
+    /**
+     * Render the built-in "New {item}" button in the card header (default
+     * `true` whenever `createUrl` is set). Set `false` to drive the create
+     * modal from your own trigger elsewhere — e.g. a button in the dashboard
+     * navbar's actions slot calling the exposed `openCreate()`. With no
+     * `title` and no `header` slot, the header is then dropped entirely
+     * rather than left empty.
+     */
+    showCreateButton?: boolean;
+    /**
+     * Render a `<tfoot>` mirroring the header row, so `#foot(<key>)` slots can
+     * hold per-column totals that line up under their data (#99). Without it
+     * there is no footer to put them in. For a fully custom footer, use the
+     * `custom-foot` slot instead.
+     */
+    footClone?: boolean;
+    /**
+     * Show a message row when there are no rows (default `true`). An empty
+     * table body is indistinguishable from a broken one, so the message is on
+     * by default. Override the wording with `emptyText`, or the whole row with
+     * the `empty` slot.
+     */
+    showEmpty?: boolean;
+    /**
+     * Message shown when there are no rows. Defaults to "No {items} found", or
+     * "No {items} match your filters" when a column filter is active.
+     */
+    emptyText?: string;
+    /**
+     * Rows currently expanded, as a `v-model`. Pair with the `row-expansion`
+     * slot to render detail content under a row (#112) instead of forcing every
+     * per-row detail into a modal.
+     */
+    expandedItems?: TItem[];
     /** Enable client-side filtering, sorting, and pagination on items array */
     clientSide?: boolean;
 }
@@ -150,6 +202,7 @@ declare const _default: <T = any>(__VLS_props: NonNullable<Awaited<typeof __VLS_
         readonly "onUpdate:sortBy"?: ((sortBy: BTableSortBy[]) => any) | undefined;
         readonly "onUpdate:busy"?: ((busy: boolean) => any) | undefined;
         readonly onRowClicked?: ((item: T, index: number, event: MouseEvent) => any) | undefined;
+        readonly "onUpdate:expandedItems"?: ((items: T[]) => any) | undefined;
         readonly onPageChange?: ((page: number) => any) | undefined;
         readonly onSortChange?: ((sort: {
             key: string;
@@ -165,7 +218,7 @@ declare const _default: <T = any>(__VLS_props: NonNullable<Awaited<typeof __VLS_
         readonly onDeleteError?: ((item: T, error: any) => any) | undefined;
         readonly "onUpdate:filters"?: ((filters: Record<string, string>) => any) | undefined;
         readonly "onUpdate:perPage"?: ((perPage: number) => any) | undefined;
-    } & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, never>, "onUpdate:sortBy" | "onUpdate:busy" | "onRowClicked" | "onPageChange" | "onSortChange" | "onFilterChange" | "onPerPageChange" | "onRowCreated" | "onCreateError" | "onRowUpdated" | "onEditError" | "onRowDeleted" | "onDeleteError" | "onUpdate:filters" | "onUpdate:perPage"> & Props<T> & Partial<{}>> & import("vue").PublicProps;
+    } & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, never>, "onUpdate:sortBy" | "onUpdate:busy" | "onRowClicked" | "onUpdate:expandedItems" | "onPageChange" | "onSortChange" | "onFilterChange" | "onPerPageChange" | "onRowCreated" | "onCreateError" | "onRowUpdated" | "onEditError" | "onRowDeleted" | "onDeleteError" | "onUpdate:filters" | "onUpdate:perPage"> & Props<T> & Partial<{}>> & import("vue").PublicProps;
     expose(exposed: import("vue").ShallowUnwrapRef<{
         refresh: () => void;
         /**
@@ -214,7 +267,7 @@ declare const _default: <T = any>(__VLS_props: NonNullable<Awaited<typeof __VLS_
     } & {
         header?: (props: {}) => any;
     };
-    emit: ((evt: "update:sortBy", sortBy: BTableSortBy[]) => void) & ((evt: "update:busy", busy: boolean) => void) & ((evt: "rowClicked", item: T, index: number, event: MouseEvent) => void) & ((evt: "pageChange", page: number) => void) & ((evt: "sortChange", sort: {
+    emit: ((evt: "update:sortBy", sortBy: BTableSortBy[]) => void) & ((evt: "update:busy", busy: boolean) => void) & ((evt: "rowClicked", item: T, index: number, event: MouseEvent) => void) & ((evt: "update:expandedItems", items: T[]) => void) & ((evt: "pageChange", page: number) => void) & ((evt: "sortChange", sort: {
         key: string;
         order: "asc" | "desc";
     }) => void) & ((evt: "filterChange", filters: Record<string, string>) => void) & ((evt: "perPageChange", perPage: number) => void) & ((evt: "rowCreated", item: any, response: any) => void) & ((evt: "createError", error: any) => void) & ((evt: "rowUpdated", item: T, response: any) => void) & ((evt: "editError", item: T, error: any) => void) & ((evt: "rowDeleted", item: T, response: any) => void) & ((evt: "deleteError", item: T, error: any) => void) & ((evt: "update:filters", filters: Record<string, string>) => void) & ((evt: "update:perPage", perPage: number) => void);

package/dist/components/extended/DXUserAvatar.vue.d.ts

@@ -0,0 +1,40 @@
+import type { ColorVariant } from "bootstrap-vue-next";
+type __VLS_Props = {
+    /** The user whose initial is shown. The first letter of `name` is used. */
+    user?: {
+        name: string;
+        [key: string]: any;
+    } | null;
+    /** Overrides the initial derived from `user.name` (e.g. two-letter initials). */
+    initial?: string;
+    /** Show a notification dot on the avatar (e.g. unread updates). */
+    badge?: boolean;
+    /** Colour of the notification dot. */
+    badgeVariant?: ColorVariant;
+    /**
+     * Accessible text for the notification dot, announced to screen readers
+     * (the dot itself is a colour-only signal). Ignored unless `badge` is set.
+     */
+    badgeLabel?: string;
+};
+declare var __VLS_1: {};
+type __VLS_Slots = {} & {
+    default?: (props: typeof __VLS_1) => any;
+};
+declare const __VLS_component: import("vue").DefineComponent<__VLS_Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
+    user: {
+        name: string;
+        [key: string]: any;
+    } | null;
+    initial: string;
+    badge: boolean;
+    badgeVariant: ColorVariant;
+    badgeLabel: string;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+declare const _default: __VLS_WithSlots<typeof __VLS_component, __VLS_Slots>;
+export default _default;
+type __VLS_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};