@openreachtech/furo-vue 1.3.1

package/types/generated/components/atoms/FuroNumberField/FuroNumberFieldContext.d.ts

@@ -0,0 +1,243 @@
+/**
+ * Context class for managing FuroNumberField component.
+ *
+ * @extends {BaseFuroContext<null, Props, EmitEventName>}
+ */
+export default class FuroNumberFieldContext extends BaseFuroContext<null, Props, "CHANGE_VALUE" | "UPDATE_VALUE" | "COMMIT_VALUE"> {
+    /**
+     * Factory method.
+     *
+     * @template {X extends typeof FuroNumberFieldContext ? X : never} T, X
+     * @override
+     * @param {FuroNumberFieldContextFactoryParams} params - Parameters of this factory method.
+     * @returns {InstanceType<T>} An instance of this class.
+     * @this {T}
+     */
+    static override create<T extends X extends typeof FuroNumberFieldContext ? X : never, X>(this: T, { props, componentContext, refHash, }: FuroNumberFieldContextFactoryParams): InstanceType<T>;
+    /**
+     * Build ref hash.
+     *
+     * @override
+     * @returns {{
+     *   internalValueRef: import('vue').Ref<number | null>
+     *   inputElementRef: import('vue').Ref<HTMLInputElement | null>
+     * }}
+     */
+    static override buildRefHash(): {
+        internalValueRef: import("vue").Ref<number | null>;
+        inputElementRef: import("vue").Ref<HTMLInputElement | null>;
+    };
+    /**
+     * Get emit event name.
+     *
+     * @override
+     * @returns {Readonly<{
+     *   CHANGE_VALUE: 'change-value'
+     *   COMMIT_VALUE: 'commit-value'
+     *   UPDATE_VALUE: 'update:value'
+     * }>}
+     */
+    static override get EMIT_EVENT_NAME(): Readonly<{
+        CHANGE_VALUE: "change-value";
+        COMMIT_VALUE: "commit-value";
+        UPDATE_VALUE: "update:value";
+    }>;
+    /**
+     * Get emit options.
+     *
+     * @returns {{
+     *   'change-value': (payload: import('./NumberFieldEmitPayload.js').default) => void
+     *   'commit-value': (payload: import('./NumberFieldEmitPayload.js').default) => void
+     *   'update:value': (value: number | null) => void
+     * }}
+     */
+    static get EMIT_EVENT_HASH(): {
+        "change-value": (payload: import("./NumberFieldEmitPayload.js").default) => void;
+        "commit-value": (payload: import("./NumberFieldEmitPayload.js").default) => void;
+        "update:value": (value: number | null) => void;
+    };
+    /**
+     * get: Constructor of `EmitPayload`.
+     *
+     * @returns {typeof NumberFieldEmitPayload}
+     */
+    static get EmitPayloadCtor(): typeof NumberFieldEmitPayload;
+    /**
+     * Create an instance of `EmitPayload`.
+     *
+     * @param {{
+     *   rawValue: number | null
+     * }} params - Parameters.
+     * @returns {InstanceType<typeof NumberFieldEmitPayload>}
+     */
+    static createEmitPayload({ rawValue, }: {
+        rawValue: number | null;
+    }): InstanceType<typeof NumberFieldEmitPayload>;
+    /**
+     * Constructor.
+     *
+     * @param {FuroNumberFieldContextParams} params
+     */
+    constructor({ props, componentContext, refHash, }: FuroNumberFieldContextParams);
+    refHash: {
+        internalValueRef: import("vue").Ref<number | null>;
+        inputElementRef: import("vue").Ref<HTMLInputElement | null>;
+    };
+    /**
+     * get: Constructor of this class.
+     *
+     * @override
+     * @returns {typeof FuroNumberFieldContext}
+     */
+    override get Ctor(): typeof FuroNumberFieldContext;
+    /**
+     * Get internal value ref.
+     *
+     * @returns {import('vue').Ref<number | null>}
+     */
+    get internalValueRef(): import("vue").Ref<number | null>;
+    /**
+     * Parcel passed from parent via props.
+     * Get input element ref.
+     *
+     * @returns {import('vue').Ref<HTMLInputElement | null>}
+     */
+    get inputElementRef(): import("vue").Ref<HTMLInputElement | null>;
+    /**
+     * Input parcel passed from parent via props.
+     *
+     * @returns {FuroNumberFieldParcel['inputParcel'] & import('vue').InputHTMLAttributes | null}
+     */
+    get inputParcel(): (FuroNumberFieldParcel["inputParcel"] & import("vue").InputHTMLAttributes) | null;
+    /**
+     * Decrement parcel passed from parent via props.
+     *
+     * @returns {FuroNumberFieldParcel['decrementParcel']}
+     */
+    get decrementParcel(): FuroNumberFieldParcel["decrementParcel"];
+    /**
+     * Increment parcel passed from parent via props.
+     *
+     * @returns {FuroNumberFieldParcel['incrementParcel']}
+     */
+    get incrementParcel(): FuroNumberFieldParcel["incrementParcel"];
+    /**
+     * Placeholder passed from parent via props.
+     *
+     * @returns {HTMLInputElement['placeholder'] | null}
+     */
+    get placeholder(): HTMLInputElement["placeholder"] | null;
+    /**
+     * Name passed from parent via props.
+     *
+     * @returns {HTMLInputElement['name'] | null}
+     */
+    get name(): HTMLInputElement["name"] | null;
+    /**
+     * Setup component context.
+     *
+     * @template {X extends FuroNumberFieldContext ? X : never} T, X
+     * @override
+     * @returns {T} - For method chaining.
+     * @this {T}
+     */
+    override setupComponent<T extends X extends FuroNumberFieldContext ? X : never, X>(this: T): T;
+    /**
+     * Extract root attributes from parcel.
+     *
+     * @returns {Omit<import('reka-ui').NumberFieldRootProps, 'modelValue' | 'defaultValue'> | null}
+     */
+    extractRootAttributes(): Omit<import("reka-ui").NumberFieldRootProps, "modelValue" | "defaultValue"> | null;
+    /**
+     * Extract placeholder attribute.
+     *
+     * @returns {HTMLInputElement['placeholder']}
+     */
+    extractPlaceholderAttribute(): HTMLInputElement["placeholder"];
+    /**
+     * Extract name attribute.
+     *
+     * @returns {HTMLInputElement['name']}
+     */
+    extractNameAttribute(): HTMLInputElement["name"];
+    /**
+     * Whether the number field is invalid.
+     *
+     * @returns {boolean}
+     */
+    isInvalid(): boolean;
+    /**
+     * Build a custom event.
+     *
+     * @param {{
+     *   name: string
+     *   value: number | null
+     * }} params - Parameters.
+     * @returns {import('./NumberFieldEmitPayload.js').NumberFieldRawEvent}
+     */
+    buildCustomEvent({ name, value, }: {
+        name: string;
+        value: number | null;
+    }): import("./NumberFieldEmitPayload.js").NumberFieldRawEvent;
+    /**
+     * Handle value update emitted by Reka UI NumberFieldRoot.
+     * Called on every `update:modelValue` event (typing, stepping, wheel).
+     *
+     * @param {{
+     *   rawValue: number | null
+     * }} params - Parameters.
+     */
+    onChangeValue({ rawValue, }: {
+        rawValue: number | null;
+    }): void;
+    /**
+     * Handle commit event (blur or Enter key press on the input).
+     *
+     * @param {{
+     *   rawValue: number | null
+     * }} params - Parameters.
+     */
+    onCommitValue({ rawValue, }: {
+        rawValue: number | null;
+    }): void;
+}
+export type FuroNumberFieldContextParams = import("../../../contexts/BaseFuroContext.js").BaseFuroContextParams & {
+    props: Props;
+    componentContext: ComponentContext;
+    refHash: {
+        internalValueRef: import("vue").Ref<number | null>;
+        inputElementRef: import("vue").Ref<HTMLInputElement | null>;
+    };
+};
+export type FuroNumberFieldContextFactoryParams = Omit<FuroNumberFieldContextParams, "refHash"> & {
+    refHash?: {
+        internalValueRef: import("vue").Ref<number | null>;
+        inputElementRef: import("vue").Ref<HTMLInputElement | null>;
+    };
+};
+export type EmitEventName = keyof typeof FuroNumberFieldContext.EMIT_EVENT_NAME;
+export type Props = import("vue").HTMLAttributes & {
+    parcel?: FuroNumberFieldParcel | null;
+};
+export type ComponentContext = import("vue").SetupContext<FuroNumberFieldEmitHash, FuroNumberFieldSlots>;
+export type FuroNumberFieldSlots = import("vue").SlotsType<{
+    increment?: {
+        value: number;
+    };
+    decrement?: {
+        value: number;
+    };
+}>;
+export type FuroNumberFieldParcel = Omit<import("reka-ui").NumberFieldRootProps, "modelValue" | "defaultValue"> & {
+    value?: number | null;
+    invalid?: boolean;
+    inputParcel?: (import("reka-ui").NumberFieldInputProps & import("vue").InputHTMLAttributes) | null;
+    decrementParcel?: import("reka-ui").NumberFieldDecrementProps | null;
+    incrementParcel?: import("reka-ui").NumberFieldIncrementProps | null;
+};
+export type FuroNumberFieldEmitHash = typeof FuroNumberFieldContext.EMIT_EVENT_HASH;
+export type FuroNumberFieldSetup = (props: Props, componentContext: ComponentContext) => {
+    context: FuroNumberFieldContext;
+};
+import BaseFuroContext from '../../../contexts/BaseFuroContext.js';
+import NumberFieldEmitPayload from './NumberFieldEmitPayload.js';

package/types/generated/components/atoms/FuroNumberField/NumberFieldEmitPayload.d.ts

@@ -0,0 +1,74 @@
+/**
+ * NumberFieldEmitPayload.
+ *
+ * @extends {BaseEmitPayload<NumberFieldRawEvent>}
+ */
+export default class NumberFieldEmitPayload extends BaseEmitPayload<NumberFieldRawEvent, HTMLElement> {
+    constructor({ rawEvent, }: import("../../../emit-payload/BaseEmitPayload.js").BaseEmitPayloadParams<NumberFieldRawEvent>);
+    /**
+     * Get the event detail.
+     *
+     * @returns {NumberFieldRawEvent['detail'] | null}
+     */
+    get eventDetail(): NumberFieldRawEvent["detail"] | null;
+    /**
+     * Current numeric value of the number field.
+     * Returns `null` when the field is empty or cleared.
+     *
+     * @returns {number | null}
+     */
+    get value(): number | null;
+    /**
+     * Whether the field value is empty (null).
+     *
+     * @returns {boolean}
+     */
+    hasEmptyValue(): boolean;
+    /**
+     * Whether the field has a finite numeric value entered.
+     *
+     * @returns {boolean}
+     */
+    hasEnteredValue(): boolean;
+    /**
+     * Extract the `min` value attribute from the control element.
+     *
+     * @returns {number | null}
+     */
+    extractMinValueAttribute(): number | null;
+    /**
+     * Extract the `max` value attribute from the control element.
+     *
+     * @returns {number | null}
+     */
+    extractMaxValueAttribute(): number | null;
+    /**
+     * Whether the field value is greater than or equal to the control `min` attribute.
+     *
+     * @returns {boolean}
+     */
+    isGreaterThanOrEqualMin(): boolean;
+    /**
+     * Whether the field value is less than or equal to the control `max` attribute.
+     *
+     * @returns {boolean}
+     */
+    isLessThanOrEqualMax(): boolean;
+    /**
+     * Whether the field value lies between the control `min` and `max` attributes (inclusive).
+     *
+     * Requires both attributes to parse as finite numbers; otherwise returns `false`.
+     *
+     * @returns {boolean}
+     */
+    isWithinRange(): boolean;
+}
+export type NumberFieldEmitPayloadParams = {
+    rawEvent: NumberFieldRawEvent;
+};
+export type NumberFieldRawEvent = CustomEvent<{
+    target: HTMLInputElement | null;
+    value: number | null;
+}>;
+export type NumberFieldEmitPayloadFactoryParams = NumberFieldEmitPayloadParams;
+import BaseEmitPayload from '../../../emit-payload/BaseEmitPayload.js';