@omnitend/dashboard-for-laravel 0.10.0 → 0.13.1

package/dist/components/charts/DXBarChart.vue.d.ts

@@ -0,0 +1,22 @@
+import { type ChartValueFormat } from "./chartTheme";
+interface Props {
+    /** X-axis category labels. */
+    labels: string[];
+    /** Chart.js datasets. Colours are themed when a dataset omits them. */
+    datasets: any[];
+    /** Chart.js options; deep-merged over the themed defaults. */
+    options?: Record<string, any>;
+    /** Format value-axis ticks and tooltips. */
+    valueFormat?: ChartValueFormat;
+    /** Currency symbol for valueFormat: "currency" (default "£"). */
+    currencySymbol?: string;
+    /** Locale for number formatting. */
+    locale?: string;
+    /** Show the legend (default: only when there is more than one dataset). */
+    showLegend?: boolean;
+}
+declare const _default: import("vue").DefineComponent<Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<Props> & Readonly<{}>, {
+    currencySymbol: string;
+    showLegend: boolean;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/components/charts/DXDoughnutChart.vue.d.ts

@@ -0,0 +1,24 @@
+import { type ChartValueFormat } from "./chartTheme";
+interface Props {
+    /** Slice labels. */
+    labels: string[];
+    /** Convenience: a single number array (one value per label). */
+    data?: number[];
+    /** Full Chart.js datasets (alternative to `data`). */
+    datasets?: any[];
+    /** Chart.js options; deep-merged over the themed defaults. */
+    options?: Record<string, any>;
+    /** Format tooltip values. */
+    valueFormat?: ChartValueFormat;
+    /** Currency symbol for valueFormat: "currency" (default "£"). */
+    currencySymbol?: string;
+    /** Locale for number formatting. */
+    locale?: string;
+    /** Show the legend (default: true — slices need identifying). */
+    showLegend?: boolean;
+}
+declare const _default: import("vue").DefineComponent<Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<Props> & Readonly<{}>, {
+    currencySymbol: string;
+    showLegend: boolean;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/components/charts/DXLineChart.vue.d.ts

@@ -0,0 +1,22 @@
+import { type ChartValueFormat } from "./chartTheme";
+interface Props {
+    /** X-axis category labels. */
+    labels: string[];
+    /** Chart.js datasets. Colours are themed when a dataset omits them. */
+    datasets: any[];
+    /** Chart.js options; deep-merged over the themed defaults. */
+    options?: Record<string, any>;
+    /** Format value-axis ticks and tooltips. */
+    valueFormat?: ChartValueFormat;
+    /** Currency symbol for valueFormat: "currency" (default "£"). */
+    currencySymbol?: string;
+    /** Locale for number formatting. */
+    locale?: string;
+    /** Show the legend (default: only when there is more than one dataset). */
+    showLegend?: boolean;
+}
+declare const _default: import("vue").DefineComponent<Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<Props> & Readonly<{}>, {
+    currencySymbol: string;
+    showLegend: boolean;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/components/charts/chartTheme.d.ts

@@ -0,0 +1,32 @@
+export type ChartValueFormat = "number" | "currency" | "percent";
+/** Deep-merge consumer `options` over the themed defaults (arrays replace). */
+export declare function mergeOptions(base: Record<string, any>, override: Record<string, any>): Record<string, any>;
+/**
+ * Register Chart.js (idempotent). Uses the full `registerables` set so every
+ * controller / scale / element / plugin (incl. Legend, Tooltip, Filler) is
+ * available — chart.js is an external peer dep, so this adds no bundle weight.
+ */
+export declare function registerCharts(): void;
+/** Resolve the themed categorical palette from the document root. */
+export declare function getPalette(): string[];
+/** Add an alpha channel to a hex or rgb() colour (best-effort). */
+export declare function withAlpha(color: string, alpha: number): string;
+/** Format a numeric value per the chart's value format (for tick/tooltips). */
+export declare function formatValue(value: number, format: ChartValueFormat | undefined, currencySymbol: string, locale?: string): string;
+export interface BaseOptionArgs {
+    valueFormat?: ChartValueFormat;
+    currencySymbol?: string;
+    locale?: string;
+    /** Show the legend (default: false for a single dataset, true for many). */
+    showLegend?: boolean;
+    /** Whether the chart has value axes (bar/line) vs none (doughnut). */
+    hasValueAxis?: boolean;
+}
+/** Dashboard default Chart.js options merged under any consumer `options`. */
+export declare function baseOptions(args: BaseOptionArgs): Record<string, any>;
+/**
+ * Apply the themed palette to any dataset that doesn't set its own colours.
+ * Bar: one colour per dataset (or per bar for a single dataset). Line: a themed
+ * stroke + translucent fill. Doughnut/pie: one colour per slice.
+ */
+export declare function applyPalette(datasets: any[], kind: "bar" | "line" | "doughnut", labelsCount: number): any[];

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

@@ -8,6 +8,14 @@ interface Props {
     title?: string;
     /** Page title shown in navbar */
     pageTitle?: string;
+    /**
+     * Render the page content full-width and left-aligned instead of the default
+     * centred, reading-width (`col-xl-10`) column. Use for data-heavy admin pages
+     * (wide tables).
+     */
+    fluid?: boolean;
+    /** Extra class(es) applied to the content container/column. */
+    contentClass?: string;
     /** User object for navbar dropdown */
     user?: {
         name: string;
@@ -35,13 +43,15 @@ interface Props {
      */
     dashboardId?: string;
 }
-declare var __VLS_9: string, __VLS_10: any, __VLS_20: string, __VLS_21: any, __VLS_32: {};
+declare var __VLS_9: string, __VLS_10: any, __VLS_20: string, __VLS_21: any, __VLS_26: {}, __VLS_37: {};
 type __VLS_Slots = {} & {
     [K in NonNullable<typeof __VLS_9>]?: (props: typeof __VLS_10) => any;
 } & {
     [K in NonNullable<typeof __VLS_20>]?: (props: typeof __VLS_21) => any;
 } & {
-    default?: (props: typeof __VLS_32) => any;
+    default?: (props: typeof __VLS_26) => any;
+} & {
+    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<{}>, {
     title: string;

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

@@ -0,0 +1,56 @@
+type StatFormat = "number" | "currency" | "percent";
+type DeltaDirection = "up" | "down" | "neutral";
+interface Props {
+    /** Metric label, e.g. "Revenue". */
+    title: string;
+    /** Optional secondary line under the title, e.g. "This week". */
+    subtitle?: string;
+    /** The metric value. Numbers are formatted per `format`; strings pass through. */
+    value: string | number;
+    /** How to format a numeric `value` (default: plain number with grouping). */
+    format?: StatFormat;
+    /** Currency symbol for `format: "currency"` (default "£"). */
+    currencySymbol?: string;
+    /** Decimal places (default: 2 for currency, 0 otherwise). */
+    precision?: number;
+    /** Locale for number grouping/formatting (default: the runtime's). */
+    locale?: string;
+    /** Change versus a comparison period. Its sign drives the arrow/colour. */
+    delta?: number;
+    /** How to format the delta (default "percent"). */
+    deltaFormat?: StatFormat;
+    /** Force the delta direction instead of deriving it from `delta`'s sign. */
+    deltaDirection?: DeltaDirection;
+    /** Caption beside the delta, e.g. "vs last week". */
+    deltaLabel?: string;
+    /**
+     * Invert the delta colour: by default an up delta is positive (success/green)
+     * and a down delta negative (danger/red). Set for metrics where down is good
+     * (costs, bounce rate, …).
+     */
+    invertDelta?: boolean;
+}
+declare var __VLS_5: {}, __VLS_7: {
+    formatted: string;
+    value: string | number;
+}, __VLS_12: {};
+type __VLS_Slots = {} & {
+    icon?: (props: typeof __VLS_5) => any;
+} & {
+    value?: (props: typeof __VLS_7) => any;
+} & {
+    trend?: (props: typeof __VLS_12) => any;
+};
+declare const __VLS_component: import("vue").DefineComponent<Props, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<Props> & Readonly<{}>, {
+    currencySymbol: string;
+    format: StatFormat;
+    deltaFormat: StatFormat;
+    invertDelta: boolean;
+}, {}, {}, {}, 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;
+    };
+};

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

@@ -90,7 +90,8 @@ export interface Props<TItem = any> {
     currentPage?: number;
     /** Items per page (for provider mode, v-model support) */
     perPage?: number;
-    /** Striped rows */
+    /** Striped (banded) rows. Off by default — banding adds little on short
+     *  tables and can read as noise; opt in with `:striped="true"`. */
     striped?: boolean;
     /** Hover effect on rows */
     hover?: boolean;
@@ -112,8 +113,26 @@ export interface Props<TItem = any> {
     editModalSize?: 'sm' | 'md' | 'lg' | 'xl';
     /** API endpoint pattern for updates (e.g., "/api/products/:id") */
     editUrl?: string;
+    /**
+     * API endpoint pattern to fetch the FULL record for the edit modal
+     * (e.g., "/api/products/:id"). When set, opening a row seeds the form from
+     * this fetch (shown with a loading state) instead of the thin list row —
+     * use when the list payload omits fields the edit form needs (notes, nested
+     * relations, repeater rows, …). The response is unwrapped from `data.data`
+     * (Laravel API Resource) or used as-is.
+     */
+    showUrl?: string;
     /** API endpoint pattern for deletions (e.g., "/api/products/:id") */
     deleteUrl?: string;
+    /**
+     * Guard run when Delete is clicked, before the confirm dialog and request.
+     * Return a message for a non-deletable item to show it immediately (as a
+     * toast) and skip both the confirm and the delete request; return
+     * `null`/`undefined` to proceed with the normal confirm + delete. Lets you
+     * short-circuit a doomed delete (e.g. a record with dependents that the
+     * server would reject) with an immediate, specific reason.
+     */
+    deleteGuard?: (item: TItem) => string | null | undefined;
     /** API endpoint for creating new items (e.g., "/api/products") — enables "New" button */
     createUrl?: string;
     /** Enable client-side filtering, sorting, and pagination on items array */
@@ -142,6 +161,12 @@ declare const _default: <T = any>(__VLS_props: NonNullable<Awaited<typeof __VLS_
     } & 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;
     expose(exposed: import("vue").ShallowUnwrapRef<{
         refresh: () => void;
+        /**
+         * Open the built-in create modal (same as clicking the default "New {item}"
+         * button). Lets the create action live outside the table card — e.g. in a
+         * page header or the dashboard navbar. No-op unless `editFields` are set.
+         */
+        openCreate: () => void;
     }>): void;
     attrs: any;
     slots: {