@skbkontur/react-ui 4.11.0 → 4.12.0-theme2022.6

package/cjs/components/ComboBox/ComboBox.d.ts

@@ -1,195 +1,195 @@
-import React from 'react';
-import { DropdownContainerProps } from '../../internal/DropdownContainer';
-import { Nullable } from '../../typings/utility-types';
-import { MenuItemState } from '../MenuItem';
-import { InputIconType } from '../Input';
-import { CommonProps } from '../../internal/CommonWrapper';
-export interface ComboBoxProps<T> extends Pick<DropdownContainerProps, 'menuPos'>, CommonProps {
-    align?: 'left' | 'center' | 'right';
-    /**
-     * Вызывает функцию поиска `getItems` при фокусе и очистке поля ввода
-     * @default true
-     */
-    searchOnFocus?: boolean;
-    /**
-     * Рисует справа иконку в виде стрелки
-     * @default true
-     */
-    drawArrow?: boolean;
-    autoFocus?: boolean;
-    borderless?: boolean;
-    /**
-     * Не использовать Portal для рендеринга меню.
-     * См. https://github.com/skbkontur/retail-ui/issues/15
-     * @default false
-     */
-    disablePortal?: boolean;
-    disabled?: boolean;
-    /**
-     * Состояние валидации при ошибке.
-     */
-    error?: boolean;
-    leftIcon?: InputIconType;
-    rightIcon?: InputIconType;
-    /**
-     * Функция поиска элементов, должна возвращать Promise с массивом элементов.
-     * По умолчанию ожидаются объекты с типом `{ value: string, label: string }`.
-     *
-     * Элементы могут быть любого типа. В этом случае необходимо определить
-     * свойства `itemToValue`, `renderValue`, `renderItem`, `valueToString`
-     */
-    getItems: (query: string) => Promise<T[]>;
-    /**
-     * Необходим для сравнения полученных результатов с `value`
-     * @default item => item.label
-     */
-    itemToValue?: (item: T) => string | number;
-    maxLength?: number;
-    menuAlign?: 'left' | 'right';
-    onBlur?: () => void;
-    /** Вызывается при изменении `value` */
-    onValueChange?: (value: T) => void;
-    onFocus?: () => void;
-    /**
-     * Вызывается при изменении текста в поле ввода,
-     * если результатом функции будет строка,
-     * то она станет следующим состоянием полем ввода
-     */
-    onInputValueChange?: (value: string) => Nullable<string> | void;
-    /**
-     * Функция для обработки ситуации, когда была введена
-     * строка в инпут и был потерян фокус с элемента.
-     *
-     * Если при потере фокуса в выпадающем списке будет только один
-     * элемент и  результат `renderValue` с этим элементом будет
-     * совпадать со значение в текстовом поле, то
-     * сработает onValueChange со значением данного элемента
-     *
-     * Сама функция также может вернуть значение,
-     * неравное `undefined`,
-     * с которым будет вызван onValueChange.
-     */
-    onUnexpectedInput?: (value: string) => void | null | T;
-    placeholder?: string;
-    /**
-     * Функция отрисовки элементов результата поиска.
-     * Не применяется если элемент является функцией или React-элементом
-     * @default item => item.label
-     */
-    renderItem?: (item: T, state?: MenuItemState) => React.ReactNode;
-    /**
-     * Компонент, заменяющий собой обёртку элементов результата поиска.
-     *
-     * По умолчанию все элементы результата поиска оборачиваются в тег `<button />`.
-     *
-     * @example
-     * itemWrapper={(item) => {
-     *    if (item.value === 3) {
-     *      return (props) => {
-     *        return <a {...props} />
-     *      }
-     *    }
-     * }}
-     */
-    itemWrapper?: (item?: T) => React.ComponentType<unknown>;
-    /**
-     * Функция для отрисовки сообщения о пустом результате поиска
-     * Если есть renderAddButton - не работает
-     */
-    renderNotFound?: () => React.ReactNode;
-    /**
-     * Функция отображающая сообщение об общем количестве элементов.
-     * `found` учитывает только компонент `MenuItem`. Им "оборачиваются" элементы, возвращаемые `getItems()`.
-     */
-    renderTotalCount?: (found: number, total: number) => React.ReactNode;
-    /**
-     * Функция отрисовки выбранного значения
-     * @default item => item.label
-     */
-    renderValue?: (item: T) => React.ReactNode;
-    /**
-     * Функция отрисовки кнопки добавления в выпадающем списке
-     */
-    renderAddButton?: (query?: string) => React.ReactNode;
-    /**
-     * Общее количество элементов.
-     * Необходим для работы `renderTotalCount`
-     */
-    totalCount?: number;
-    /**
-     * Выбранное значение
-     * Ожидается, что `value` того же типа что и элементы в массиве,
-     * возвращаемом в `getItems`
-     */
-    value?: Nullable<T>;
-    /**
-     * Необходим для преобразования `value` в строку при фокусировке
-     * @default item => item.label
-     */
-    valueToString?: (item: T) => string;
-    size?: 'small' | 'medium' | 'large';
-    /**
-     * Состояние валидации при предупреждении.
-     */
-    warning?: boolean;
-    width?: string | number;
-    maxMenuHeight?: number | string;
-    onMouseEnter?: (e: React.MouseEvent) => void;
-    onMouseOver?: (e: React.MouseEvent) => void;
-    onMouseLeave?: (e: React.MouseEvent) => void;
-    onInputKeyDown?: (e: React.KeyboardEvent<HTMLElement>) => void;
-    inputMode?: React.HTMLAttributes<HTMLInputElement>['inputMode'];
-}
-export interface ComboBoxItem {
-    value: string;
-    label: string;
-}
-declare type DefaultProps<T> = Required<Pick<ComboBoxProps<T>, 'itemToValue' | 'valueToString' | 'renderValue' | 'renderItem' | 'menuAlign' | 'searchOnFocus' | 'drawArrow'>>;
-export declare class ComboBox<T = ComboBoxItem> extends React.Component<ComboBoxProps<T>> {
-    static __KONTUR_REACT_UI__: string;
-    static defaultProps: DefaultProps<any>;
-    private getProps;
-    private comboboxElement;
-    private setRootNode;
-    /**
-     * @public
-     */
-    focus(): void;
-    /**
-     * @public
-     */
-    blur(): void;
-    /**
-     * Открывает выпадающий список и запускает поиск элементов
-     *
-     * @public
-     * @param {string} [query] Текст поиска. По умолчанию берется
-     * текст из инпута или результат `valueToString(value)`
-     */
-    search(query?: string): void;
-    /**
-     * @public
-     */
-    cancelSearch(): void;
-    /**
-     * @public Открывает выпадающий список
-     */
-    open(): void;
-    /**
-     * @public Закрывает выпадающий список
-     */
-    close(): void;
-    /**
-     * Выделяет текст внутри input
-     * @public
-     */
-    selectInputText(): void;
-    /**
-     * Сбрасывает введенное пользователем значение
-     * @public
-     */
-    reset(): void;
-    render(): JSX.Element;
-    private customComboBoxRef;
-}
-export {};
+import React from 'react';
+import { DropdownContainerProps } from '../../internal/DropdownContainer';
+import { Nullable } from '../../typings/utility-types';
+import { MenuItemState } from '../MenuItem';
+import { InputIconType } from '../Input';
+import { CommonProps } from '../../internal/CommonWrapper';
+export interface ComboBoxProps<T> extends Pick<DropdownContainerProps, 'menuPos'>, CommonProps {
+    align?: 'left' | 'center' | 'right';
+    /**
+     * Вызывает функцию поиска `getItems` при фокусе и очистке поля ввода
+     * @default true
+     */
+    searchOnFocus?: boolean;
+    /**
+     * Рисует справа иконку в виде стрелки
+     * @default true
+     */
+    drawArrow?: boolean;
+    autoFocus?: boolean;
+    borderless?: boolean;
+    /**
+     * Не использовать Portal для рендеринга меню.
+     * См. https://github.com/skbkontur/retail-ui/issues/15
+     * @default false
+     */
+    disablePortal?: boolean;
+    disabled?: boolean;
+    /**
+     * Состояние валидации при ошибке.
+     */
+    error?: boolean;
+    leftIcon?: InputIconType;
+    rightIcon?: InputIconType;
+    /**
+     * Функция поиска элементов, должна возвращать Promise с массивом элементов.
+     * По умолчанию ожидаются объекты с типом `{ value: string, label: string }`.
+     *
+     * Элементы могут быть любого типа. В этом случае необходимо определить
+     * свойства `itemToValue`, `renderValue`, `renderItem`, `valueToString`
+     */
+    getItems: (query: string) => Promise<T[]>;
+    /**
+     * Необходим для сравнения полученных результатов с `value`
+     * @default item => item.label
+     */
+    itemToValue?: (item: T) => string | number;
+    maxLength?: number;
+    menuAlign?: 'left' | 'right';
+    onBlur?: () => void;
+    /** Вызывается при изменении `value` */
+    onValueChange?: (value: T) => void;
+    onFocus?: () => void;
+    /**
+     * Вызывается при изменении текста в поле ввода,
+     * если результатом функции будет строка,
+     * то она станет следующим состоянием полем ввода
+     */
+    onInputValueChange?: (value: string) => Nullable<string> | void;
+    /**
+     * Функция для обработки ситуации, когда была введена
+     * строка в инпут и был потерян фокус с элемента.
+     *
+     * Если при потере фокуса в выпадающем списке будет только один
+     * элемент и  результат `renderValue` с этим элементом будет
+     * совпадать со значение в текстовом поле, то
+     * сработает onValueChange со значением данного элемента
+     *
+     * Сама функция также может вернуть значение,
+     * неравное `undefined`,
+     * с которым будет вызван onValueChange.
+     */
+    onUnexpectedInput?: (value: string) => void | null | T;
+    placeholder?: string;
+    /**
+     * Функция отрисовки элементов результата поиска.
+     * Не применяется если элемент является функцией или React-элементом
+     * @default item => item.label
+     */
+    renderItem?: (item: T, state?: MenuItemState) => React.ReactNode;
+    /**
+     * Компонент, заменяющий собой обёртку элементов результата поиска.
+     *
+     * По умолчанию все элементы результата поиска оборачиваются в тег `<button />`.
+     *
+     * @example
+     * itemWrapper={(item) => {
+     *    if (item.value === 3) {
+     *      return (props) => {
+     *        return <a {...props} />
+     *      }
+     *    }
+     * }}
+     */
+    itemWrapper?: (item?: T) => React.ComponentType<unknown>;
+    /**
+     * Функция для отрисовки сообщения о пустом результате поиска
+     * Если есть renderAddButton - не работает
+     */
+    renderNotFound?: () => React.ReactNode;
+    /**
+     * Функция отображающая сообщение об общем количестве элементов.
+     * `found` учитывает только компонент `MenuItem`. Им "оборачиваются" элементы, возвращаемые `getItems()`.
+     */
+    renderTotalCount?: (found: number, total: number) => React.ReactNode;
+    /**
+     * Функция отрисовки выбранного значения
+     * @default item => item.label
+     */
+    renderValue?: (item: T) => React.ReactNode;
+    /**
+     * Функция отрисовки кнопки добавления в выпадающем списке
+     */
+    renderAddButton?: (query?: string) => React.ReactNode;
+    /**
+     * Общее количество элементов.
+     * Необходим для работы `renderTotalCount`
+     */
+    totalCount?: number;
+    /**
+     * Выбранное значение
+     * Ожидается, что `value` того же типа что и элементы в массиве,
+     * возвращаемом в `getItems`
+     */
+    value?: Nullable<T>;
+    /**
+     * Необходим для преобразования `value` в строку при фокусировке
+     * @default item => item.label
+     */
+    valueToString?: (item: T) => string;
+    size?: 'small' | 'medium' | 'large';
+    /**
+     * Состояние валидации при предупреждении.
+     */
+    warning?: boolean;
+    width?: string | number;
+    maxMenuHeight?: number | string;
+    onMouseEnter?: (e: React.MouseEvent) => void;
+    onMouseOver?: (e: React.MouseEvent) => void;
+    onMouseLeave?: (e: React.MouseEvent) => void;
+    onInputKeyDown?: (e: React.KeyboardEvent<HTMLElement>) => void;
+    inputMode?: React.HTMLAttributes<HTMLInputElement>['inputMode'];
+}
+export interface ComboBoxItem {
+    value: string;
+    label: string;
+}
+declare type DefaultProps<T> = Required<Pick<ComboBoxProps<T>, 'itemToValue' | 'valueToString' | 'renderValue' | 'renderItem' | 'menuAlign' | 'searchOnFocus' | 'drawArrow'>>;
+export declare class ComboBox<T = ComboBoxItem> extends React.Component<ComboBoxProps<T>> {
+    static __KONTUR_REACT_UI__: string;
+    static defaultProps: DefaultProps<any>;
+    private getProps;
+    private comboboxElement;
+    private setRootNode;
+    /**
+     * @public
+     */
+    focus(): void;
+    /**
+     * @public
+     */
+    blur(): void;
+    /**
+     * Открывает выпадающий список и запускает поиск элементов
+     *
+     * @public
+     * @param {string} [query] Текст поиска. По умолчанию берется
+     * текст из инпута или результат `valueToString(value)`
+     */
+    search(query?: string): void;
+    /**
+     * @public
+     */
+    cancelSearch(): void;
+    /**
+     * @public Открывает выпадающий список
+     */
+    open(): void;
+    /**
+     * @public Закрывает выпадающий список
+     */
+    close(): void;
+    /**
+     * Выделяет текст внутри input
+     * @public
+     */
+    selectInputText(): void;
+    /**
+     * Сбрасывает введенное пользователем значение
+     * @public
+     */
+    reset(): void;
+    render(): JSX.Element;
+    private customComboBoxRef;
+}
+export {};

package/cjs/components/ComboBox/ComboBox.md

@@ -463,6 +463,48 @@ class ComboboxExample extends React.Component {
 <ComboboxExample />;
 ```
 
+
+При изменении значения и блюре `ComboBox` остается в состоянии `editing` и не дает изменить значение через проп `value`. Поэтому, для того чтобы задать новое значение, необходимо вызвать метод `reset`.
+
+```jsx harmony
+import { Button } from '@skbkontur/react-ui';
+
+  const [selected, setSelected] = React.useState({ value: 1, label: "First" });
+  const ref = React.useRef();
+
+  const handleButtonClick = () => {
+    if (ref.current) {
+      ref.current.reset();
+    }
+    setSelected({ value: 3, label: "Third" });
+  };
+
+  const getItems = (q) =>
+    Promise.resolve(
+      [
+        { value: 1, label: "First" },
+        { value: 2, label: "Second" },
+        { value: 3, label: "Third" }
+      ].filter(
+        (x) =>
+          x.label.toLowerCase().includes(q.toLowerCase()) ||
+          x.value.toString(10) === q
+      )
+    );
+
+  <div>
+    <ComboBox
+      ref={ref}
+      getItems={getItems}
+      onValueChange={setSelected}
+      placeholder="Enter number"
+      value={selected}
+    />
+    <Button onClick={handleButtonClick}>Make it three!</Button>
+  </div>
+
+```
+
 #### Локали по умолчанию
 
 ```typescript static

package/cjs/components/ComboBox/index.d.ts

@@ -1 +1 @@
-export * from './ComboBox';
+export * from './ComboBox';

package/cjs/components/CurrencyInput/CurrencyHelper.d.ts

@@ -1,35 +1,35 @@
-import { Nullable } from '../../typings/utility-types';
-import { DecimalOptions } from './CurrencyInputHelper';
-import { CursorMap } from './CursorHelper';
-export interface DecimalFormattingOptions {
-    fractionDigits?: Nullable<number>;
-    hideTrailingZeros?: boolean;
-    thousandsDelimiter?: string;
-    minusSign?: string;
-}
-declare type DecimalFormattingOptionsInternal = Required<DecimalFormattingOptions>;
-export interface FormattingInfo {
-    raw: string;
-    formatted: string;
-    cursorMap: CursorMap;
-}
-export declare class CurrencyHelper {
-    static defaultOptions: DecimalFormattingOptionsInternal;
-    static getOptions(options?: Nullable<DecimalFormattingOptions>): DecimalFormattingOptionsInternal;
-    static getInfo(value: string, options?: Nullable<DecimalFormattingOptions>): FormattingInfo;
-    static getCursorMap(formatted: string, formattingOptions?: Nullable<DecimalFormattingOptions>): CursorMap;
-    static format(value: Nullable<number>, options?: Nullable<DecimalFormattingOptions>): string;
-    static parse(value: string): Nullable<number>;
-    static unformatString(value: string): string;
-    static formatForClipboard(value: string): string;
-    static formatString(value: string, formattingOptions?: Nullable<DecimalFormattingOptions>): string;
-    static isValidString(value: string, options: DecimalOptions): boolean;
-    static extractValid(value: string, options: DecimalOptions): string;
-    static destructString(value: string): {
-        sign: string;
-        integer: string;
-        delimiter: string;
-        fraction: string;
-    } | null;
-}
-export {};
+import { Nullable } from '../../typings/utility-types';
+import { DecimalOptions } from './CurrencyInputHelper';
+import { CursorMap } from './CursorHelper';
+export interface DecimalFormattingOptions {
+    fractionDigits?: Nullable<number>;
+    hideTrailingZeros?: boolean;
+    thousandsDelimiter?: string;
+    minusSign?: string;
+}
+declare type DecimalFormattingOptionsInternal = Required<DecimalFormattingOptions>;
+export interface FormattingInfo {
+    raw: string;
+    formatted: string;
+    cursorMap: CursorMap;
+}
+export declare class CurrencyHelper {
+    static defaultOptions: DecimalFormattingOptionsInternal;
+    static getOptions(options?: Nullable<DecimalFormattingOptions>): DecimalFormattingOptionsInternal;
+    static getInfo(value: string, options?: Nullable<DecimalFormattingOptions>): FormattingInfo;
+    static getCursorMap(formatted: string, formattingOptions?: Nullable<DecimalFormattingOptions>): CursorMap;
+    static format(value: Nullable<number>, options?: Nullable<DecimalFormattingOptions>): string;
+    static parse(value: string): Nullable<number>;
+    static unformatString(value: string): string;
+    static formatForClipboard(value: string): string;
+    static formatString(value: string, formattingOptions?: Nullable<DecimalFormattingOptions>): string;
+    static isValidString(value: string, options: DecimalOptions): boolean;
+    static extractValid(value: string, options: DecimalOptions): string;
+    static destructString(value: string): {
+        sign: string;
+        integer: string;
+        delimiter: string;
+        fraction: string;
+    } | null;
+}
+export {};