@openreachtech/furo-vue 1.3.1

package/types/generated/components/molecules/FuroToggleGroup/FuroToggleGroupContext.d.ts

@@ -0,0 +1,270 @@
+/**
+ * Context class for managing FuroToggleGroup component.
+ *
+ * @extends {BaseFuroContext<null, Props, EmitEventName>}
+ */
+export default class FuroToggleGroupContext extends BaseFuroContext<null, Props, "CHANGE_VALUE" | "UPDATE_VALUE"> {
+    /**
+     * Factory method.
+     *
+     * @template {X extends typeof FuroToggleGroupContext ? X : never} T, X
+     * @override
+     * @param {FuroToggleGroupContextFactoryParams} params - Parameters of this factory method.
+     * @returns {InstanceType<T>} An instance of this class.
+     * @this {T}
+     */
+    static override create<T extends X extends typeof FuroToggleGroupContext ? X : never, X>(this: T, { props, componentContext, refHash, }: FuroToggleGroupContextFactoryParams): InstanceType<T>;
+    /**
+     * Build ref hash.
+     *
+     * @override
+     */
+    static override buildRefHash(): {
+        internalValueRef: import("vue").Ref<any, any>;
+        groupRootElementRef: 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('./ToggleGroupEmitPayload.js').default) => void
+     *   'update:value': (value: FuroToggleGroupValue) => void
+     * }}
+     */
+    static get EMIT_EVENT_HASH(): {
+        "change-value": (payload: import("./ToggleGroupEmitPayload.js").default) => void;
+        "update:value": (value: FuroToggleGroupValue) => void;
+    };
+    /**
+     * get: Constructor of `EmitPayload`.
+     *
+     * @returns {typeof ToggleGroupEmitPayload}
+     */
+    static get EmitPayloadCtor(): typeof ToggleGroupEmitPayload;
+    /**
+     * Constructor.
+     *
+     * @param {FuroToggleGroupContextParams} params
+     */
+    constructor({ props, componentContext, refHash, }: FuroToggleGroupContextParams);
+    refHash: {
+        internalValueRef: import("vue").Ref<FuroToggleGroupValue>;
+        groupRootElementRef: import("vue").Ref<HTMLElement | null>;
+    };
+    /**
+     * get: Constructor of this class.
+     *
+     * @override
+     * @returns {typeof FuroToggleGroupContext}
+     */
+    override get Ctor(): typeof FuroToggleGroupContext;
+    /**
+     * Get internal value ref (synced selection model).
+     *
+     * @returns {import('vue').Ref<FuroToggleGroupValue>}
+     */
+    get internalValueRef(): import("vue").Ref<FuroToggleGroupValue>;
+    /**
+     * Get group root element ref.
+     *
+     * @returns {import('vue').Ref<HTMLElement | null>}
+     */
+    get groupRootElementRef(): import("vue").Ref<HTMLElement | null>;
+    /**
+     * Get the toggle options.
+     *
+     * @returns {Array<FuroToggleGroupOption>}
+     */
+    get options(): Array<FuroToggleGroupOption>;
+    /**
+     * Resolve the selection mode (maps to the primitive's selection type).
+     *
+     * @returns {FuroToggleGroupSelectionMode}
+     */
+    resolveSelectionMode(): FuroToggleGroupSelectionMode;
+    /**
+     * Resolve the layout orientation.
+     *
+     * @returns {FuroToggleGroupOrientation}
+     */
+    resolveOrientation(): FuroToggleGroupOrientation;
+    /**
+     * Whether multiple values can be selected.
+     *
+     * @returns {boolean}
+     */
+    isMultiple(): boolean;
+    /**
+     * Resolve the default empty selection for the current selection mode.
+     *
+     * @returns {FuroToggleGroupValue}
+     */
+    resolveDefaultValue(): FuroToggleGroupValue;
+    /**
+     * Whether the parent controls `parcel.value`.
+     *
+     * @returns {boolean}
+     */
+    isControlled(): boolean;
+    /**
+     * Resolve synced selection value from parcel or fallthrough attrs.
+     *
+     * @returns {FuroToggleGroupValue}
+     */
+    resolveSyncedValue(): FuroToggleGroupValue;
+    /**
+     * Whether the group is disabled.
+     *
+     * @returns {boolean}
+     */
+    isDisabled(): boolean;
+    /**
+     * Whether a single option is disabled.
+     *
+     * @param {{
+     *   option: FuroToggleGroupOption
+     * }} params - Parameters.
+     * @returns {boolean}
+     */
+    isOptionDisabled({ option, }: {
+        option: FuroToggleGroupOption;
+    }): boolean;
+    /**
+     * Whether the given option value is currently selected.
+     *
+     * @param {{
+     *   value: string
+     * }} params - Parameters.
+     * @returns {boolean}
+     */
+    isSelected({ value, }: {
+        value: string;
+    }): boolean;
+    /**
+     * Extract the display label for an option.
+     *
+     * @param {{
+     *   option: FuroToggleGroupOption
+     * }} params - Parameters.
+     * @returns {string}
+     */
+    extractOptionLabel({ option, }: {
+        option: FuroToggleGroupOption;
+    }): string;
+    /**
+     * Extract CSS class map for the group root.
+     *
+     * @returns {Record<string, boolean>}
+     */
+    extractRootClassNames(): Record<string, boolean>;
+    /**
+     * Extract CSS class map for a single toggle item.
+     *
+     * @param {{
+     *   option: FuroToggleGroupOption
+     * }} params - Parameters.
+     * @returns {Record<string, boolean>}
+     */
+    extractItemClassNames({ option, }: {
+        option: FuroToggleGroupOption;
+    }): Record<string, boolean>;
+    /**
+     * Extract root attributes forwarded to the underlying primitive.
+     *
+     * @returns {Record<string, unknown>}
+     */
+    extractRootAttributes(): Record<string, unknown>;
+    /**
+     * Build a custom event for selection changes.
+     *
+     * @param {{
+     *   name: string
+     *   value: FuroToggleGroupValue
+     * }} params - Parameters.
+     * @returns {import('./ToggleGroupEmitPayload.js').ToggleGroupRawEvent}
+     */
+    buildCustomEvent({ name, value, }: {
+        name: string;
+        value: FuroToggleGroupValue;
+    }): import("./ToggleGroupEmitPayload.js").ToggleGroupRawEvent;
+    /**
+     * Setup component context.
+     *
+     * @template {X extends FuroToggleGroupContext ? X : never} T, X
+     * @override
+     * @returns {T} - For method chaining.
+     * @this {T}
+     */
+    override setupComponent<T extends X extends FuroToggleGroupContext ? X : never, X>(this: T): T;
+    /**
+     * Handle selection update emitted by the underlying primitive.
+     *
+     * @param {{
+     *   rawValue: FuroToggleGroupValue
+     * }} params - Parameters.
+     */
+    onChangeValue({ rawValue, }: {
+        rawValue: FuroToggleGroupValue;
+    }): void;
+}
+export type FuroToggleGroupContextParams = import("../../../contexts/BaseFuroContext.js").BaseFuroContextParams & {
+    props: Props;
+    componentContext: ComponentContext;
+    refHash: {
+        internalValueRef: import("vue").Ref<FuroToggleGroupValue>;
+        groupRootElementRef: import("vue").Ref<HTMLElement | null>;
+    };
+};
+export type FuroToggleGroupContextFactoryParams = Omit<FuroToggleGroupContextParams, "refHash"> & {
+    refHash?: {
+        internalValueRef: import("vue").Ref<FuroToggleGroupValue>;
+        groupRootElementRef: import("vue").Ref<HTMLElement | null>;
+    };
+};
+export type EmitEventName = keyof typeof FuroToggleGroupContext.EMIT_EVENT_NAME;
+/**
+ * Public selection model (`v-model:value`, `parcel.value`).
+ * A single value in `single` mode, an array in `multiple` mode.
+ */
+export type FuroToggleGroupValue = string | Array<string> | null;
+export type FuroToggleGroupSelectionMode = "single" | "multiple";
+export type FuroToggleGroupOrientation = "horizontal" | "vertical";
+export type FuroToggleGroupVariant = "default" | "outline";
+export type FuroToggleGroupSize = "default" | "sm" | "lg";
+export type FuroToggleGroupOption = {
+    value: string;
+    label?: string;
+    disabled?: boolean;
+};
+export type Props = {
+    parcel?: FuroToggleGroupParcel | null;
+};
+export type FuroToggleGroupParcel = {
+    value?: FuroToggleGroupValue;
+    selectionMode?: FuroToggleGroupSelectionMode;
+    options?: Array<FuroToggleGroupOption>;
+    variant?: FuroToggleGroupVariant;
+    size?: FuroToggleGroupSize;
+    disabled?: boolean;
+    orientation?: FuroToggleGroupOrientation;
+};
+export type FuroToggleGroupEmitHash = typeof FuroToggleGroupContext.EMIT_EVENT_HASH;
+export type ComponentContext = import("vue").SetupContext<FuroToggleGroupEmitHash>;
+export type FuroToggleGroupSetup = (props: Props, componentContext: ComponentContext) => {
+    context: FuroToggleGroupContext;
+};
+import BaseFuroContext from '../../../contexts/BaseFuroContext.js';
+import ToggleGroupEmitPayload from './ToggleGroupEmitPayload.js';

package/types/generated/components/molecules/FuroToggleGroup/ToggleGroupEmitPayload.d.ts

@@ -0,0 +1,41 @@
+/**
+ * ToggleGroupEmitPayload.
+ *
+ * @extends {BaseEmitPayload<ToggleGroupRawEvent, HTMLElement>}
+ */
+export default class ToggleGroupEmitPayload extends BaseEmitPayload<ToggleGroupRawEvent, HTMLElement> {
+    constructor({ rawEvent, }: import("../../../emit-payload/BaseEmitPayload.js").BaseEmitPayloadParams<ToggleGroupRawEvent>);
+    /**
+     * Get the event detail.
+     *
+     * @returns {ToggleGroupRawEvent['detail'] | null}
+     */
+    get eventDetail(): ToggleGroupRawEvent["detail"] | null;
+    /**
+     * Selected value(s) after the change.
+     *
+     * @returns {FuroToggleGroupValue | null}
+     */
+    get value(): FuroToggleGroupValue | null;
+    /**
+     * Whether the given option value is selected after the change.
+     *
+     * @param {{
+     *   value: string
+     * }} params - Parameters.
+     * @returns {boolean}
+     */
+    isSelected({ value, }: {
+        value: string;
+    }): boolean;
+}
+export type FuroToggleGroupValue = import("./FuroToggleGroupContext.js").FuroToggleGroupValue;
+export type ToggleGroupEmitPayloadParams = {
+    rawEvent: ToggleGroupRawEvent;
+};
+export type ToggleGroupRawEvent = CustomEvent<{
+    target: HTMLElement | null;
+    value: FuroToggleGroupValue | null;
+}>;
+export type ToggleGroupEmitPayloadFactoryParams = ToggleGroupEmitPayloadParams;
+import BaseEmitPayload from '../../../emit-payload/BaseEmitPayload.js';

package/types/generated/components/molecules/FuroToolBar/FuroToolBar.vue.d.ts

@@ -0,0 +1,30 @@
+declare const _default: typeof __VLS_export;
+export default _default;
+declare const __VLS_export: import("vue").DefineComponent<{
+    parcel: import("./FuroToolBarContext.js").FuroToolBarParcel | null;
+}, {
+    context: FuroToolBarContext;
+}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{
+    parcel: import("./FuroToolBarContext.js").FuroToolBarParcel | null;
+}> & Readonly<{}>, {
+    parcel: import("./FuroToolBarContext.js").FuroToolBarParcel;
+}, {}, {
+    RekaToolbarRoot: {
+        new (...args: any[]): import("vue").CreateComponentPublicInstanceWithMixins<Readonly<import("reka-ui").ToolbarRootProps> & 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").ToolbarRootProps> & Readonly<{}>, {}, {}, {}, {}, {}>;
+        __isFragment?: never;
+        __isTeleport?: never;
+        __isSuspense?: never;
+    } & import("vue").ComponentOptionsBase<Readonly<import("reka-ui").ToolbarRootProps> & 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 FuroToolBarContext from './FuroToolBarContext.js';

package/types/generated/components/molecules/FuroToolBar/FuroToolBarContext.d.ts

@@ -0,0 +1,48 @@
+/**
+ * Context class for FuroToolBar molecule.
+ *
+ * Presentational container that groups interactive controls (buttons, toggles,
+ * separators) into a single roving-focus region. It carries no value and emits
+ * nothing — orientation, text direction, and focus wrapping are declarative.
+ *
+ * @extends {BaseFuroContext<null, Props, null>}
+ */
+export default class FuroToolBarContext extends BaseFuroContext<null, Props, null> {
+    constructor({ props, componentContext, reactiveHash, refHash, shallowRefHash, modelRefHash, }: import("../../../contexts/BaseFuroContext.js").BaseFuroContextParams<Props, null, {}, {}, {}, {}>);
+    /**
+     * get: layout orientation of the toolbar.
+     *
+     * @returns {'horizontal' | 'vertical'} Orientation; defaults to horizontal.
+     */
+    get orientation(): "horizontal" | "vertical";
+    /**
+     * Extract the reading direction forwarded to the underlying primitive.
+     *
+     * Maps the value-oriented `textDirection` parcel key (`toRight` / `toLeft`)
+     * to the primitive's `dir` value. Defaults to left-to-right.
+     *
+     * @returns {'ltr' | 'rtl'} Reading direction.
+     */
+    extractTextDirectionValue(): "ltr" | "rtl";
+    /**
+     * Whether roving focus wraps from the last control back to the first.
+     *
+     * @returns {boolean} true when focus loops at the toolbar ends.
+     */
+    isLoopingFocus(): boolean;
+    /**
+     * Extract the CSS class map for the toolbar root.
+     *
+     * @returns {Record<string, boolean>} Class map keyed by class name.
+     */
+    extractRootClassNames(): Record<string, boolean>;
+}
+export type Props = {
+    parcel: FuroToolBarParcel | null;
+};
+export type FuroToolBarParcel = {
+    orientation?: "horizontal" | "vertical";
+    textDirection?: "toRight" | "toLeft";
+    loopFocus?: boolean;
+};
+import BaseFuroContext from '../../../contexts/BaseFuroContext.js';