@openreachtech/furo-vue 1.3.1

package/types/generated/components/atoms/FuroRadio/FuroRadio.vue.d.ts

@@ -0,0 +1,96 @@
+declare const _default: typeof __VLS_export;
+export default _default;
+declare const __VLS_export: import("vue").DefineComponent<{
+    parcel?: import("./FuroRadioContext.js").FuroRadioParcel | null;
+}, {
+    context: FuroRadioContext;
+}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    'change-value': (payload: import("./RadioEmitPayload.js").default) => void;
+    'update:value': (value: FuroRadioValue | null) => void;
+}, string, import("vue").PublicProps, Readonly<{
+    parcel?: import("./FuroRadioContext.js").FuroRadioParcel | null;
+}> & Readonly<{
+    "onChange-value"?: (payload: import("./RadioEmitPayload.js").default) => any;
+    "onUpdate:value"?: (value: import("./FuroRadioContext.js").FuroRadioValue) => any;
+}>, {
+    parcel: import("./FuroRadioContext.js").FuroRadioParcel;
+}, {}, {
+    RadioGroupRoot: {
+        new (...args: any[]): import("vue").CreateComponentPublicInstanceWithMixins<Readonly<import("reka-ui").RadioGroupRootProps> & Readonly<{
+            "onUpdate:modelValue"?: ((payload: import("reka-ui").AcceptableValue) => any) | undefined;
+        }>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+            "update:modelValue": (payload: import("reka-ui").AcceptableValue) => any;
+        }, import("vue").PublicProps, {}, false, {}, {}, import("vue").GlobalComponents, import("vue").GlobalDirectives, string, {}, any, import("vue").ComponentProvideOptions, {
+            P: {};
+            B: {};
+            D: {};
+            C: {};
+            M: {};
+            Defaults: {};
+        }, Readonly<import("reka-ui").RadioGroupRootProps> & Readonly<{
+            "onUpdate:modelValue"?: ((payload: import("reka-ui").AcceptableValue) => any) | undefined;
+        }>, {}, {}, {}, {}, {}>;
+        __isFragment?: never;
+        __isTeleport?: never;
+        __isSuspense?: never;
+    } & import("vue").ComponentOptionsBase<Readonly<import("reka-ui").RadioGroupRootProps> & Readonly<{
+        "onUpdate:modelValue"?: ((payload: import("reka-ui").AcceptableValue) => any) | undefined;
+    }>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+        "update:modelValue": (payload: import("reka-ui").AcceptableValue) => any;
+    }, string, {}, {}, string, {}, import("vue").GlobalComponents, import("vue").GlobalDirectives, string, import("vue").ComponentProvideOptions> & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps & (new () => {
+        $slots: {
+            default?: (props: {
+                modelValue: import("reka-ui").AcceptableValue | undefined;
+            }) => any;
+        };
+    });
+    RadioGroupOption: {
+        new (...args: any[]): import("vue").CreateComponentPublicInstanceWithMixins<Readonly<import("reka-ui").RadioGroupItemProps> & Readonly<{
+            onSelect?: ((event: import("reka-ui").RadioGroupItemSelectEvent) => any) | undefined;
+        }>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+            select: (event: import("reka-ui").RadioGroupItemSelectEvent) => any;
+        }, import("vue").PublicProps, {}, false, {}, {}, import("vue").GlobalComponents, import("vue").GlobalDirectives, string, {}, any, import("vue").ComponentProvideOptions, {
+            P: {};
+            B: {};
+            D: {};
+            C: {};
+            M: {};
+            Defaults: {};
+        }, Readonly<import("reka-ui").RadioGroupItemProps> & Readonly<{
+            onSelect?: ((event: import("reka-ui").RadioGroupItemSelectEvent) => any) | undefined;
+        }>, {}, {}, {}, {}, {}>;
+        __isFragment?: never;
+        __isTeleport?: never;
+        __isSuspense?: never;
+    } & import("vue").ComponentOptionsBase<Readonly<import("reka-ui").RadioGroupItemProps> & Readonly<{
+        onSelect?: ((event: import("reka-ui").RadioGroupItemSelectEvent) => any) | undefined;
+    }>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+        select: (event: import("reka-ui").RadioGroupItemSelectEvent) => any;
+    }, string, {}, {}, string, {}, import("vue").GlobalComponents, import("vue").GlobalDirectives, string, import("vue").ComponentProvideOptions> & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps & (new () => {
+        $slots: {
+            default?: (props: {
+                checked: boolean;
+                required: boolean;
+                disabled: boolean;
+            }) => any;
+        };
+    });
+    RadioGroupIndicator: {
+        new (...args: any[]): import("vue").CreateComponentPublicInstanceWithMixins<Readonly<import("reka-ui").RadioGroupIndicatorProps> & Readonly<{}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, import("vue").PublicProps, {}, false, {}, {}, import("vue").GlobalComponents, import("vue").GlobalDirectives, string, {}, any, import("vue").ComponentProvideOptions, {
+            P: {};
+            B: {};
+            D: {};
+            C: {};
+            M: {};
+            Defaults: {};
+        }, Readonly<import("reka-ui").RadioGroupIndicatorProps> & Readonly<{}>, {}, {}, {}, {}, {}>;
+        __isFragment?: never;
+        __isTeleport?: never;
+        __isSuspense?: never;
+    } & import("vue").ComponentOptionsBase<Readonly<import("reka-ui").RadioGroupIndicatorProps> & Readonly<{}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, {}, {}, string, {}, import("vue").GlobalComponents, import("vue").GlobalDirectives, string, import("vue").ComponentProvideOptions> & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps & (new () => {
+        $slots: {
+            default?: (props: {}) => any;
+        };
+    });
+}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+import FuroRadioContext from './FuroRadioContext.js';

package/types/generated/components/atoms/FuroRadio/FuroRadioContext.d.ts

@@ -0,0 +1,290 @@
+/**
+ * Context class for managing FuroRadio component.
+ *
+ * @extends {BaseFuroContext<null, Props, EmitEventName>}
+ */
+export default class FuroRadioContext extends BaseFuroContext<null, Props, "CHANGE_VALUE" | "UPDATE_VALUE"> {
+    /**
+     * Factory method.
+     *
+     * @template {X extends typeof FuroRadioContext ? X : never} T, X
+     * @override
+     * @param {FuroRadioContextFactoryParams} params - Parameters of this factory method.
+     * @returns {InstanceType<T>} An instance of this class.
+     * @this {T}
+     */
+    static override create<T extends X extends typeof FuroRadioContext ? X : never, X>(this: T, { props, componentContext, refHash, }: FuroRadioContextFactoryParams): InstanceType<T>;
+    /**
+     * Build ref hash.
+     *
+     * @override
+     */
+    static override buildRefHash(): {
+        internalValueRef: import("vue").Ref<any, any>;
+        radioRootElementRef: import("vue").Ref<any, any>;
+    };
+    /**
+     * Get emit event name.
+     *
+     * @override
+     * @returns {Readonly<{
+     *   CHANGE_VALUE: 'change-value'
+     *   UPDATE_VALUE: 'update:value'
+     * }>}
+     */
+    static override get EMIT_EVENT_NAME(): Readonly<{
+        CHANGE_VALUE: "change-value";
+        UPDATE_VALUE: "update:value";
+    }>;
+    /**
+     * Get emit options.
+     *
+     * @returns {{
+     *   'change-value': (payload: import('./RadioEmitPayload.js').default) => void
+     *   'update:value': (value: FuroRadioValue | null) => void
+     * }}
+     */
+    static get EMIT_EVENT_HASH(): {
+        "change-value": (payload: import("./RadioEmitPayload.js").default) => void;
+        "update:value": (value: FuroRadioValue | null) => void;
+    };
+    /**
+     * Default control size (width and height of one radio circle).
+     *
+     * @returns {string}
+     */
+    static get DEFAULT_RADIO_SIZE(): string;
+    /**
+     * Indicator dot size as a fraction of control size.
+     *
+     * The design draws a dot of 8px inside a control of 18px.
+     *
+     * @returns {number}
+     */
+    static get RADIO_DOT_SIZE_RATIO(): number;
+    /**
+     * get: Constructor of `EmitPayload`.
+     *
+     * @returns {typeof RadioEmitPayload}
+     */
+    static get EmitPayloadCtor(): typeof RadioEmitPayload;
+    /**
+     * Constructor.
+     *
+     * @param {FuroRadioContextParams} params
+     */
+    constructor({ props, componentContext, refHash, }: FuroRadioContextParams);
+    refHash: {
+        internalValueRef: import("vue").Ref<FuroRadioValue | null>;
+        radioRootElementRef: import("vue").Ref<HTMLElement | null>;
+    };
+    /**
+     * get: Constructor of this class.
+     *
+     * @override
+     * @returns {typeof FuroRadioContext}
+     */
+    override get Ctor(): typeof FuroRadioContext;
+    /**
+     * Get the internal chosen-value ref.
+     *
+     * @returns {import('vue').Ref<FuroRadioValue | null>}
+     */
+    get internalValueRef(): import("vue").Ref<FuroRadioValue | null>;
+    /**
+     * Get radio group root element ref.
+     *
+     * @returns {import('vue').Ref<HTMLElement | null>}
+     */
+    get radioRootElementRef(): import("vue").Ref<HTMLElement | null>;
+    /**
+     * Whether the parent controls `parcel.value`.
+     *
+     * @returns {boolean}
+     */
+    isControlled(): boolean;
+    /**
+     * Resolve the chosen value from parcel or fallthrough attrs.
+     *
+     * @returns {FuroRadioValue | null}
+     */
+    resolveSyncedValue(): FuroRadioValue | null;
+    /**
+     * Extract the options the group renders.
+     *
+     * @returns {Array<FuroRadioOption>}
+     */
+    extractOptions(): Array<FuroRadioOption>;
+    /**
+     * Whether the group is invalid.
+     *
+     * @returns {boolean}
+     */
+    isInvalid(): boolean;
+    /**
+     * Whether the whole group is disabled.
+     *
+     * @returns {boolean}
+     */
+    isDisabled(): boolean;
+    /**
+     * Whether the group is required.
+     *
+     * @returns {boolean}
+     */
+    isRequired(): boolean;
+    /**
+     * Whether one option is disabled.
+     *
+     * An option follows the group when it says nothing of its own.
+     *
+     * @param {{
+     *   option: FuroRadioOption
+     * }} params - Parameters.
+     * @returns {boolean}
+     */
+    isOptionDisabled({ option, }: {
+        option: FuroRadioOption;
+    }): boolean;
+    /**
+     * Whether one option is the chosen one.
+     *
+     * @param {{
+     *   option: FuroRadioOption
+     * }} params - Parameters.
+     * @returns {boolean}
+     */
+    isOptionSelected({ option, }: {
+        option: FuroRadioOption;
+    }): boolean;
+    /**
+     * Parse a simple CSS length (`rem`, `px`, `em`).
+     *
+     * @param {{
+     *   length: string
+     * }} params - Parameters.
+     * @returns {{ amount: number, unit: string } | null}
+     */
+    parseCssLength({ length, }: {
+        length: string;
+    }): {
+        amount: number;
+        unit: string;
+    } | null;
+    /**
+     * Extract indicator dot size proportional to control size.
+     *
+     * @returns {string}
+     */
+    extractRadioDotSize(): string;
+    /**
+     * Extract the dot size derived from the default control size.
+     *
+     * @returns {string}
+     */
+    extractDefaultRadioDotSize(): string;
+    /**
+     * Extract inline style for radio dimensions (CSS custom properties).
+     *
+     * @returns {{
+     *   '--furo-radio-size': string
+     *   '--furo-radio-dot-size': string
+     * }}
+     */
+    extractRadioRootStyle(): {
+        "--furo-radio-size": string;
+        "--furo-radio-dot-size": string;
+    };
+    /**
+     * Extract root attributes forwarded to the underlying group root.
+     *
+     * @returns {Record<string, unknown>}
+     */
+    extractRootAttributes(): Record<string, unknown>;
+    /**
+     * Build a custom event for radio value changes.
+     *
+     * @param {{
+     *   name: string
+     *   value: FuroRadioValue | null
+     * }} params - Parameters.
+     * @returns {import('./RadioEmitPayload.js').RadioRawEvent}
+     */
+    buildCustomEvent({ name, value, }: {
+        name: string;
+        value: FuroRadioValue | null;
+    }): import("./RadioEmitPayload.js").RadioRawEvent;
+    /**
+     * Setup component context.
+     *
+     * @template {X extends FuroRadioContext ? X : never} T, X
+     * @override
+     * @returns {T} - For method chaining.
+     * @this {T}
+     */
+    override setupComponent<T extends X extends FuroRadioContext ? X : never, X>(this: T): T;
+    /**
+     * Handle a value update emitted by the underlying group root.
+     *
+     * @param {{
+     *   rawValue: FuroRadioValue | null
+     * }} params - Parameters.
+     */
+    onChangeValue({ rawValue, }: {
+        rawValue: FuroRadioValue | null;
+    }): void;
+    /**
+     * Apply an interaction result to the internal chosen value.
+     *
+     * A controlled group only follows its parent, never its own interaction.
+     *
+     * @param {{
+     *   value: FuroRadioValue | null
+     * }} params - Parameters.
+     */
+    applyInternalValue({ value, }: {
+        value: FuroRadioValue | null;
+    }): void;
+}
+export type FuroRadioContextParams = import("../../../contexts/BaseFuroContext.js").BaseFuroContextParams & {
+    props: Props;
+    componentContext: ComponentContext;
+    refHash: {
+        internalValueRef: import("vue").Ref<FuroRadioValue | null>;
+        radioRootElementRef: import("vue").Ref<HTMLElement | null>;
+    };
+};
+export type FuroRadioContextFactoryParams = Omit<FuroRadioContextParams, "refHash"> & {
+    refHash?: {
+        internalValueRef: import("vue").Ref<FuroRadioValue | null>;
+        radioRootElementRef: import("vue").Ref<HTMLElement | null>;
+    };
+};
+export type EmitEventName = keyof typeof FuroRadioContext.EMIT_EVENT_NAME;
+/**
+ * Public chosen model (`v-model:value`, `parcel.value`).
+ */
+export type FuroRadioValue = string | number;
+export type FuroRadioOption = {
+    label: string;
+    value: FuroRadioValue;
+    disabled?: boolean;
+};
+export type Props = {
+    parcel?: FuroRadioParcel | null;
+};
+export type FuroRadioParcel = {
+    value?: FuroRadioValue | null;
+    options?: Array<FuroRadioOption>;
+    invalid?: boolean;
+    disabled?: boolean;
+    required?: boolean;
+    size?: string;
+};
+export type ComponentContext = import("vue").SetupContext<typeof FuroRadioContext.EMIT_EVENT_HASH>;
+export type FuroRadioEmitHash = typeof FuroRadioContext.EMIT_EVENT_HASH;
+export type FuroRadioSetup = (props: Props, componentContext: ComponentContext) => {
+    context: FuroRadioContext;
+};
+import BaseFuroContext from '../../../contexts/BaseFuroContext.js';
+import RadioEmitPayload from './RadioEmitPayload.js';

package/types/generated/components/atoms/FuroRadio/RadioEmitPayload.d.ts

@@ -0,0 +1,39 @@
+/**
+ * RadioEmitPayload.
+ *
+ * @extends {BaseEmitPayload<RadioRawEvent, HTMLElement>}
+ */
+export default class RadioEmitPayload extends BaseEmitPayload<RadioRawEvent, HTMLElement> {
+    constructor({ rawEvent, }: import("../../../emit-payload/BaseEmitPayload.js").BaseEmitPayloadParams<RadioRawEvent>);
+    /**
+     * Get the event detail.
+     *
+     * @returns {RadioRawEvent['detail'] | null}
+     */
+    get eventDetail(): RadioRawEvent["detail"] | null;
+    /**
+     * Value of the option chosen by the change.
+     *
+     * @returns {FuroRadioValue | null}
+     */
+    get value(): FuroRadioValue | null;
+    /**
+     * Whether an option is chosen after the change.
+     *
+     * A group with nothing chosen reports a null value, which is distinct from an
+     * option whose own value is null.
+     *
+     * @returns {boolean}
+     */
+    isSelected(): boolean;
+}
+export type FuroRadioValue = import("./FuroRadioContext.js").FuroRadioValue;
+export type RadioEmitPayloadParams = {
+    rawEvent: RadioRawEvent;
+};
+export type RadioRawEvent = CustomEvent<{
+    target: HTMLElement | null;
+    value: FuroRadioValue | null;
+}>;
+export type RadioEmitPayloadFactoryParams = RadioEmitPayloadParams;
+import BaseEmitPayload from '../../../emit-payload/BaseEmitPayload.js';

package/types/generated/components/atoms/FuroSwitch/FuroSwitch.vue.d.ts

@@ -0,0 +1,74 @@
+declare const _default: typeof __VLS_export;
+export default _default;
+declare const __VLS_export: import("vue").DefineComponent<{
+    parcel?: import("./FuroSwitchContext.js").FuroSwitchParcel | null;
+}, {
+    context: FuroSwitchContext;
+}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    'change-value': (payload: import("./SwitchEmitPayload.js").default) => void;
+    'update:value': (value: FuroSwitchValue) => void;
+}, string, import("vue").PublicProps, Readonly<{
+    parcel?: import("./FuroSwitchContext.js").FuroSwitchParcel | null;
+}> & Readonly<{
+    "onChange-value"?: (payload: import("./SwitchEmitPayload.js").default) => any;
+    "onUpdate:value"?: (value: boolean) => any;
+}>, {
+    parcel: import("./FuroSwitchContext.js").FuroSwitchParcel;
+}, {}, {
+    SwitchRoot: <T = boolean>(__VLS_props: NonNullable<Awaited<typeof __VLS_setup>>["props"], __VLS_ctx?: {
+        attrs: any;
+        slots: {
+            default?: (props: {
+                modelValue: T;
+                checked: boolean;
+            }) => any;
+        };
+        emit: (evt: "update:modelValue", payload: T) => void;
+    }, __VLS_exposed?: NonNullable<Awaited<typeof __VLS_setup>>["expose"], __VLS_setup?: Promise<{
+        props: import("vue").PublicProps & {
+            defaultValue?: T;
+            modelValue?: T;
+            disabled?: boolean;
+            id?: string;
+            value?: string;
+            trueValue?: T;
+            falseValue?: T;
+            asChild?: boolean;
+            as?: import("reka-ui").AsTag | import("vue").Component;
+            name?: string;
+            required?: boolean;
+            "onUpdate:modelValue"?: ((payload: T) => any) | undefined;
+        } & (typeof globalThis extends {
+            __VLS_PROPS_FALLBACK: infer P;
+        } ? P : {});
+        expose: (exposed: {}) => void;
+        attrs: any;
+        slots: {
+            default?: (props: {
+                modelValue: T;
+                checked: boolean;
+            }) => any;
+        };
+        emit: (evt: "update:modelValue", payload: T) => void;
+    }>) => import("vue").VNode & {
+        __ctx?: Awaited<typeof __VLS_setup>;
+    };
+    SwitchThumb: {
+        new (...args: any[]): import("vue").CreateComponentPublicInstanceWithMixins<Readonly<import("reka-ui").SwitchThumbProps> & Readonly<{}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, import("vue").PublicProps, {}, false, {}, {}, import("vue").GlobalComponents, import("vue").GlobalDirectives, string, {}, any, import("vue").ComponentProvideOptions, {
+            P: {};
+            B: {};
+            D: {};
+            C: {};
+            M: {};
+            Defaults: {};
+        }, Readonly<import("reka-ui").SwitchThumbProps> & Readonly<{}>, {}, {}, {}, {}, {}>;
+        __isFragment?: never;
+        __isTeleport?: never;
+        __isSuspense?: never;
+    } & import("vue").ComponentOptionsBase<Readonly<import("reka-ui").SwitchThumbProps> & Readonly<{}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, {}, {}, string, {}, import("vue").GlobalComponents, import("vue").GlobalDirectives, string, import("vue").ComponentProvideOptions> & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps & (new () => {
+        $slots: {
+            default?: (props: {}) => any;
+        };
+    });
+}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+import FuroSwitchContext from './FuroSwitchContext.js';