@octans/ui 1.0.0

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

@@ -0,0 +1,21 @@
+import { OtpInputProps } from './types';
+declare function focus(): void;
+declare const __VLS_export: import('vue').DefineComponent<OtpInputProps, {
+    focus: typeof focus;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {} & {
+    complete: (value: string) => any;
+    blur: (event: FocusEvent, index: number) => any;
+    focus: (event: FocusEvent, index: number) => any;
+    "update:modelValue": (value: string) => any;
+}, string, import('vue').PublicProps, Readonly<OtpInputProps> & Readonly<{
+    onComplete?: ((value: string) => any) | undefined;
+    onBlur?: ((event: FocusEvent, index: number) => any) | undefined;
+    onFocus?: ((event: FocusEvent, index: number) => any) | undefined;
+    "onUpdate:modelValue"?: ((value: string) => any) | undefined;
+}>, {
+    length: number;
+    modelValue: string | null;
+    separator: string;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

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

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

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

@@ -0,0 +1,87 @@
+export interface OtpInputProps {
+    /**
+     * Label to display above the input.
+     */
+    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 value — the characters across all cells joined into a string.
+     */
+    modelValue?: string | null;
+    /**
+     * Number of input cells to render. Ignored when `groups` is set.
+     */
+    length?: number;
+    /**
+     * Render the cells in visual groups separated by `separator`, e.g.
+     * `[4, 4]` produces `####-####`. The cells still behave as one input — focus,
+     * paste and backspace flow across the separators and the value remains the
+     * concatenated characters (no separators). Overrides `length`.
+     */
+    groups?: number[];
+    /**
+     * Text shown between groups when `groups` is set.
+     */
+    separator?: string;
+    /**
+     * Hide entered characters (PIN style) by rendering them as a password input.
+     */
+    mask?: boolean;
+    /**
+     * Restrict input to digits `0-9`. Also sets a numeric on-screen keyboard on
+     * mobile. Takes precedence over `allowedChars`.
+     */
+    integerOnly?: boolean;
+    /**
+     * Restrict which characters may be entered.
+     *
+     * - A `string` is treated as the explicit set of allowed characters, e.g.
+     *   `"0123456789ABCDEF"`.
+     * - A `RegExp` is tested against each individual character, e.g.
+     *   `/[0-9a-f]/i` for case-insensitive hex.
+     *
+     * Ignored when `integerOnly` is set. When omitted, any character is allowed.
+     */
+    allowedChars?: string | RegExp;
+    /**
+     * Force entered characters to a case. Applied before `allowedChars` /
+     * `integerOnly` validation, so e.g. `casing="upper"` lets a user type `a`
+     * to satisfy an `"ABCDEF"` set.
+     *
+     * - `"upper"` — uppercase everything
+     * - `"lower"` — lowercase everything
+     */
+    casing?: 'upper' | 'lower';
+    /**
+     * Disable all cells.
+     */
+    disabled?: boolean;
+    /**
+     * Make all cells read-only.
+     */
+    readonly?: boolean;
+    /**
+     * Focus the first cell when the component mounts.
+     */
+    autoFocus?: boolean;
+    /**
+     * Center the cells within the available width instead of left-aligning
+     * them.
+     */
+    centered?: boolean;
+}

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

@@ -0,0 +1,34 @@
+import { PageProps } from './types';
+declare var __VLS_21: {}, __VLS_60: {}, __VLS_77: {};
+type __VLS_Slots = {} & {
+    badge?: (props: typeof __VLS_21) => any;
+} & {
+    primaryAction?: (props: typeof __VLS_60) => any;
+} & {
+    default?: (props: typeof __VLS_77) => any;
+};
+declare const __VLS_base: import('vue').DefineComponent<PageProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {} & {
+    save: () => any;
+    discard: () => any;
+    clickHelp: () => any;
+}, string, import('vue').PublicProps, Readonly<PageProps> & Readonly<{
+    onSave?: (() => any) | undefined;
+    onDiscard?: (() => any) | undefined;
+    onClickHelp?: (() => any) | undefined;
+}>, {
+    secondaryActions: import('../types').ActionType[];
+    size: "narrow" | "default" | "wide" | "fullWidth";
+    changed: boolean;
+    saving: boolean;
+    loading: boolean;
+    breadcrumbs: import('./types').BreadcrumbType[];
+    actionGroups: import('./types').ActionGroupType[];
+}, {}, {}, {}, 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/Page/index.d.ts

@@ -0,0 +1,2 @@
+export { default as Page } from './Page.vue';
+export * from './types';

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

@@ -0,0 +1,75 @@
+import { ActionType, BadgeType } from '../types';
+export interface BreadcrumbType {
+    label: string;
+    disabled?: boolean;
+    url?: string;
+    onAction?(): void;
+}
+export interface ActionGroupType {
+    title: string;
+    icon?: string;
+    actions: ActionType[];
+}
+export interface PageProps {
+    /**
+     * The main heading of the page.
+     */
+    title?: string;
+    /**
+     * The secondary heading of the page.
+     */
+    subtitle?: string;
+    /**
+     * Optional show help icon next to page title
+     * Emits 'clickHelp' event
+     */
+    includeHelp?: boolean;
+    /**
+     * Optional badge to display at the end of the title. See `Badge` component.
+     */
+    badge?: BadgeType;
+    /**
+     * An array of breadcrumbs.
+     */
+    breadcrumbs?: BreadcrumbType[];
+    /**
+     * The main page action.
+     */
+    primaryAction?: ActionType;
+    /**
+     * Optional secondary actions. These actions and the action groups are
+     * displayed below the page header and collapse into a dropdown on small
+     * screens.
+     */
+    secondaryActions?: ActionType[];
+    /**
+     * A group of secondary actions. These are listed after the main secondary
+     * actions. These appear as sections when the secondary actions are collapsed.
+     */
+    actionGroups?: ActionGroupType[];
+    /**
+     * The width preset of the page. Content is centred at the preset's
+     * max-width; the widths themselves are the `--octans-page-width[-narrow|
+     * -wide]` tokens, so an application can retune every page at once.
+     *
+     * Options:
+     *
+     *   - `narrow` — 720px. Settings pages, forms, focused reading.
+     *   - `default` — 1100px.
+     *   - `wide` — 1400px. Dense tables and dashboards.
+     *   - `fullWidth` — no max-width at all.
+     */
+    size?: 'narrow' | 'default' | 'wide' | 'fullWidth';
+    /**
+     * Shows a page-level loader.
+     */
+    loading?: boolean;
+    /**
+     * Sets the Global Nav's Save Bar state to "changed".
+     */
+    changed?: boolean;
+    /**
+     * Sets the Global Nav's Save Bar state to "saving".
+     */
+    saving?: boolean;
+}

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

@@ -0,0 +1,6 @@
+import { PageActionsProps } from './types';
+declare const __VLS_export: import('vue').DefineComponent<PageActionsProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<PageActionsProps> & Readonly<{}>, {
+    secondaryActions: import('../types').ActionType[];
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

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

@@ -0,0 +1,2 @@
+export { default as PageActions } from './PageActions.vue';
+export * from './types';

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

@@ -0,0 +1,17 @@
+import { ActionType } from '../types';
+export interface PageActionsProps {
+    /**
+     * The main page action options.
+     *
+     * Optional, though it is the reason to reach for this component — omit it and
+     * only the secondary actions render, which is what you want while the primary
+     * action is still being resolved.
+     */
+    primaryAction?: ActionType;
+    /**
+     * Optional secondary actions. These actions and the action groups are
+     * displayed below the page header and collapse into a dropdown on small
+     * screens.
+     */
+    secondaryActions?: ActionType[];
+}

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

@@ -0,0 +1,22 @@
+type PaginationProps = {
+    offset: number;
+    limit: number;
+    total: number;
+    maxPages?: number;
+    pageSizes?: number[] | false;
+};
+declare const __VLS_export: import('vue').DefineComponent<PaginationProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    change: (...args: any[]) => void;
+    "update-limit": (...args: any[]) => void;
+}, string, import('vue').PublicProps, Readonly<PaginationProps> & Readonly<{
+    onChange?: ((...args: any[]) => any) | undefined;
+    "onUpdate-limit"?: ((...args: any[]) => any) | undefined;
+}>, {
+    offset: number;
+    limit: number;
+    total: number;
+    maxPages: number;
+    pageSizes: number[] | false;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

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

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

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

@@ -0,0 +1,45 @@
+import { PopperProps } from './types';
+declare function show(): void;
+declare function hide(): void;
+declare function toggle(): void;
+declare var __VLS_19: {
+    visible: boolean;
+    show: typeof show;
+    hide: typeof hide;
+    toggle: typeof toggle;
+}, __VLS_40: {
+    visible: boolean;
+    show: typeof show;
+    hide: typeof hide;
+    toggle: typeof toggle;
+};
+type __VLS_Slots = {} & {
+    trigger?: (props: typeof __VLS_19) => any;
+} & {
+    default?: (props: typeof __VLS_40) => any;
+};
+declare const __VLS_base: import('vue').DefineComponent<PopperProps, {
+    show: typeof show;
+    hide: typeof hide;
+    toggle: typeof toggle;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {} & {
+    "update:visible": (val: boolean) => any;
+}, string, import('vue').PublicProps, Readonly<PopperProps> & Readonly<{
+    "onUpdate:visible"?: ((val: boolean) => any) | undefined;
+}>, {
+    placement: import('./types').PopperPlacementType;
+    teleportTo: string;
+    disabled: boolean;
+    autoTriggerToggle: boolean;
+    autoHide: boolean;
+    hover: boolean;
+    zIndex: number;
+}, {}, {}, {}, 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/Popper/index.d.ts

@@ -0,0 +1,2 @@
+export { default as Popper } from './Popper.vue';
+export * from './types';

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

@@ -0,0 +1,29 @@
+export type PopperPlacementType = 'top' | 'top-start' | 'top-end' | 'right' | 'right-start' | 'right-end' | 'bottom' | 'bottom-start' | 'bottom-end' | 'left' | 'left-start' | 'left-end';
+export interface PopperProps {
+    visible?: boolean;
+    placement?: PopperPlacementType;
+    teleportTo?: string;
+    disabled?: boolean;
+    /**
+     * Toggles the popper content automatically on trigger click. Defaults to
+     * `true`.
+     *
+     * Set this to `false` whenever the trigger drives visibility itself — via
+     * the `show`/`hide`/`toggle` slot props, or by opening on an event that
+     * precedes the click (`focus`, `mouseenter`). Otherwise the automatic
+     * toggle runs *in addition* to your handler and cancels it out, leaving a
+     * trigger that looks dead.
+     */
+    autoTriggerToggle?: boolean;
+    /**
+     * Close the popper content automatically on outside click
+     */
+    autoHide?: boolean;
+    /**
+     * Open the popper content on hover (pointer enter) and close it shortly
+     * after the pointer leaves both the trigger and the content. Designed for
+     * cascading sub-menus, so hovering a descendant keeps its ancestors open.
+     */
+    hover?: boolean;
+    zIndex?: number;
+}

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

@@ -0,0 +1,24 @@
+export interface PreventAutoCompleteProps {
+    /**
+     * When disabled, the component renders the default slot content directly
+     * without wrapping it in the form element.
+     */
+    enabled?: boolean;
+}
+declare var __VLS_1: {}, __VLS_3: {};
+type __VLS_Slots = {} & {
+    default?: (props: typeof __VLS_1) => any;
+} & {
+    default?: (props: typeof __VLS_3) => any;
+};
+declare const __VLS_base: import('vue').DefineComponent<PreventAutoCompleteProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<PreventAutoCompleteProps> & Readonly<{}>, {
+    enabled: 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/PreventAutoComplete/index.d.ts

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

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

@@ -0,0 +1,48 @@
+import { BadgeStatusType } from '../types';
+export type ProgressBarSizeType = 'small' | 'medium' | 'large';
+export type ProgressBarStatusType = Exclude<BadgeStatusType, 'new'>;
+export interface ProgressBarProps {
+    /**
+     * The progress value as a percentage, from `0` to `100`. Values outside
+     * this range are clamped. Ignored when `indeterminate` is set.
+     */
+    value?: number;
+    /**
+     * The height of the bar.
+     *
+     *   - small
+     *   - medium (default)
+     *   - large
+     */
+    size?: ProgressBarSizeType;
+    /**
+     * The status of the bar, matching the statuses used by `Badge`, `Banner`,
+     * etc. When omitted the bar uses the default (blue) fill.
+     *
+     *   - `info`
+     *   - `success`
+     *   - `warning` — amber
+     *   - `error` — red
+     *
+     * `attention` is accepted as an alias of `warning` for compatibility.
+     */
+    status?: ProgressBarStatusType;
+    /**
+     * Overlays an animated diagonal stripe pattern on the filled portion of the
+     * bar. Useful to communicate that work is actively happening.
+     */
+    animated?: boolean;
+    /**
+     * Shows a looping indeterminate animation instead of a fixed value. Use when
+     * the completion amount is unknown. `value` is ignored while set.
+     */
+    indeterminate?: boolean;
+}
+declare const __VLS_export: import('vue').DefineComponent<ProgressBarProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<ProgressBarProps> & Readonly<{}>, {
+    size: ProgressBarSizeType;
+    value: number;
+    indeterminate: boolean;
+    animated: boolean;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

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

@@ -0,0 +1,2 @@
+export { default as ProgressBar } from './ProgressBar.vue';
+export type { ProgressBarProps, ProgressBarSizeType, ProgressBarStatusType } from './ProgressBar.vue';

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

@@ -0,0 +1,143 @@
+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 radio button.
+     */
+    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 a help icon next to the label which links to an external page.
+     */
+    helpLink: {
+        type: PropType<string | false | null>;
+    };
+    /**
+     * Radio buttons with the same name will form a group.
+     */
+    name: {
+        type: StringConstructor;
+    };
+    /**
+     * The bound value / v-model.
+     */
+    modelValue: {
+        type: null;
+    };
+    /**
+     * The model value to use when checked.
+     */
+    trueValue: {
+        type: null;
+    };
+    /**
+     * When `true` the radio button will be checked. This is an alternative
+     * to assigning `modelValue` to be `trueValue`.
+     */
+    checked: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Disables the control visually and prevents all interaction.
+     */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Prevents changing the control state.
+     */
+    readonly: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>, () => import('vue').VNode<import('vue').RendererNode, import('vue').RendererElement, {
+    [key: string]: any;
+}>, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, ("change" | "update:modelValue")[], "change" | "update:modelValue", import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    /**
+     * Label for the radio button.
+     */
+    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 a help icon next to the label which links to an external page.
+     */
+    helpLink: {
+        type: PropType<string | false | null>;
+    };
+    /**
+     * Radio buttons with the same name will form a group.
+     */
+    name: {
+        type: StringConstructor;
+    };
+    /**
+     * The bound value / v-model.
+     */
+    modelValue: {
+        type: null;
+    };
+    /**
+     * The model value to use when checked.
+     */
+    trueValue: {
+        type: null;
+    };
+    /**
+     * When `true` the radio button will be checked. This is an alternative
+     * to assigning `modelValue` to be `trueValue`.
+     */
+    checked: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Disables the control visually and prevents all interaction.
+     */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Prevents changing the control state.
+     */
+    readonly: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>> & Readonly<{
+    onChange?: ((...args: any[]) => any) | undefined;
+    "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
+}>, {
+    disabled: boolean;
+    readonly: boolean;
+    checked: boolean;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;

package/dist/components/RadioButton/RadioButtonControl.vue.d.ts

@@ -0,0 +1,50 @@
+declare const _default: typeof __VLS_export;
+export default _default;
+declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+    name: {
+        type: StringConstructor;
+    };
+    checked: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    readonly: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    error: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>, () => 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<{
+    name: {
+        type: StringConstructor;
+    };
+    checked: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    readonly: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    error: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>> & Readonly<{}>, {
+    disabled: boolean;
+    error: boolean;
+    readonly: boolean;
+    checked: boolean;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;

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

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