@octans/ui 1.0.0

package/dist/components/RangeSlider/RangeSlider.vue.d.ts

@@ -0,0 +1,303 @@
+import { PropType } from 'vue';
+declare const _default: typeof __VLS_export;
+export default _default;
+declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+    /**
+     * Label for the control.
+     */
+    label: {
+        type: PropType<string | false | null>;
+    };
+    /**
+     * Error text to show below the control.
+     */
+    error: {
+        type: PropType<string | false | null>;
+    };
+    /**
+     * Help text to show below the control.
+     */
+    helpText: {
+        type: PropType<string | false | null>;
+    };
+    /**
+     * Renders help text as raw HTML. Use with caution.
+     */
+    helpTextHtml: {
+        type: PropType<string | false | null>;
+    };
+    /**
+     * Renders a help icon next to the label which links to an external page.
+     */
+    helpLink: {
+        type: PropType<string | false | null>;
+    };
+    /**
+     * Disables the control and prevents all interaction.
+     */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Prevents the control value from being edited.
+     */
+    readonly: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * The value of the control.
+     */
+    modelValue: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /**
+     * The minimum value allowed.
+     */
+    min: {
+        type: NumberConstructor;
+    };
+    /**
+     * The maximum value allowed.
+     */
+    max: {
+        type: NumberConstructor;
+    };
+    /**
+     * Passes this value to the step attribute of the input element.
+     *
+     * If it's a float number the tooltip will show decimal values.
+     */
+    step: {
+        type: NumberConstructor;
+    };
+    /**
+     * Shows a text input field next to the slider for direct value entry.
+     */
+    showInput: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>, {}, {
+    localValue: number;
+}, {
+    cssVars(): {
+        '--factor': string;
+        '--progress': string;
+    };
+}, {
+    changeValue(value: any): void;
+    onInput(event: any): void;
+    onChange(event: any): void;
+    onTextInput(value: any, event: Event): void;
+}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    /**
+     * Label for the control.
+     */
+    label: {
+        type: PropType<string | false | null>;
+    };
+    /**
+     * Error text to show below the control.
+     */
+    error: {
+        type: PropType<string | false | null>;
+    };
+    /**
+     * Help text to show below the control.
+     */
+    helpText: {
+        type: PropType<string | false | null>;
+    };
+    /**
+     * Renders help text as raw HTML. Use with caution.
+     */
+    helpTextHtml: {
+        type: PropType<string | false | null>;
+    };
+    /**
+     * Renders a help icon next to the label which links to an external page.
+     */
+    helpLink: {
+        type: PropType<string | false | null>;
+    };
+    /**
+     * Disables the control and prevents all interaction.
+     */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Prevents the control value from being edited.
+     */
+    readonly: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * The value of the control.
+     */
+    modelValue: {
+        type: NumberConstructor;
+        default: number;
+    };
+    /**
+     * The minimum value allowed.
+     */
+    min: {
+        type: NumberConstructor;
+    };
+    /**
+     * The maximum value allowed.
+     */
+    max: {
+        type: NumberConstructor;
+    };
+    /**
+     * Passes this value to the step attribute of the input element.
+     *
+     * If it's a float number the tooltip will show decimal values.
+     */
+    step: {
+        type: NumberConstructor;
+    };
+    /**
+     * Shows a text input field next to the slider for direct value entry.
+     */
+    showInput: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>> & Readonly<{}>, {
+    disabled: boolean;
+    modelValue: number;
+    readonly: boolean;
+    showInput: boolean;
+}, {}, {
+    Labelled: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+        label: {
+            type: PropType<string | false | null>;
+            required: false;
+        };
+        error: {
+            type: PropType<string | false | null>;
+            required: false;
+        };
+        helpText: {
+            type: PropType<string | false | null>;
+            required: false;
+        };
+        helpTextHtml: {
+            type: PropType<string | false | null>;
+            required: false;
+        };
+        helpLink: {
+            type: PropType<string | false | null>;
+            required: false;
+        };
+        required: {
+            type: BooleanConstructor;
+            required: false;
+        };
+    }>, () => import('vue').VNode<import('vue').RendererNode, import('vue').RendererElement, {
+        [key: string]: any;
+    }>, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+        label: {
+            type: PropType<string | false | null>;
+            required: false;
+        };
+        error: {
+            type: PropType<string | false | null>;
+            required: false;
+        };
+        helpText: {
+            type: PropType<string | false | null>;
+            required: false;
+        };
+        helpTextHtml: {
+            type: PropType<string | false | null>;
+            required: false;
+        };
+        helpLink: {
+            type: PropType<string | false | null>;
+            required: false;
+        };
+        required: {
+            type: BooleanConstructor;
+            required: false;
+        };
+    }>> & Readonly<{}>, {
+        required: boolean;
+    }, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+    TextField: {
+        new (...args: any[]): import('vue').CreateComponentPublicInstanceWithMixins<Readonly<import('../TextField').TextFieldProps> & Readonly<{
+            onClick?: ((event: MouseEvent) => any) | undefined;
+            onBlur?: ((event: FocusEvent) => any) | undefined;
+            onFocus?: ((event: FocusEvent) => any) | undefined;
+            onKeydown?: ((event: KeyboardEvent) => any) | undefined;
+            "onUpdate:modelValue"?: ((value: string | number | null, event?: Event | undefined) => any) | undefined;
+        }>, {
+            focus: () => void;
+        }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {} & {
+            click: (event: MouseEvent) => any;
+            blur: (event: FocusEvent) => any;
+            focus: (event: FocusEvent) => any;
+            keydown: (event: KeyboardEvent) => any;
+            "update:modelValue": (value: string | number | null, event?: Event | undefined) => any;
+        }, import('vue').PublicProps, {
+            type: "email" | "number" | "password" | "text" | "tel";
+            emptyValue: string | number | null;
+        }, false, {}, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, {}, any, import('vue').ComponentProvideOptions, {
+            P: {};
+            B: {};
+            D: {};
+            C: {};
+            M: {};
+            Defaults: {};
+        }, Readonly<import('../TextField').TextFieldProps> & Readonly<{
+            onClick?: ((event: MouseEvent) => any) | undefined;
+            onBlur?: ((event: FocusEvent) => any) | undefined;
+            onFocus?: ((event: FocusEvent) => any) | undefined;
+            onKeydown?: ((event: KeyboardEvent) => any) | undefined;
+            "onUpdate:modelValue"?: ((value: string | number | null, event?: Event | undefined) => any) | undefined;
+        }>, {
+            focus: () => void;
+        }, {}, {}, {}, {
+            type: "email" | "number" | "password" | "text" | "tel";
+            emptyValue: string | number | null;
+        }>;
+        __isFragment?: never;
+        __isTeleport?: never;
+        __isSuspense?: never;
+    } & import('vue').ComponentOptionsBase<Readonly<import('../TextField').TextFieldProps> & Readonly<{
+        onClick?: ((event: MouseEvent) => any) | undefined;
+        onBlur?: ((event: FocusEvent) => any) | undefined;
+        onFocus?: ((event: FocusEvent) => any) | undefined;
+        onKeydown?: ((event: KeyboardEvent) => any) | undefined;
+        "onUpdate:modelValue"?: ((value: string | number | null, event?: Event | undefined) => any) | undefined;
+    }>, {
+        focus: () => void;
+    }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {} & {
+        click: (event: MouseEvent) => any;
+        blur: (event: FocusEvent) => any;
+        focus: (event: FocusEvent) => any;
+        keydown: (event: KeyboardEvent) => any;
+        "update:modelValue": (value: string | number | null, event?: Event | undefined) => any;
+    }, string, {
+        type: "email" | "number" | "password" | "text" | "tel";
+        emptyValue: string | number | null;
+    }, {}, string, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, import('vue').ComponentProvideOptions> & import('vue').VNodeProps & import('vue').AllowedComponentProps & import('vue').ComponentCustomProps & (new () => {
+        $slots: {
+            left?: (props: {}) => any;
+        } & {
+            prefix?: (props: {}) => any;
+        } & {
+            suffix?: (props: {}) => any;
+        } & {
+            right?: (props: {}) => any;
+        };
+    });
+}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;

package/dist/components/RangeSlider/index.d.ts

@@ -0,0 +1 @@
+export { default as RangeSlider } from './RangeSlider.vue';

package/dist/components/Rating/Rating.vue.d.ts

@@ -0,0 +1,20 @@
+import { RatingProps } from './types';
+declare function focus(): void;
+declare const __VLS_export: import('vue').DefineComponent<RatingProps, {
+    focus: typeof focus;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {} & {
+    change: (value: number) => any;
+    "update:modelValue": (value: number) => any;
+}, string, import('vue').PublicProps, Readonly<RatingProps> & Readonly<{
+    onChange?: ((value: number) => any) | undefined;
+    "onUpdate:modelValue"?: ((value: number) => any) | undefined;
+}>, {
+    size: number;
+    emptyColor: string;
+    stars: number;
+    emptyIcon: string;
+    fullIcon: string;
+    fullColor: string;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/components/Rating/index.d.ts

@@ -0,0 +1,2 @@
+export { default as Rating } from './Rating.vue';
+export { type RatingProps } from './types';

package/dist/components/Rating/types.d.ts

@@ -0,0 +1,78 @@
+export interface RatingProps {
+    /**
+     * Label to display above the control.
+     */
+    label?: string | false;
+    /**
+     * Error text to show below the control.
+     */
+    error?: string | false | null;
+    /**
+     * Help text to show below the control.
+     */
+    helpText?: string | false;
+    /**
+     * Renders help text as raw HTML. Use with caution.
+     */
+    helpTextHtml?: string | false;
+    /**
+     * Renders a help icon next to the label which links to an external page.
+     */
+    helpLink?: string | false;
+    /**
+     * The current rating value. `null` or `0` means unrated.
+     */
+    modelValue?: number | null;
+    /**
+     * Number of icons to render.
+     */
+    stars?: number;
+    /**
+     * Allow half-step selection, e.g. `2.5`. Fractional values are always
+     * displayed regardless of this setting (useful for read-only averages);
+     * this only controls click/hover/keyboard granularity.
+     */
+    allowHalf?: boolean;
+    /**
+     * Display only — disables interaction but keeps full opacity.
+     */
+    readonly?: boolean;
+    /**
+     * Disable the control (dimmed, non-interactive).
+     */
+    disabled?: boolean;
+    /**
+     * Clicking the icon matching the current value resets it to `0`.
+     */
+    clearable?: boolean;
+    /**
+     * Icon name for the empty (unfilled) icon.
+     */
+    emptyIcon?: string;
+    /**
+     * Icon name for the full (filled) icon.
+     */
+    fullIcon?: string;
+    /**
+     * Colour of empty icons.
+     */
+    emptyColor?: string;
+    /**
+     * Colour of filled icons.
+     */
+    fullColor?: string;
+    /**
+     * Colour of filled icons while hovering. Defaults to `fullColor`.
+     */
+    hoverColor?: string;
+    /**
+     * Icon size in pixels.
+     */
+    size?: number;
+    /**
+     * Show a tooltip with the rating value on hover. When interactive it shows
+     * the value under the pointer (what clicking would select); when `disabled`
+     * or `readonly` it shows the current value.
+     */
+    tooltip?: boolean;
+}

package/dist/components/ResourceList/ResourceItem.vue.d.ts

@@ -0,0 +1,17 @@
+declare var __VLS_1: {};
+type __VLS_Slots = {} & {
+    default?: (props: typeof __VLS_1) => any;
+};
+declare const __VLS_base: import('vue').DefineComponent<{}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {} & {
+    click: () => any;
+}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{
+    onClick?: (() => any) | undefined;
+}>, {}, {}, {}, {}, string, import('vue').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_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/components/ResourceList/ResourceList.vue.d.ts

@@ -0,0 +1,19 @@
+import { ResourceListProps, ResourceListColumnType } from './types';
+declare var __VLS_1: {
+    item: Record<string, any>;
+};
+type __VLS_Slots = {} & {
+    item?: (props: typeof __VLS_1) => any;
+};
+declare const __VLS_base: import('vue').DefineComponent<ResourceListProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<ResourceListProps> & Readonly<{}>, {
+    items: Record<string, any>[];
+    columns: ResourceListColumnType[];
+}, {}, {}, {}, string, import('vue').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_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/components/ResourceList/index.d.ts

@@ -0,0 +1,3 @@
+export { default as ResourceList } from './ResourceList.vue';
+export { default as ResourceItem } from './ResourceItem.vue';
+export type { ResourceListProps, ResourceListColumnType } from './types';

package/dist/components/ResourceList/types.d.ts

@@ -0,0 +1,19 @@
+export interface ResourceListColumnType {
+    key: string;
+    label: string;
+    /**
+     * Name of a formatter from `format()` — `currency`, `integer`, `percent`,
+     * `dateShort` and so on. Numeric formats also right-align the column.
+     */
+    format?: string;
+}
+export interface ResourceListProps {
+    /**
+     * Column definitions for the list.
+     */
+    columns?: ResourceListColumnType[];
+    /**
+     * Array of item objects to display. Each item should have an `id` property.
+     */
+    items?: Record<string, any>[];
+}

package/dist/components/SaveBar/SaveBar.vue.d.ts

@@ -0,0 +1,15 @@
+import { SaveBarProps } from './types';
+declare const __VLS_export: import('vue').DefineComponent<SaveBarProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {} & {
+    save: () => any;
+    discard: () => any;
+}, string, import('vue').PublicProps, Readonly<SaveBarProps> & Readonly<{
+    onSave?: (() => any) | undefined;
+    onDiscard?: (() => any) | undefined;
+}>, {
+    state: import('./types').SaveBarStateType;
+    layoutMode: "default" | "alternate";
+    translations: import('./types').SaveBarTranslationsType;
+    confirmDiscard: boolean;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

package/dist/components/SaveBar/index.d.ts

@@ -0,0 +1,4 @@
+export { default as SaveBar } from './SaveBar.vue';
+export { saveBar, saveBarState, useSaveBar } from './store';
+export type { UseSaveBarOptionsType } from './store';
+export type { SaveBarProps, SaveBarStateType, SaveBarTranslationsType } from './types';

package/dist/components/SaveBar/store.d.ts

@@ -0,0 +1,56 @@
+import { SaveBarStateType } from './types';
+export declare const saveBarState: Readonly<import('vue').Ref<SaveBarStateType, SaveBarStateType>>;
+/**
+ * The save bar's state and actions, also exposed as `$ui.saveBar`.
+ *
+ * The app owns the state: `setState('changed')` shows the bar, and after a
+ * save lands, `setState('unchanged')` hides it — `save()` only announces the
+ * click. Subscribe with `onSave`/`onDiscard`, or `useSaveBar()` inside a
+ * component, which unsubscribes itself on unmount.
+ */
+export declare const saveBar: {
+    /** The current state. Reactive — a getter into the shared store. */
+    readonly state: SaveBarStateType;
+    setState(value: SaveBarStateType): void;
+    /** Announce a save click to every `onSave` subscriber. The bar's Save
+     * button calls this; call it yourself to trigger the same flow. */
+    save(): void;
+    /** Announce a discard click to every `onDiscard` subscriber. */
+    discard(): void;
+    /** Returns an unsubscribe function. */
+    onSave(handler: () => void): () => void;
+    /** Returns an unsubscribe function. */
+    onDiscard(handler: () => void): () => void;
+};
+export interface UseSaveBarOptionsType {
+    /** Called when the user clicks Save. */
+    onSave?: () => void;
+    /** Called when the user confirms a discard. */
+    onDiscard?: () => void;
+}
+/**
+ * Composable form of `$ui.saveBar`, with the state as a ref so destructuring
+ * keeps it reactive. Handlers passed here are unsubscribed automatically when
+ * the calling component unmounts.
+ *
+ * ```ts
+ * const { setState } = useSaveBar({
+ *   onSave: async () => {
+ *     setState('saving')
+ *     await save()
+ *     setState('unchanged')
+ *   },
+ *   onDiscard: () => reset()
+ * })
+ * watch(dirty, (d) => setState(d ? 'changed' : 'unchanged'))
+ * ```
+ */
+export declare function useSaveBar(options?: UseSaveBarOptionsType): {
+    /** The current state. */
+    state: import('vue').ComputedRef<SaveBarStateType>;
+    setState: (value: SaveBarStateType) => void;
+    save: () => void;
+    discard: () => void;
+    onSave: (handler: () => void) => () => void;
+    onDiscard: (handler: () => void) => () => void;
+};

package/dist/components/SaveBar/types.d.ts

@@ -0,0 +1,42 @@
+/**
+ * Where the save-bar flow stands.
+ *
+ * - `unchanged` — nothing to save; the bar is hidden.
+ * - `changed` — there are unsaved edits; the bar shows Save and Discard.
+ * - `saving` — a save is in flight; the buttons disable and Save spins.
+ */
+export type SaveBarStateType = 'unchanged' | 'changed' | 'saving';
+export interface SaveBarTranslationsType {
+    save?: string;
+    discard?: string;
+    unsavedChanges?: string;
+    discardModal?: {
+        title?: string;
+        content?: string;
+        primaryActionLabel?: string;
+        secondaryActionLabel?: string;
+    };
+}
+export interface SaveBarProps {
+    /**
+     * Show the bar for this state instead of following `$ui.saveBar`. Leave it
+     * unset — the global state is what keeps one bar, one truth, no matter who
+     * set it.
+     */
+    state?: SaveBarStateType;
+    /**
+     * Matches `GlobalNav`'s `layoutMode`, so the bar's content aligns with the
+     * page when the sidebar owns the full height of the window.
+     */
+    layoutMode?: 'default' | 'alternate';
+    /** Overrides for the bar's built-in strings. */
+    translations?: SaveBarTranslationsType;
+    /**
+     * Ask "Discard all unsaved changes?" before announcing a discard. Turn it
+     * off when the edits at stake are trivial enough that the modal is more
+     * friction than the loss — the discard then announces immediately.
+     *
+     * @default true
+     */
+    confirmDiscard?: boolean;
+}

package/dist/components/SaveBarController/SaveBarController.vue.d.ts

@@ -0,0 +1,40 @@
+import { SaveBarStateType } from '../SaveBar';
+/**
+ * Renderless bridge to the global save bar, from before `useSaveBar()`
+ * existed.
+ *
+ * @deprecated Use the `useSaveBar()` composable instead — same events as
+ * callbacks, plus direct access to the state, without a component in the
+ * template.
+ */
+type __VLS_Props = {
+    /**
+     * Mirrors this value into the global state. Left unset, mounting the
+     * controller shows the bar (`changed`) and unmounting hides it — which is
+     * what `v-if="dirty"` usage relies on.
+     */
+    state?: SaveBarStateType;
+};
+declare var __VLS_1: {};
+type __VLS_Slots = {} & {
+    default?: (props: typeof __VLS_1) => any;
+};
+declare const __VLS_base: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {} & {
+    save: () => any;
+    discard: () => any;
+    update: (v: boolean) => any;
+    "update:state": (state: SaveBarStateType) => any;
+}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{
+    onSave?: (() => any) | undefined;
+    onDiscard?: (() => any) | undefined;
+    onUpdate?: ((v: boolean) => any) | undefined;
+    "onUpdate:state"?: ((state: SaveBarStateType) => any) | undefined;
+}>, {}, {}, {}, {}, string, import('vue').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_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/components/SaveBarController/index.d.ts

@@ -0,0 +1 @@
+export { default as SaveBarController } from './SaveBarController.vue';

package/dist/components/ScrollPane/ScrollPane.vue.d.ts

@@ -0,0 +1,24 @@
+import { ScrollPaneProps } from './types';
+declare function updateImmediate(): void;
+declare function scrollTo(x: number, y: number): void;
+declare var __VLS_1: {};
+type __VLS_Slots = {} & {
+    default?: (props: typeof __VLS_1) => any;
+};
+declare const __VLS_base: import('vue').DefineComponent<ScrollPaneProps, {
+    scrollTo: typeof scrollTo;
+    update: typeof updateImmediate;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<ScrollPaneProps> & Readonly<{}>, {
+    disabled: boolean;
+    contain: boolean;
+    direction: import('./types').ScrollPaneDirectionType;
+    indicators: boolean;
+}, {}, {}, {}, string, import('vue').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_WithSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/components/ScrollPane/index.d.ts

@@ -0,0 +1,2 @@
+export { default as ScrollPane } from './ScrollPane.vue';
+export type { ScrollPaneProps, ScrollPaneDirectionType } from './types';