@octans/ui 1.0.0

package/dist/components/Card/CardSection.vue.d.ts

@@ -0,0 +1,89 @@
+declare const _default: typeof __VLS_export;
+export default _default;
+declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+    /**
+     * The title heading of the section.
+     */
+    title: {
+        type: StringConstructor;
+    };
+    /**
+     * Renders the section with a subtle background color.
+     */
+    subdued: {
+        type: BooleanConstructor;
+    };
+    /**
+     * An array of action objects:
+     *
+     * ```ts
+     * interface Action {
+     *   label: string
+     *   icon: string
+     *   disabled: boolean
+     *   url: string
+     *   external: boolean
+     *   onAction(): void
+     * }
+     * ```
+     */
+    actions: {
+        type: ArrayConstructor;
+    };
+    collapseActions: {
+        type: BooleanConstructor;
+    };
+    /**
+     * By default padding is included in the section. Use this to disable it.
+     */
+    padded: {
+        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<{
+    /**
+     * The title heading of the section.
+     */
+    title: {
+        type: StringConstructor;
+    };
+    /**
+     * Renders the section with a subtle background color.
+     */
+    subdued: {
+        type: BooleanConstructor;
+    };
+    /**
+     * An array of action objects:
+     *
+     * ```ts
+     * interface Action {
+     *   label: string
+     *   icon: string
+     *   disabled: boolean
+     *   url: string
+     *   external: boolean
+     *   onAction(): void
+     * }
+     * ```
+     */
+    actions: {
+        type: ArrayConstructor;
+    };
+    collapseActions: {
+        type: BooleanConstructor;
+    };
+    /**
+     * By default padding is included in the section. Use this to disable it.
+     */
+    padded: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>> & Readonly<{}>, {
+    subdued: boolean;
+    collapseActions: boolean;
+    padded: boolean;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;

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

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

package/dist/components/Card/utils.d.ts

@@ -0,0 +1,4 @@
+import { VNode } from 'vue';
+export declare function renderHeader(data: any, $styles: Record<string, string>, scopedSlots?: any): VNode<import('vue').RendererNode, import('vue').RendererElement, {
+    [key: string]: any;
+}> | undefined;

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

@@ -0,0 +1,171 @@
+import { PropType } from 'vue';
+declare const _default: typeof __VLS_export;
+export default _default;
+declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+    label: {
+        type: PropType<string | false | null>;
+    };
+    error: {
+        type: PropType<string | false | null>;
+    };
+    helpText: {
+        type: PropType<string | false | null>;
+        required: false;
+    };
+    /**
+     * Renders a help icon next to the label which links to an external page.
+     */
+    helpLink: {
+        type: PropType<string | false | null>;
+        required: false;
+    };
+    name: {
+        type: StringConstructor;
+    };
+    /**
+     * The bound value / v-model.
+     */
+    modelValue: {
+        type: null;
+    };
+    /**
+     * The model value to use when checked.
+     */
+    trueValue: {
+        type: null;
+        default: boolean;
+    };
+    /**
+     * The model value to use when not checked.
+     */
+    falseValue: {
+        type: null;
+        default: boolean;
+    };
+    /**
+     * When `true` the checkbox will be checked. This is an alternative
+     * to assigning `value` to be `trueValue`.
+     */
+    checked: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Renders the checkbox in the indeterminate state.
+     */
+    indeterminate: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    readonly: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Tooltip to show when hovering the button.
+     */
+    tooltip: {
+        type: StringConstructor;
+    };
+    /**
+     * Tooltip position, "top", "bottom", "right" or "left".
+     */
+    tooltipPosition: {
+        type: StringConstructor;
+        default: string;
+    };
+}>, () => 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: {
+        type: PropType<string | false | null>;
+    };
+    error: {
+        type: PropType<string | false | null>;
+    };
+    helpText: {
+        type: PropType<string | false | null>;
+        required: false;
+    };
+    /**
+     * Renders a help icon next to the label which links to an external page.
+     */
+    helpLink: {
+        type: PropType<string | false | null>;
+        required: false;
+    };
+    name: {
+        type: StringConstructor;
+    };
+    /**
+     * The bound value / v-model.
+     */
+    modelValue: {
+        type: null;
+    };
+    /**
+     * The model value to use when checked.
+     */
+    trueValue: {
+        type: null;
+        default: boolean;
+    };
+    /**
+     * The model value to use when not checked.
+     */
+    falseValue: {
+        type: null;
+        default: boolean;
+    };
+    /**
+     * When `true` the checkbox will be checked. This is an alternative
+     * to assigning `value` to be `trueValue`.
+     */
+    checked: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Renders the checkbox in the indeterminate state.
+     */
+    indeterminate: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    readonly: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Tooltip to show when hovering the button.
+     */
+    tooltip: {
+        type: StringConstructor;
+    };
+    /**
+     * Tooltip position, "top", "bottom", "right" or "left".
+     */
+    tooltipPosition: {
+        type: StringConstructor;
+        default: string;
+    };
+}>> & Readonly<{
+    onChange?: ((...args: any[]) => any) | undefined;
+    "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
+}>, {
+    disabled: boolean;
+    tooltipPosition: string;
+    readonly: boolean;
+    checked: boolean;
+    indeterminate: boolean;
+    trueValue: any;
+    falseValue: any;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;

package/dist/components/Checkbox/CheckboxControl.vue.d.ts

@@ -0,0 +1,59 @@
+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;
+    };
+    indeterminate: {
+        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;
+    };
+    indeterminate: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>> & Readonly<{}>, {
+    disabled: boolean;
+    error: boolean;
+    readonly: boolean;
+    checked: boolean;
+    indeterminate: boolean;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;

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

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

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

@@ -0,0 +1,102 @@
+import { PropType } from 'vue';
+declare const _default: typeof __VLS_export;
+export default _default;
+declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+    label: {
+        type: PropType<string | false | null>;
+    };
+    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>;
+    };
+    error: {
+        type: PropType<string | false | null>;
+    };
+    type: {
+        type: StringConstructor;
+        default: string;
+    };
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    readonly: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    value: {
+        type: null;
+        default: undefined;
+    };
+    /**
+     * Tooltip to show when hovering the button.
+     */
+    tooltip: {
+        type: StringConstructor;
+    };
+    /**
+     * Tooltip position, "top", "bottom", "right" or "left".
+     */
+    tooltipPosition: {
+        type: StringConstructor;
+        default: string;
+    };
+}>, () => 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>;
+    };
+    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>;
+    };
+    error: {
+        type: PropType<string | false | null>;
+    };
+    type: {
+        type: StringConstructor;
+        default: string;
+    };
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    readonly: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    value: {
+        type: null;
+        default: undefined;
+    };
+    /**
+     * Tooltip to show when hovering the button.
+     */
+    tooltip: {
+        type: StringConstructor;
+    };
+    /**
+     * Tooltip position, "top", "bottom", "right" or "left".
+     */
+    tooltipPosition: {
+        type: StringConstructor;
+        default: string;
+    };
+}>> & Readonly<{}>, {
+    disabled: boolean;
+    type: string;
+    tooltipPosition: string;
+    value: any;
+    readonly: boolean;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;

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

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

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

@@ -0,0 +1,199 @@
+import { PropType } from 'vue';
+import { ChoiceListAppearanceType, ChoiceListOptionType } from './types';
+declare const _default: typeof __VLS_export;
+export default _default;
+declare const __VLS_export: import('vue').DefineComponent<import('vue').ExtractPropTypes<{
+    label: {
+        type: PropType<string | false | null>;
+    };
+    error: {
+        type: PropType<string | false | null>;
+    };
+    helpText: {
+        type: PropType<string | false | null>;
+    };
+    /**
+     * Renders a help icon next to the label which links to an external page.
+     */
+    helpLink: {
+        type: StringConstructor;
+    };
+    /**
+     * The choices to render. See `ChoiceListOptionType`, which is exported.
+     *
+     * ```ts
+     * interface ChoiceListOptionType {
+     *   label: string
+     *   value: any
+     *   helpText?: string
+     *   helpLink?: string
+     *   disabled?: boolean
+     *   readonly?: boolean
+     *   // shown only while this choice is selected
+     *   revealedContent?: string | VNode
+     * }
+     * ```
+     */
+    options: {
+        type: PropType<ChoiceListOptionType[]>;
+        default: () => never[];
+    };
+    /**
+     * How the choices are drawn.
+     *
+     *   - `list` — one control per line, which is what most questions want.
+     *   - `segmented` — a joined row of segments, for two to five short labels
+     *     where showing them all at once is worth the width.
+     *
+     * `segmented` is the same radio group underneath, so the model and the
+     * events are unchanged. It has no room for `helpLink` or per-choice
+     * `readonly`, and per-choice `helpText` becomes a tooltip. For icons in
+     * the segments, reach for `SegmentedControl` directly.
+     */
+    appearance: {
+        type: PropType<ChoiceListAppearanceType>;
+        default: string;
+    };
+    /**
+     * If `true`, renders using a list of checkboxes and expects `value` to
+     * be an array.
+     *
+     * Ignored by `appearance="segmented"`, which is a radio group and can only
+     * hold one answer — it falls back to the list and warns.
+     */
+    multiple: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * The `name` shared by the radios this renders, so they behave as one
+     * group. Generated when unset; only worth setting to submit the value with
+     * a plain HTML form. Unused by `multiple`, whose checkboxes are unrelated
+     * to each other.
+     */
+    name: {
+        type: StringConstructor;
+    };
+    /**
+     * Disable all the options.
+     */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Makes all options readonly.
+     */
+    readonly: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * An array if using `multiple`, otherwise any value.
+     */
+    modelValue: {
+        type: null;
+    };
+}>, () => import('vue').VNode<import('vue').RendererNode, import('vue').RendererElement, {
+    [key: string]: any;
+}>, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, "update:modelValue"[], "update:modelValue", import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<{
+    label: {
+        type: PropType<string | false | null>;
+    };
+    error: {
+        type: PropType<string | false | null>;
+    };
+    helpText: {
+        type: PropType<string | false | null>;
+    };
+    /**
+     * Renders a help icon next to the label which links to an external page.
+     */
+    helpLink: {
+        type: StringConstructor;
+    };
+    /**
+     * The choices to render. See `ChoiceListOptionType`, which is exported.
+     *
+     * ```ts
+     * interface ChoiceListOptionType {
+     *   label: string
+     *   value: any
+     *   helpText?: string
+     *   helpLink?: string
+     *   disabled?: boolean
+     *   readonly?: boolean
+     *   // shown only while this choice is selected
+     *   revealedContent?: string | VNode
+     * }
+     * ```
+     */
+    options: {
+        type: PropType<ChoiceListOptionType[]>;
+        default: () => never[];
+    };
+    /**
+     * How the choices are drawn.
+     *
+     *   - `list` — one control per line, which is what most questions want.
+     *   - `segmented` — a joined row of segments, for two to five short labels
+     *     where showing them all at once is worth the width.
+     *
+     * `segmented` is the same radio group underneath, so the model and the
+     * events are unchanged. It has no room for `helpLink` or per-choice
+     * `readonly`, and per-choice `helpText` becomes a tooltip. For icons in
+     * the segments, reach for `SegmentedControl` directly.
+     */
+    appearance: {
+        type: PropType<ChoiceListAppearanceType>;
+        default: string;
+    };
+    /**
+     * If `true`, renders using a list of checkboxes and expects `value` to
+     * be an array.
+     *
+     * Ignored by `appearance="segmented"`, which is a radio group and can only
+     * hold one answer — it falls back to the list and warns.
+     */
+    multiple: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * The `name` shared by the radios this renders, so they behave as one
+     * group. Generated when unset; only worth setting to submit the value with
+     * a plain HTML form. Unused by `multiple`, whose checkboxes are unrelated
+     * to each other.
+     */
+    name: {
+        type: StringConstructor;
+    };
+    /**
+     * Disable all the options.
+     */
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * Makes all options readonly.
+     */
+    readonly: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /**
+     * An array if using `multiple`, otherwise any value.
+     */
+    modelValue: {
+        type: null;
+    };
+}>> & Readonly<{
+    "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
+}>, {
+    disabled: boolean;
+    readonly: boolean;
+    multiple: boolean;
+    options: ChoiceListOptionType[];
+    appearance: ChoiceListAppearanceType;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;

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

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

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

@@ -0,0 +1,31 @@
+import { VNode } from 'vue';
+/**
+ * How a `ChoiceList` draws its choices — one per line, or joined into a row of
+ * segments. Both are the same radio group underneath.
+ */
+export type ChoiceListAppearanceType = 'list' | 'segmented';
+/**
+ * One choice in a `ChoiceList`.
+ */
+export interface ChoiceListOptionType {
+    label: string;
+    value: any;
+    /**
+     * Secondary text shown beneath the label, always visible.
+     */
+    helpText?: string;
+    /**
+     * Renders a help icon next to the label which links to an external page.
+     */
+    helpLink?: string;
+    disabled?: boolean;
+    readonly?: boolean;
+    /**
+     * Extra content revealed beneath this choice **only while it is selected** —
+     * the follow-up question a choice opens up ("Other: ___", a date range once
+     * "Scheduled" is picked). Not a description; that is `helpText`.
+     *
+     * A string, or a VNode for anything richer.
+     */
+    revealedContent?: string | VNode;
+}

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

@@ -0,0 +1,18 @@
+import { ColorPickerProps } from './types';
+declare function commit(): void;
+declare const __VLS_export: import('vue').DefineComponent<ColorPickerProps, {
+    commit: typeof commit;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {} & {
+    "update:modelValue": (value: string) => any;
+}, string, import('vue').PublicProps, Readonly<ColorPickerProps> & Readonly<{
+    "onUpdate:modelValue"?: ((value: string) => any) | undefined;
+}>, {
+    disabled: boolean;
+    alpha: boolean;
+    swatchShape: import('./types').ColorSwatchShape;
+    eyedropper: boolean;
+    systemPicker: boolean;
+    hideInput: boolean;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+declare const _default: typeof __VLS_export;
+export default _default;

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

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