fui-material 2.5.6 → 2.5.7

package/dist/types/material/FSearchableSelect/FSearchableSelect.d.ts

@@ -1,31 +1,73 @@
 import React, { type ChangeEvent, type ReactNode, type CSSProperties } from "react";
 /**
  * Интерфейс пропсов для компонента `FSearchableSelect`.
+ *
+ * @interface IFSearchableSelect
+ * @extends {Omit<React.InputHTMLAttributes<HTMLInputElement>, 'value' | 'onChange'>}
  */
 export interface IFSearchableSelect extends Omit<React.InputHTMLAttributes<HTMLInputElement>, 'value' | 'onChange'> {
-    /** Метка (label) над полем */
+    /**
+     * Метка (label), отображаемая над полем ввода.
+     * @type {string | undefined}
+     */
     label?: string;
-    /** Инлайновые стили контейнера */
+    /**
+     * Инлайновые стили для внешнего контейнера компонента.
+     * @type {CSSProperties | undefined}
+     */
     st?: CSSProperties;
-    /** Опции выбора (обычно теги <option>) */
+    /**
+     * Дочерние элементы (обычно `<option>`), из которых формируется список выбора.
+     * Значения извлекаются из пропсов `value` и `children` переданных элементов.
+     * @type {ReactNode | undefined}
+     */
     children?: ReactNode;
-    /** Растянуть на 100% ширины */
+    /**
+     * Флаг, указывающий, должен ли компонент занимать 100% ширины родителя.
+     * @type {boolean | undefined}
+     */
     fullWidth?: boolean;
-    /** Состояние загрузки (блокирует ввод и показывает спиннер) */
+    /**
+     * Флаг состояния загрузки. Если true, отображается спиннер, а взаимодействие блокируется.
+     * @type {boolean | undefined}
+     */
     load?: boolean;
-    /** Текст ошибок (подсвечивает поле красным) */
+    /**
+     * Массив строк с текстом ошибок. Если массив не пуст, поле подсвечивается красным.
+     * @type {string[] | undefined}
+     */
     errText?: string[];
-    /** Вспомогательный текст под полем */
+    /**
+     * Вспомогательный текст, отображаемый под полем ввода.
+     * @type {string | undefined}
+     */
     helpText?: string;
-    /** Ширина поля */
+    /**
+     * Явное указание ширины компонента.
+     * @type {string | number | undefined}
+     */
     width?: string | number;
-    /** Высота поля */
+    /**
+     * Явное указание высоты компонента.
+     * @type {string | number | undefined}
+     */
     height?: string | number;
-    /** Разрешить создание новых значений (режим Combobox) */
+    /**
+     * Разрешить создание новых элементов, отсутствующих в списке.
+     * При вводе уникального текста появится опция "Создать".
+     * @type {boolean | undefined}
+     */
     allowCreate?: boolean;
-    /** Текущее значение */
+    /**
+     * Текущее значение поля (контролируемый компонент).
+     * @type {string | number | readonly string[] | undefined}
+     */
     value?: string | number | readonly string[];
-    /** Обработчик изменения значения */
+    /**
+     * Callback, вызываемый при изменении значения.
+     * Возвращает синтетическое событие с объектом target, содержащим name и value.
+     * @type {((event: { target: { name: string; value: string } } | ChangeEvent<HTMLInputElement>) => void) | undefined}
+     */
     onChange?: (event: {
         target: {
             name: string;
@@ -34,14 +76,52 @@ export interface IFSearchableSelect extends Omit<React.InputHTMLAttributes<HTMLI
     } | ChangeEvent<HTMLInputElement>) => void;
 }
 /**
- * Компонент `FSearchableSelect` — выпадающий список с поиском.
+ * Компонент `FSearchableSelect` — выпадающий список с возможностью поиска и фильтрации опций.
+ *
+ * Особенности:
+ * - Поддерживает фильтрацию списка при вводе текста.
+ * - Может работать как обычный Select или как Combobox (с `allowCreate`).
+ * - Парсит опции из переданных `children` (например, `<option value="1">One</option>`).
+ * - Поддерживает навигацию с клавиатуры (стрелки, Enter, Escape).
+ * - Имеет состояния: ошибка, загрузка, disabled.
  *
  * @component
  * @example
- * <FSearchableSelect label="Страна" value={val} onChange={handleChange}>
- *    <option value="ru">Россия</option>
- *    <option value="en">США</option>
+ * // Простой пример использования с опциями
+ * <FSearchableSelect
+ *   label="Выберите город"
+ *   value={city}
+ *   onChange={(e) => setCity(e.target.value)}
+ *   fullWidth
+ * >
+ *   <option value="moscow">Москва</option>
+ *   <option value="spb">Санкт-Петербург</option>
  * </FSearchableSelect>
+ *
+ * @example
+ * // Пример с созданием новых значений (allowCreate) и ошибкой
+ * <FSearchableSelect
+ *   label="Теги"
+ *   allowCreate
+ *   value={tag}
+ *   onChange={(e) => setTag(e.target.value)}
+ *   errText={hasError ? ['Некорректный тег'] : undefined}
+ * >
+ *   {tagsList.map(t => <option key={t.id} value={t.name}>{t.name}</option>)}
+ * </FSearchableSelect>
+ *
+ * @param {string} [label] - Метка поля.
+ * @param {CSSProperties} [st] - Стили контейнера.
+ * @param {ReactNode} [children] - Опции списка.
+ * @param {boolean} [fullWidth=false] - Растянуть на 100%.
+ * @param {boolean} [load=false] - Показать лоадер.
+ * @param {string[]} [errText] - Текст ошибки.
+ * @param {string} [helpText] - Подсказка.
+ * @param {boolean} [allowCreate=false] - Разрешить ввод своих значений.
+ * @param {string|number} [value] - Значение.
+ * @param {Function} [onChange] - Обработчик изменений.
+ *
+ * @returns {JSX.Element} Рендерит кастомный Select с поиском.
  */
 declare const FSearchableSelect: React.ForwardRefExoticComponent<IFSearchableSelect & React.RefAttributes<HTMLInputElement>>;
 export default FSearchableSelect;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fui-material",
-  "version": "2.5.6", 
+  "version": "2.5.7", 
   "type": "module",
   "publishConfig": {
     "access": "public",