@scbt-ecom/ui 0.14.0 → 0.14.1

package/dist/shared/ui/checkbox/Checkbox.d.ts

@@ -4,11 +4,23 @@ type CheckboxBaseClasses = {
     indicator?: string;
 };
 export type CheckboxBaseProps = CheckboxPrimitiveProps & {
+    /**
+     * Дополнительные стили внутренних компонентов
+     */
     classes?: CheckboxBaseClasses;
+    /**
+     * Свойство для отображения не валидного поля
+     */
     invalid?: boolean;
 };
 export declare const CheckboxBase: import('react').ForwardRefExoticComponent<CheckboxPrimitiveProps & {
+    /**
+     * Дополнительные стили внутренних компонентов
+     */
     classes?: CheckboxBaseClasses;
+    /**
+     * Свойство для отображения не валидного поля
+     */
     invalid?: boolean;
 } & import('react').RefAttributes<HTMLButtonElement>>;
 export {};

package/dist/shared/ui/formElements/controlled/index.d.ts

@@ -34,9 +34,7 @@ export declare const Controlled: {
             label?: string;
         };
     }) => import("react/jsx-runtime").JSX.Element;
-    SelectControl: <TFieldValues extends import('react-hook-form').FieldValues = import('react-hook-form').FieldValues>({ control, classes, className, name, rules, shouldUnregister, disabled, defaultValue, returnValue, options, ...props }: import('react-hook-form').UseControllerProps<TFieldValues, import('react-hook-form').Path<TFieldValues>> & Omit<import('react-select').Props<import('../..').SelectItemOption, boolean>, "defaultValue" | "options" | "placeholder"> & Pick<import('../..').InputBaseProps, "attachmentProps"> & {
-        label: string;
-        invalid?: boolean;
+    SelectControl: <TFieldValues extends import('react-hook-form').FieldValues = import('react-hook-form').FieldValues>({ control, classes, className, name, rules, shouldUnregister, disabled, defaultValue, returnValue, options, ...props }: import('react-hook-form').UseControllerProps<TFieldValues, import('react-hook-form').Path<TFieldValues>> & Omit<import('react-select').Props<import('../..').SelectItemOption, boolean>, "defaultValue" | "options" | "placeholder" | "isSearchable"> & Pick<import('../..').InputBaseProps, "label" | "invalid" | "attachmentProps"> & {
         isSearchable?: boolean;
         returnValue?: (option: import('../..').SelectItemOption) => string;
         displayValue?: (option: import('../..').SelectItemOption) => string;

package/dist/shared/ui/input/Input.d.ts

@@ -7,17 +7,47 @@ type InputBaseClasses = {
 };
 type FieldAttachmentProps = React.ComponentPropsWithoutRef<typeof FieldAttachment>;
 export type InputBaseProps = Omit<React.InputHTMLAttributes<HTMLInputElement>, 'placeholder'> & {
+    /**
+     * Дополнительные стили внутренних компонентов
+     */
     classes?: InputBaseClasses;
+    /**
+     * Отображаемый placeholder
+     */
     label: string;
+    /**
+     * Отображение не валидного поля
+     */
     invalid?: boolean;
+    /**
+     * Свойства дополнительной иконки
+     */
     attachmentProps?: DeepPartial<FieldAttachmentProps>;
+    /**
+     * Рендер дополнительных значений вместо базового ввода
+     */
     renderValues?: () => React.JSX.Element | null;
 };
 export declare const InputBase: import('react').ForwardRefExoticComponent<Omit<import('react').InputHTMLAttributes<HTMLInputElement>, "placeholder"> & {
+    /**
+     * Дополнительные стили внутренних компонентов
+     */
     classes?: InputBaseClasses;
+    /**
+     * Отображаемый placeholder
+     */
     label: string;
+    /**
+     * Отображение не валидного поля
+     */
     invalid?: boolean;
+    /**
+     * Свойства дополнительной иконки
+     */
     attachmentProps?: DeepPartial<FieldAttachmentProps>;
+    /**
+     * Рендер дополнительных значений вместо базового ввода
+     */
     renderValues?: () => React.JSX.Element | null;
 } & import('react').RefAttributes<HTMLInputElement>>;
 export {};

package/dist/shared/ui/select/Select.d.ts

@@ -7,24 +7,56 @@ type SelectClasses = {
     option?: SelectItemClasses;
     list?: SelectListClasses;
 };
-export type SelectBaseProps<IsMulti extends boolean = boolean> = Omit<Props<SelectItemOption, IsMulti>, 'placeholder' | 'options' | 'defaultValue'> & Pick<InputBaseProps, 'attachmentProps'> & {
-    label: string;
-    invalid?: boolean;
+export type SelectBaseProps<IsMulti extends boolean = boolean> = Omit<Props<SelectItemOption, IsMulti>, 'placeholder' | 'options' | 'defaultValue' | 'isSearchable'> & Pick<InputBaseProps, 'attachmentProps' | 'label' | 'invalid'> & {
+    /**
+     * Свойство управляющее поиском
+     */
     isSearchable?: boolean;
+    /**
+     * Функция для управления возвращаемым значением
+     */
     returnValue?: (option: SelectItemOption) => string;
+    /**
+     * Функция для управления отображаемым значением
+     */
     displayValue?: (option: SelectItemOption) => string;
+    /**
+     * Дополнительные стили каждого внутреннего элемента
+     */
     classes?: SelectClasses;
+    /**
+     * Список отображаемых значений
+     */
     options: SelectItemOption[];
+    /**
+     * Свойство для выключения фильтрации элементов по поиску
+     */
     filterOptionDisabled?: boolean;
 };
-export declare const SelectBase: import('react').ForwardRefExoticComponent<Omit<Props<SelectItemOption, boolean>, "defaultValue" | "options" | "placeholder"> & Pick<InputBaseProps, "attachmentProps"> & {
-    label: string;
-    invalid?: boolean;
+export declare const SelectBase: import('react').ForwardRefExoticComponent<Omit<Props<SelectItemOption, boolean>, "defaultValue" | "options" | "placeholder" | "isSearchable"> & Pick<InputBaseProps, "label" | "invalid" | "attachmentProps"> & {
+    /**
+     * Свойство управляющее поиском
+     */
     isSearchable?: boolean;
+    /**
+     * Функция для управления возвращаемым значением
+     */
     returnValue?: (option: SelectItemOption) => string;
+    /**
+     * Функция для управления отображаемым значением
+     */
     displayValue?: (option: SelectItemOption) => string;
+    /**
+     * Дополнительные стили каждого внутреннего элемента
+     */
     classes?: SelectClasses;
+    /**
+     * Список отображаемых значений
+     */
     options: SelectItemOption[];
+    /**
+     * Свойство для выключения фильтрации элементов по поиску
+     */
     filterOptionDisabled?: boolean;
 } & import('react').RefAttributes<import('node_modules/react-select/dist/declarations/src/Select').default<SelectItemOption, boolean, import('react-select').GroupBase<SelectItemOption>>>>;
 export {};

package/dist/shared/ui/select/ui/control/Control.d.ts

@@ -6,7 +6,10 @@ export type ControlClasses = {
     control?: string;
     chip?: string;
 };
-type ControlProps = ControlBaseProps & Pick<SelectBaseProps, 'isSearchable' | 'label' | 'returnValue' | 'displayValue'> & Pick<InputBaseProps, 'attachmentProps' | 'invalid'> & {
+type ControlProps = ControlBaseProps & Pick<SelectBaseProps, 'isSearchable' | 'label' | 'returnValue' | 'displayValue' | 'invalid'> & Pick<InputBaseProps, 'attachmentProps'> & {
+    /**
+     * Дополнительные стили каждого внутреннего элемента
+     */
     classes?: ControlClasses & InputBaseProps['classes'];
 };
 export declare const Control: ({ isSearchable, label, attachmentProps, displayValue, isMulti, invalid, classes, ...props }: ControlProps) => import("react/jsx-runtime").JSX.Element;

package/dist/shared/ui/select/ui/control/hooks/useSelectController.d.ts

@@ -2,15 +2,47 @@ import { ActionMeta, InputActionMeta, OnChangeValue, PropsValue } from 'react-se
 import { SelectItemOption } from '../../../..';
 type InputChangeHandler = (value: string, action: InputActionMeta) => void;
 type UseSelectControllerProps<Option> = {
+    /**
+     * значение поля ввода
+     */
     inputValue: string;
+    /**
+     * функция для изменения поля ввода
+     */
     onInputChange: InputChangeHandler;
+    /**
+     * функция для открытия списка
+     */
     onMenuOpen: () => void;
+    /**
+     * функция для закрытия списка
+     */
     onMenuClose: () => void;
+    /**
+     * состояние отображения списка
+     */
     menuIsOpen: boolean;
+    /**
+     * функция, которая управляет отображаемым полем
+     */
     displayValue?: (option: Option) => string;
+    /**
+     * выбранные значения компонента
+     */
     value: PropsValue<Option>;
+    /**
+     * функция изменения выбранных значений
+     */
     onValueChange: (value: OnChangeValue<Option, boolean>, action: ActionMeta<Option>) => void;
 };
+/**
+ * Хук для управления компонентом Select
+ *
+ * @returns `onInputValueChange`,
+ *     `onMenuOpenToggle`,
+ *     `selectDisplayValue`,
+ *     `onDeleteItem`
+ */
 export declare const useSelectController: <Option extends SelectItemOption>({ inputValue, onInputChange, menuIsOpen, onMenuClose, onMenuOpen, displayValue, value, onValueChange }: UseSelectControllerProps<Option>) => {
     onInputValueChange: (event: React.ChangeEvent<HTMLInputElement>) => void;
     onMenuOpenToggle: () => void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scbt-ecom/ui",
-  "version": "0.14.0",
+  "version": "0.14.1",
   "type": "module",
   "exports": {
     "./utils-tailwind.css": "./dist/utils-tailwind.css",