@cloud-ru/uikit-product-fields-predefined 2.4.7 → 2.4.8-preview-f8642e85.0

package/dist/esm/components/FieldCode/FieldCode.d.ts

@@ -0,0 +1,42 @@
+import { FieldDecoratorProps } from '@snack-uikit/fields';
+import { type ResendCodeProps } from './components';
+import { type FieldCodeFocusEffect } from './constants';
+import { UseCodeInputParams } from './hooks';
+export type FieldCodeRef = {
+    /** Перенести фокус на ячейку с индексом `index` */
+    moveFocus: (index: number) => void;
+    /** Убрать фокус со всех ячеек кода */
+    blurFields: () => void;
+    /** Сбросить значение кода */
+    resetCode: () => void;
+};
+export type FieldCodeProps = {
+    /** CSS-класс компонента */
+    className?: string;
+    /** CSS-класс ячейки кода */
+    cellClassName?: string;
+    /** Позиции, после которых нужно вставить пробел (индексы символов, после которых будет пробел) */
+    spacing?: number[];
+    /** Подсветить пустые символы кода */
+    showEmptyChars?: boolean;
+    /** Компонент отправки нового кода */
+    resendCode?: ResendCodeProps;
+    /** Сценарии автофокуса; по умолчанию — первая ячейка при монтировании и после сброса (см. `FieldCodeFocusEffect`) */
+    focusEffects?: readonly FieldCodeFocusEffect[];
+} & Omit<UseCodeInputParams, 'moveFocus'> & Pick<FieldDecoratorProps, 'size' | 'disabled' | 'label' | 'error'>;
+export declare const FieldCode: import("react").ForwardRefExoticComponent<{
+    /** CSS-класс компонента */
+    className?: string;
+    /** CSS-класс ячейки кода */
+    cellClassName?: string;
+    /** Позиции, после которых нужно вставить пробел (индексы символов, после которых будет пробел) */
+    spacing?: number[];
+    /** Подсветить пустые символы кода */
+    showEmptyChars?: boolean;
+    /** Компонент отправки нового кода */
+    resendCode?: ResendCodeProps;
+    /** Сценарии автофокуса; по умолчанию — первая ячейка при монтировании и после сброса (см. `FieldCodeFocusEffect`) */
+    focusEffects?: readonly FieldCodeFocusEffect[];
+} & Omit<UseCodeInputParams, "moveFocus"> & Pick<FieldDecoratorProps, "size" | "label" | "error" | "disabled"> & import("react").RefAttributes<FieldCodeRef>>;
+export type { FieldCodeFocusEffect } from './constants';
+export { FIELD_CODE_DEFAULT_FOCUS_EFFECTS } from './constants';

package/dist/esm/components/FieldCode/FieldCode.js

@@ -0,0 +1,40 @@
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+import cn from 'classnames';
+import { forwardRef, useImperativeHandle } from 'react';
+import { FieldDecorator } from '@snack-uikit/fields';
+import { Cell, ResendCode } from './components';
+import { FIELD_CODE_DEFAULT_FOCUS_EFFECTS } from './constants';
+import { useCodeInput, useFieldHelpers, useFocusCell } from './hooks';
+import styles from './styles.module.css';
+import { getCellValidationState } from './utils';
+export const FieldCode = forwardRef(function FieldCode(props, ref) {
+    var _a;
+    const { codeLength, className, cellClassName, value, onChange, spacing, onComplete, size, disabled, label, error, showEmptyChars, resendCode, focusEffects = FIELD_CODE_DEFAULT_FOCUS_EFFECTS, } = props;
+    const { inputsRef, moveFocus, blurFields } = useFocusCell(codeLength);
+    const { code, cellHandlers, onChangeCode } = useCodeInput({ value, onChange, codeLength, moveFocus, onComplete });
+    const { resetCode } = useFieldHelpers({
+        onChangeCode,
+        focusEffects,
+        moveFocus,
+        showEmptyChars,
+        code,
+        codeLength,
+    });
+    useImperativeHandle(ref, () => ({
+        moveFocus,
+        blurFields,
+        resetCode,
+    }), [moveFocus, blurFields, resetCode]);
+    const resolvedDecoratorProps = {
+        label,
+        disabled,
+        size,
+        error,
+    };
+    return (_jsxs("div", { className: cn(styles.fieldCode, className), children: [_jsx(FieldDecorator, Object.assign({}, resolvedDecoratorProps, { children: _jsx("div", { className: styles.codeContainer, "data-size": size, children: code.map((char, index) => (_jsx(Cell, { ref: inputRef => {
+                            if (inputRef) {
+                                inputsRef.current[index] = inputRef;
+                            }
+                        }, className: cn((spacing === null || spacing === void 0 ? void 0 : spacing.includes(index)) && styles.cellSpacing, cellClassName), size: size, value: char, disabled: disabled, autoComplete: index === 0 ? 'one-time-code' : undefined, onKeyDown: e => cellHandlers.onKeyDown(e, index), onPaste: cellHandlers.onPaste, onChange: e => cellHandlers.onChange(e, index), validationState: getCellValidationState(char, showEmptyChars, Boolean(error)) }, index))) }) })), resendCode ? _jsx(ResendCode, Object.assign({}, resendCode, { size: (_a = resendCode.size) !== null && _a !== void 0 ? _a : size })) : null] }));
+});
+export { FIELD_CODE_DEFAULT_FOCUS_EFFECTS } from './constants';

package/dist/esm/components/FieldCode/components/Cell/Cell.d.ts

@@ -0,0 +1,5 @@
+import { FieldTextProps } from '@snack-uikit/fields';
+export declare const Cell: import("react").ForwardRefExoticComponent<{
+    /** CSS-класс ячейки кода */
+    className?: string;
+} & Pick<FieldTextProps, "size" | "onPaste" | "onChange" | "onKeyDown" | "value" | "disabled" | "autoComplete" | "validationState"> & import("react").RefAttributes<HTMLInputElement>>;

package/dist/esm/components/FieldCode/components/Cell/Cell.js

@@ -0,0 +1,21 @@
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+import { jsx as _jsx } from "react/jsx-runtime";
+import cn from 'classnames';
+import { forwardRef } from 'react';
+import { FieldText } from '@snack-uikit/fields';
+import { ZERO_WIDTH_SPACE } from '../../constants';
+import styles from './styles.module.css';
+export const Cell = forwardRef((props, ref) => {
+    const { className, size, value } = props, fieldCellProps = __rest(props, ["className", "size", "value"]);
+    return (_jsx(FieldText, Object.assign({ inputMode: 'numeric', ref: ref, className: cn(styles.cell, className), "data-size": size, showClearButton: false, value: value === ZERO_WIDTH_SPACE ? '' : value, size: size }, fieldCellProps)));
+});

package/dist/esm/components/FieldCode/components/Cell/index.d.ts

@@ -0,0 +1 @@
+export * from './Cell';

package/dist/esm/components/FieldCode/components/Cell/index.js

@@ -0,0 +1 @@
+export * from './Cell';

package/dist/esm/components/FieldCode/components/Cell/styles.module.css

@@ -0,0 +1,3 @@
+.cell input{
+  text-align:center;
+}

package/dist/esm/components/FieldCode/components/ResendCode/ResendCode.d.ts

@@ -0,0 +1,8 @@
+import { ButtonFunctionProps } from '@snack-uikit/button';
+export type ResendCodeProps = {
+    /** Колбек отправки нового кода */
+    onResend: () => void;
+    /** Количество секунд до следующего отправления кода */
+    secondsToNextResend: number;
+} & Pick<ButtonFunctionProps, 'size' | 'disabled'>;
+export declare function ResendCode(props: ResendCodeProps): import("react/jsx-runtime").JSX.Element;

package/dist/esm/components/FieldCode/components/ResendCode/ResendCode.js

@@ -0,0 +1,25 @@
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+import { jsx as _jsx } from "react/jsx-runtime";
+import { UpdateSVG } from '@cloud-ru/uikit-product-icons';
+import { useLocale } from '@cloud-ru/uikit-product-locale';
+import { ButtonFunction } from '@snack-uikit/button';
+import { formatSecondsAsMmSs } from './utils';
+export function ResendCode(props) {
+    const { onResend, secondsToNextResend } = props, buttonProps = __rest(props, ["onResend", "secondsToNextResend"]);
+    const { t } = useLocale('FieldsPredefined');
+    return (_jsx(ButtonFunction, Object.assign({ label: secondsToNextResend > 0
+            ? t('FieldCode.resendCodeButtons.resendCodeWithVia', {
+                timer: formatSecondsAsMmSs(secondsToNextResend),
+            })
+            : t('FieldCode.resendCodeButtons.resendCode'), onClick: onResend, icon: _jsx(UpdateSVG, {}), iconPosition: 'before' }, buttonProps)));
+}

package/dist/esm/components/FieldCode/components/ResendCode/index.d.ts

@@ -0,0 +1 @@
+export * from './ResendCode';

package/dist/esm/components/FieldCode/components/ResendCode/index.js

@@ -0,0 +1 @@
+export * from './ResendCode';

package/dist/esm/components/FieldCode/components/ResendCode/utils.d.ts

@@ -0,0 +1 @@
+export declare function formatSecondsAsMmSs(totalSeconds: number): string;

package/dist/esm/components/FieldCode/components/ResendCode/utils.js

@@ -0,0 +1,5 @@
+export function formatSecondsAsMmSs(totalSeconds) {
+    const minutes = Math.floor(totalSeconds / 60);
+    const seconds = totalSeconds % 60;
+    return `${String(minutes).padStart(2, '0')}:${String(seconds).padStart(2, '0')}`;
+}

package/dist/esm/components/FieldCode/components/index.d.ts

@@ -0,0 +1,2 @@
+export * from './Cell';
+export * from './ResendCode';

package/dist/esm/components/FieldCode/components/index.js

@@ -0,0 +1,2 @@
+export * from './Cell';
+export * from './ResendCode';

package/dist/esm/components/FieldCode/constants.d.ts

@@ -0,0 +1,14 @@
+export declare const ZERO_WIDTH_SPACE = "\u200B";
+/**
+ * Когда дергать `moveFocus` у `FieldCode` (массив `focusEffects`, порядок не важен).
+ * @see {@link FIELD_CODE_DEFAULT_FOCUS_EFFECTS}
+ */
+export type FieldCodeFocusEffect = 
+/** После монтирования — ячейка `0`. */
+'firstCellOnMount'
+/** После `ref.resetCode()` — ячейка `0`. */
+ | 'firstCellOnReset'
+/** При включении `showEmptyChars` — первая пустая (все заполнены — последняя); не на каждый ввод. */
+ | 'firstCellWhenShowEmptyChars';
+/** Дефолтный набор для `focusEffects`. */
+export declare const FIELD_CODE_DEFAULT_FOCUS_EFFECTS: readonly FieldCodeFocusEffect[];

package/dist/esm/components/FieldCode/constants.js

@@ -0,0 +1,7 @@
+export const ZERO_WIDTH_SPACE = '\u200B';
+/** Дефолтный набор для `focusEffects`. */
+export const FIELD_CODE_DEFAULT_FOCUS_EFFECTS = [
+    'firstCellOnMount',
+    'firstCellOnReset',
+    'firstCellWhenShowEmptyChars',
+];

package/dist/esm/components/FieldCode/hooks/index.d.ts

@@ -0,0 +1,3 @@
+export * from './useCodeInput';
+export * from './useFocusCell';
+export * from './useFieldHelpers';

package/dist/esm/components/FieldCode/hooks/index.js

@@ -0,0 +1,3 @@
+export * from './useCodeInput';
+export * from './useFocusCell';
+export * from './useFieldHelpers';

package/dist/esm/components/FieldCode/hooks/useCodeInput.d.ts

@@ -0,0 +1,22 @@
+import { ClipboardEvent, KeyboardEvent } from 'react';
+export type UseCodeInputParams = {
+    /** Количество цифр в коде */
+    codeLength: number;
+    /** Значение кода */
+    value?: string;
+    /** Колбек изменения значения */
+    onChange?: (code: string) => void;
+    /** Функция фокуса */
+    moveFocus: (index: number) => void;
+    /** Колбек достижения ввода всех символов кода */
+    onComplete?: (code: string) => void;
+};
+export declare function useCodeInput(params: UseCodeInputParams): {
+    code: string[];
+    cellHandlers: {
+        onKeyDown: (e: KeyboardEvent<HTMLInputElement>, index: number) => void;
+        onPaste: (e: ClipboardEvent<HTMLInputElement>) => void;
+        onChange: (code: string, index: number) => void;
+    };
+    onChangeCode: (value: any, ...args: any[]) => any | void;
+};

package/dist/esm/components/FieldCode/hooks/useCodeInput.js

@@ -0,0 +1,95 @@
+import { useRefState } from '@siberiacancode/reactuse';
+import { useCallback, useEffect } from 'react';
+import { useValueControl } from '@snack-uikit/utils';
+import { ZERO_WIDTH_SPACE } from '../constants';
+import { isNumberChar, isStringCodeLength, isZeroWidthSpace } from '../utils';
+const buildCodeArray = (str, codeLength) => Array.from({ length: codeLength }, (_, idx) => str[idx] || ZERO_WIDTH_SPACE);
+export function useCodeInput(params) {
+    const { value: valueProp, onChange: onChangeProp, codeLength, moveFocus, onComplete } = params;
+    const [value = '', onChange] = useValueControl({
+        value: valueProp,
+        onChange: onChangeProp,
+        defaultValue: '',
+    });
+    const codeRef = useRefState(buildCodeArray(value, codeLength));
+    const updateCodeByIndex = useCallback((index, newChar) => {
+        codeRef.current[index] = newChar;
+        onChange === null || onChange === void 0 ? void 0 : onChange(codeRef.current.join(''));
+    }, [codeRef, onChange]);
+    const updateFullCode = useCallback((newCode) => {
+        codeRef.current = newCode.split('');
+        onChange === null || onChange === void 0 ? void 0 : onChange(newCode);
+        moveFocus(codeLength - 1);
+        onComplete === null || onComplete === void 0 ? void 0 : onComplete(newCode);
+    }, [codeLength, codeRef, moveFocus, onChange, onComplete]);
+    const handleAfterCellUpdate = useCallback((index) => {
+        const normalizedCode = codeRef.current.join('');
+        const isLastInput = index === codeLength - 1;
+        const isAllInputsFilled = isStringCodeLength(normalizedCode, codeLength);
+        if (!isLastInput) {
+            moveFocus(index + 1);
+        }
+        else if (isAllInputsFilled) {
+            onComplete === null || onComplete === void 0 ? void 0 : onComplete(normalizedCode);
+        }
+    }, [codeLength, codeRef, moveFocus, onComplete]);
+    const deleteChar = useCallback((index) => {
+        if (codeRef.current[index] && !isZeroWidthSpace(codeRef.current[index])) {
+            updateCodeByIndex(index, ZERO_WIDTH_SPACE);
+        }
+        else if (index > 0) {
+            moveFocus(index - 1);
+        }
+    }, [codeRef, moveFocus, updateCodeByIndex]);
+    const onAutoCompleteInput = useCallback((code, index) => {
+        if (isStringCodeLength(code, codeLength)) {
+            updateFullCode(code);
+            return;
+        }
+        if (!isNumberChar(code)) {
+            return;
+        }
+        updateCodeByIndex(index, code);
+        handleAfterCellUpdate(index);
+    }, [codeLength, handleAfterCellUpdate, updateCodeByIndex, updateFullCode]);
+    const onKeyDown = useCallback((e, index) => {
+        switch (e.key) {
+            case 'ArrowLeft':
+                moveFocus(index - 1);
+                break;
+            case 'ArrowRight':
+                moveFocus(index + 1);
+                break;
+            case 'Backspace':
+                deleteChar(index);
+                break;
+            default:
+                if (isNumberChar(e.key)) {
+                    e.preventDefault();
+                    updateCodeByIndex(index, e.key);
+                    handleAfterCellUpdate(index);
+                }
+                break;
+        }
+    }, [deleteChar, handleAfterCellUpdate, moveFocus, updateCodeByIndex]);
+    const onPaste = useCallback((e) => {
+        var _a;
+        const codeInput = (_a = e === null || e === void 0 ? void 0 : e.clipboardData.getData('text')) !== null && _a !== void 0 ? _a : '';
+        if (!isStringCodeLength(codeInput, codeLength)) {
+            return;
+        }
+        updateFullCode(codeInput);
+    }, [codeLength, updateFullCode]);
+    useEffect(() => {
+        codeRef.current = buildCodeArray(value, codeLength);
+    }, [codeLength, codeRef, value]);
+    return {
+        code: codeRef.current,
+        cellHandlers: {
+            onKeyDown,
+            onPaste,
+            onChange: onAutoCompleteInput,
+        },
+        onChangeCode: onChange,
+    };
+}

package/dist/esm/components/FieldCode/hooks/useFieldHelpers.d.ts

@@ -0,0 +1,13 @@
+import { type FieldCodeFocusEffect } from '../constants';
+type UseFieldHelpersParams = {
+    onChangeCode: (code: string) => void;
+    moveFocus: (index: number) => void;
+    focusEffects: readonly FieldCodeFocusEffect[];
+    showEmptyChars?: boolean;
+    code: readonly string[];
+    codeLength: number;
+};
+export declare function useFieldHelpers(params: UseFieldHelpersParams): {
+    resetCode: () => void;
+};
+export {};

package/dist/esm/components/FieldCode/hooks/useFieldHelpers.js

@@ -0,0 +1,31 @@
+import { useCallback, useEffect, useMemo } from 'react';
+import { getFirstEmptyCellIndex } from '../utils';
+export function useFieldHelpers(params) {
+    const { onChangeCode, moveFocus, focusEffects: focusEffectsProp, showEmptyChars, code, codeLength } = params;
+    const focusEffectsKey = [...focusEffectsProp].sort().join(',');
+    const focusEffects = useMemo(() => [...focusEffectsProp], 
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+    [focusEffectsKey]);
+    const resetCode = useCallback(() => {
+        onChangeCode('');
+        if (focusEffects.includes('firstCellOnReset')) {
+            moveFocus(0);
+        }
+    }, [focusEffects, moveFocus, onChangeCode]);
+    useEffect(() => {
+        if (focusEffects.includes('firstCellOnMount')) {
+            moveFocus(0);
+        }
+    }, [focusEffects, moveFocus]);
+    useEffect(() => {
+        if (!focusEffects.includes('firstCellWhenShowEmptyChars') || !showEmptyChars) {
+            return;
+        }
+        const emptyIndex = getFirstEmptyCellIndex(code);
+        if (emptyIndex >= 0) {
+            moveFocus(emptyIndex);
+        }
+        // eslint-disable-next-line react-hooks/exhaustive-deps
+    }, [showEmptyChars, focusEffects, moveFocus, codeLength]);
+    return { resetCode };
+}

package/dist/esm/components/FieldCode/hooks/useFocusCell.d.ts

@@ -0,0 +1,5 @@
+export declare function useFocusCell(codeLength: number): {
+    inputsRef: import("react").MutableRefObject<HTMLInputElement[]>;
+    moveFocus: (newIndex: number) => void;
+    blurFields: () => void;
+};

package/dist/esm/components/FieldCode/hooks/useFocusCell.js

@@ -0,0 +1,19 @@
+import { useCallback, useRef } from 'react';
+export function useFocusCell(codeLength) {
+    const inputsRef = useRef([]);
+    const focusInput = useCallback((index) => {
+        var _a;
+        (_a = inputsRef.current[index]) === null || _a === void 0 ? void 0 : _a.focus();
+    }, [inputsRef]);
+    const moveFocus = useCallback((newIndex) => {
+        if (newIndex >= 0 && newIndex < codeLength) {
+            focusInput(newIndex);
+        }
+    }, [codeLength, focusInput]);
+    const blurFields = useCallback(() => {
+        inputsRef.current.forEach(input => {
+            input === null || input === void 0 ? void 0 : input.blur();
+        });
+    }, [inputsRef]);
+    return { inputsRef, moveFocus, blurFields };
+}

package/dist/esm/components/FieldCode/index.d.ts

@@ -0,0 +1 @@
+export * from './FieldCode';

package/dist/esm/components/FieldCode/index.js

@@ -0,0 +1 @@
+export * from './FieldCode';

package/dist/esm/components/FieldCode/styles.module.css

@@ -0,0 +1,30 @@
+.fieldCode{
+  display:flex;
+  flex-direction:column;
+  align-items:center;
+  gap:8px;
+}
+
+.codeContainer{
+  display:flex;
+  justify-content:center;
+}
+.codeContainer[data-size=s]{
+  gap:8px;
+}
+.codeContainer[data-size=m]{
+  gap:8px;
+}
+.codeContainer[data-size=l]{
+  gap:12px;
+}
+
+.cellSpacing[data-size=s]{
+  margin-right:2px;
+}
+.cellSpacing[data-size=m]{
+  margin-right:8px;
+}
+.cellSpacing[data-size=l]{
+  margin-right:12px;
+}

package/dist/esm/components/FieldCode/utils.d.ts

@@ -0,0 +1,6 @@
+import { FieldTextProps } from '@snack-uikit/fields';
+export declare const isNumberChar: (char: string) => boolean;
+export declare const isStringCodeLength: (input: string, codeLength: number) => boolean;
+export declare const isZeroWidthSpace: (value: string) => value is "​";
+export declare function getFirstEmptyCellIndex(code: readonly string[]): number;
+export declare const getCellValidationState: (value: string, showEmptyChars?: boolean, error?: boolean) => FieldTextProps["validationState"];

package/dist/esm/components/FieldCode/utils.js

@@ -0,0 +1,13 @@
+import { ZERO_WIDTH_SPACE } from './constants';
+export const isNumberChar = (char) => /^\d$/.test(char);
+export const isStringCodeLength = (input, codeLength) => new RegExp(`^\\d{${codeLength}}$`).test(input);
+export const isZeroWidthSpace = (value) => value === ZERO_WIDTH_SPACE;
+export function getFirstEmptyCellIndex(code) {
+    return code.findIndex(isZeroWidthSpace);
+}
+export const getCellValidationState = (value, showEmptyChars, error) => {
+    if (showEmptyChars) {
+        return isZeroWidthSpace(value) ? 'error' : 'default';
+    }
+    return error ? 'error' : 'default';
+};

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

@@ -6,3 +6,4 @@ export * from './AIDisclaimer';
 export * from './FieldName';
 export * from './FieldDescription';
 export * from './FieldMask';
+export * from './FieldCode';

package/dist/esm/components/index.js

@@ -6,3 +6,4 @@ export * from './AIDisclaimer';
 export * from './FieldName';
 export * from './FieldDescription';
 export * from './FieldMask';
+export * from './FieldCode';