@zag-js/pin-input 0.1.9 → 0.1.12

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Chakra UI
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.d.ts

@@ -1,3 +1,136 @@
-export { connect } from "./pin-input.connect";
-export { machine } from "./pin-input.machine";
-export type { UserDefinedContext as Context } from "./pin-input.types";
+import { RequiredBy, DirectionProperty, CommonProperties, Context, PropTypes, NormalizeProps } from '@zag-js/types';
+import * as _zag_js_core from '@zag-js/core';
+import { StateMachine } from '@zag-js/core';
+
+declare type IntlMessages = {
+    inputLabel: (index: number, length: number) => string;
+};
+declare type ElementIds = Partial<{
+    root: string;
+    hiddenInput: string;
+    input(id: string): string;
+}>;
+declare type PublicContext = DirectionProperty & CommonProperties & {
+    /**
+     * The name of the input element. Useful for form submission.
+     */
+    name?: string;
+    /**
+     * The regular expression that the user-entered input value is checked against.
+     */
+    pattern?: string;
+    /**
+     * The ids of the elements in the pin input. Useful for composition.
+     */
+    ids?: ElementIds;
+    /**
+     * Whether the inputs are disabled
+     */
+    disabled?: boolean;
+    /**
+     * The placeholder text for the input
+     */
+    placeholder?: string;
+    /**
+     * Whether to auto-focus the first input.
+     */
+    autoFocus?: boolean;
+    /**
+     * Whether the pin input is in the invalid state
+     */
+    invalid?: boolean;
+    /**
+     * If `true`, the pin input component signals to its fields that they should
+     * use `autocomplete="one-time-code"`.
+     */
+    otp?: boolean;
+    /**
+     * The value of the the pin input.
+     */
+    value: string[];
+    /**
+     * The type of value the pin-input should allow
+     */
+    type?: "alphanumeric" | "numeric" | "alphabetic";
+    /**
+     * Function called when all inputs have valid values
+     */
+    onComplete?: (details: {
+        value: string[];
+        valueAsString: string;
+    }) => void;
+    /**
+     * Function called on input change
+     */
+    onChange?: (details: {
+        value: string[];
+    }) => void;
+    /**
+     * Function called when an invalid value is entered
+     */
+    onInvalid?: (details: {
+        value: string;
+        index: number;
+    }) => void;
+    /**
+     * If `true`, the input's value will be masked just like `type=password`
+     */
+    mask?: boolean;
+    /**
+     * Whether to blur the input when the value is complete
+     */
+    blurOnComplete?: boolean;
+    /**
+     * Specifies the localized strings that identifies the accessibility elements and their states
+     */
+    messages: IntlMessages;
+};
+declare type UserDefinedContext = RequiredBy<PublicContext, "id">;
+declare type ComputedContext = Readonly<{
+    /**
+     * @computed
+     * The number of inputs
+     */
+    valueLength: number;
+    /**
+     * @computed
+     * The number of inputs that are not empty
+     */
+    filledValueLength: number;
+    /**
+     * @computed
+     * Whether all input values are valid
+     */
+    isValueComplete: boolean;
+    /**
+     * @computed
+     * The string representation of the input values
+     */
+    valueAsString: string;
+}>;
+declare type PrivateContext = Context<{}>;
+declare type MachineContext = PublicContext & PrivateContext & ComputedContext;
+declare type MachineState = {
+    value: "unknown" | "idle" | "focused";
+};
+declare type State = StateMachine.State<MachineContext, MachineState>;
+declare type Send = StateMachine.Send<StateMachine.AnyEventObject>;
+
+declare function connect<T extends PropTypes>(state: State, send: Send, normalize: NormalizeProps<T>): {
+    value: string[];
+    valueAsString: string;
+    isValueComplete: boolean;
+    setValue(value: string[]): void;
+    clearValue(): void;
+    setValueAtIndex(index: number, value: string): void;
+    focus(): void;
+    rootProps: T["element"];
+    hiddenInputProps: T["input"];
+    getInputProps({ index }: {
+        index: number;
+    }): T["input"];
+};
+
+declare function machine(ctx: UserDefinedContext): _zag_js_core.Machine<MachineContext, MachineState, _zag_js_core.StateMachine.AnyEventObject>;
+
+export { UserDefinedContext as Context, connect, machine };