Search
    Preparing search index...

    Interface SelectProps<OPT>

    Свойства компонента выбора

    interface SelectProps<OPT extends SelectOption<any> = SelectOption> {
        addText?: string;
        allowClear?: boolean;
        autoFocus?: boolean;
        canAdd?: boolean;
        canCreate?: boolean;
        canSelectAll?: boolean;
        createOption?: (baseData: SelectOption<string>) => OPT;
        "data-readonly"?: true;
        defaultValue?: SelectValue<SelectOptionValue<OPT>>;
        dropdownMatchSelectWidth?: "autoContent" | "1.5:1";
        dropdownRef?: Ref<HTMLDivElement>;
        dropdownRender?: DropdownRenderFunction<OPT>;
        errorMessage?: ReactNode;
        hasBorder?: boolean;
        hasError?: boolean;
        inputRef?: Ref<HTMLInputElement>;
        inputRowsMode?: SelectInputRowsMode;
        isAllSelected?: boolean;
        isDefaultOpen?: boolean;
        isDisabled?: boolean;
        isHighlighted?: boolean;
        isOpen?: boolean;
        isReadOnly?: boolean;
        isWaiting?: boolean;
        mode?: SelectMode;
        multipleValueRenderer?: (
            option: OPT,
            onDeleteSelectedOption: (option: OPT) => (e: SyntheticEvent) => void,
        ) => ReactNode;
        multiValueRenderer?: (
            option: OPT,
            onDeleteSelectedOption: (option: OPT) => (e: SyntheticEvent) => void,
            defaultRenderer: (
                value: SelectOptionValue<OPT>,
                displayValue: string,
                title: string,
                option: OPT,
            ) => ReactNode,
        ) => ReactNode;
        notFoundContent?: ReactNode;
        notFoundText?: string;
        onAdd?: () => void;
        onBlur?: () => void;
        onChange?: (
            value: undefined | SelectValue<SelectOptionValue<OPT>>,
            options?: OPT[],
        ) => void;
        onDeselect?: (value: SelectValue<SelectOptionValue<OPT>>) => void;
        onDeselectAll?: () => void;
        onDropdownVisibleChange?: (isOpen: boolean) => void;
        onFocus?: () => void;
        onPrefixClick?: (e: MouseEvent) => void;
        onSearch?: (text: string) => void;
        onSelect?: (value: SelectValue<SelectOptionValue<OPT>>) => void;
        onSelectAll?: () => void;
        onSuffixClick?: (e: MouseEvent) => void;
        optionRenderer?: (option: OPT) => ReactNode;
        options: OPT[];
        optionsMaxHeight?: number;
        placeholder?: string;
        prefix?: ReactNode;
        preserveValueOrdering?: boolean;
        scrollModeMaxRows?: number;
        selectAllText?: string;
        selectedOptions?: OPT[];
        selectNoneText?: string;
        shouldBlurOnClose?: boolean;
        showArrow?: boolean;
        showPlaceholderWhenDisabled?: boolean;
        showSearch?: boolean;
        size?: SIZE;
        sortOrder?: "ASC" | "DESC";
        suffix?: ReactNode;
        targetRenderer?: (
            handleClick: (e: MouseEvent<HTMLDivElement>) => void,
            value?: SelectValue<SelectOption<OPT>>,
        ) => ReactNode;
        title?: ReactNode;
        tooltipPlacement?: PLACEMENT;
        useClientFilter?: boolean;
        value?: SelectValue<SelectOptionValue<OPT>>;
        valueRenderer?: (value?: SelectValue<SelectOptionValue<OPT>>) => ReactNode;
    }

    Type Parameters

    Index

    Properties

    addText? allowClear? autoFocus? canAdd? canCreate? canSelectAll? createOption? data-readonly? defaultValue? dropdownMatchSelectWidth? dropdownRef? dropdownRender? errorMessage? hasBorder? hasError? inputRef? inputRowsMode? isAllSelected? isDefaultOpen? isDisabled? isHighlighted? isOpen? isReadOnly? isWaiting? mode? multipleValueRenderer? multiValueRenderer? notFoundContent? notFoundText? onAdd? onBlur? onChange? onDeselect? onDeselectAll? onDropdownVisibleChange? onFocus? onPrefixClick? onSearch? onSelect? onSelectAll? onSuffixClick? optionRenderer? options optionsMaxHeight? placeholder? prefix? preserveValueOrdering? scrollModeMaxRows? selectAllText? selectedOptions? selectNoneText? shouldBlurOnClose? showArrow? showPlaceholderWhenDisabled? showSearch? size? sortOrder? suffix? targetRenderer? title? tooltipPlacement? useClientFilter? value? valueRenderer?

    Properties

    addText?: string

    Текст для кнопки добавления.

    allowClear?: boolean

    Разрешает очистку выбранных значений.

    autoFocus?: boolean

    Автоматическая фокусировка.

    canAdd?: boolean

    Разрешает добавление опции.

    canCreate?: boolean

    Разрешает создание новой опции.

    canSelectAll?: boolean

    Разрешает выбор всех опций сразу.

    createOption?: (baseData: SelectOption<string>) => OPT

    Создает новую опцию.

    Type declaration

    "data-readonly"?: true

    Имеет ли поле атрибут только для чтения.

    defaultValue?: SelectValue<SelectOptionValue<OPT>>

    Значение по умолчанию.

    dropdownMatchSelectWidth?: "autoContent" | "1.5:1"

    Ширина выпадающего списка относительно поля ввода.

    dropdownRef?: Ref<HTMLDivElement>

    Ссылка на контейнер выпадающего списка.

    dropdownRender?: DropdownRenderFunction<OPT>

    Функция рендера выпадающего списка.

    errorMessage?: ReactNode

    Текст сообщения об ошибке.

    hasBorder?: boolean

    Флаг показа границы.

    hasError?: boolean

    Флаг ошибки.

    inputRef?: Ref<HTMLInputElement>

    Ссылка на поле ввода.

    inputRowsMode?: SelectInputRowsMode

    Режим строк поля ввода.

    isAllSelected?: boolean

    Флаг полного выбора.

    isDefaultOpen?: boolean

    Флаг открытия по умолчанию.

    isDisabled?: boolean

    Флаг отключения.

    isHighlighted?: boolean

    Флаг подсвечивания.

    isOpen?: boolean

    Флаг текущего открытия списка.

    isReadOnly?: boolean

    Флаг только для чтения.

    isWaiting?: boolean

    Флаг состояния ожидания.

    mode?: SelectMode

    Режимы селекта

    multipleValueRenderer?: (
        option: OPT,
        onDeleteSelectedOption: (option: OPT) => (e: SyntheticEvent) => void,
    ) => ReactNode

    Пользовательский рендер нескольких значений.

    Type declaration

      • (
            option: OPT,
            onDeleteSelectedOption: (option: OPT) => (e: SyntheticEvent) => void,
        ): ReactNode

      • Parameters

        • option: OPT

          Опция.

        • onDeleteSelectedOption: (option: OPT) => (e: SyntheticEvent) => void

          Функция удаления выбранной опции.

        Returns ReactNode

    multipleValueRenderer использует HTML параметр title, который может отличаться от выводимого значения Необходимо использовать параметр multiValueRenderer

    @universe-platform/uikit 2.0.0

    multiValueRenderer?: (
        option: OPT,
        onDeleteSelectedOption: (option: OPT) => (e: SyntheticEvent) => void,
        defaultRenderer: (
            value: SelectOptionValue<OPT>,
            displayValue: string,
            title: string,
            option: OPT,
        ) => ReactNode,
    ) => ReactNode

    Пользовательский рендер нескольких значений.

    Type declaration

      • (
            option: OPT,
            onDeleteSelectedOption: (option: OPT) => (e: SyntheticEvent) => void,
            defaultRenderer: (
                value: SelectOptionValue<OPT>,
                displayValue: string,
                title: string,
                option: OPT,
            ) => ReactNode,
        ): ReactNode

      • Parameters

        • option: OPT

          Опция.

        • onDeleteSelectedOption: (option: OPT) => (e: SyntheticEvent) => void

          Функция удаления выбранной опции.

        • defaultRenderer: (
              value: SelectOptionValue<OPT>,
              displayValue: string,
              title: string,
              option: OPT,
          ) => ReactNode

          Встроенный рендер по умолчанию.

        Returns ReactNode

    notFoundContent?: ReactNode

    Содержимое для состояния отсутствия результатов.

    notFoundText?: string

    Текст при отсутствии результатов.

    onAdd?: () => void

    Обработчик добавления опции.

    onBlur?: () => void

    Обработчик потери фокуса.

    onChange?: (
        value: undefined | SelectValue<SelectOptionValue<OPT>>,
        options?: OPT[],
    ) => void

    Обработчик выбора нового значения.

    Type declaration

    onDeselect?: (value: SelectValue<SelectOptionValue<OPT>>) => void

    Обработчик отмены выбора.

    Type declaration

    onDeselectAll?: () => void

    Обработчик отмены выбора всех опций.

    onDropdownVisibleChange?: (isOpen: boolean) => void

    Обработчик изменения видимости выпадающего списка.

    Type declaration

      • (isOpen: boolean): void

      • Parameters

        • isOpen: boolean

          Текущее состояние видимости.

        Returns void

    onFocus?: () => void

    Обработчик фокусировки.

    onPrefixClick?: (e: MouseEvent) => void

    Обработчик клика по префиксу.

    Type declaration

    onSearch?: (text: string) => void

    Обработчик изменения текста для поиска.

    Type declaration

      • (text: string): void

      • Parameters

        • text: string

          Введенный текст.

        Returns void

    onSelect?: (value: SelectValue<SelectOptionValue<OPT>>) => void

    Обработчик выбора значения.

    Type declaration

    onSelectAll?: () => void

    Обработчик выбора всех опций.

    onSuffixClick?: (e: MouseEvent) => void

    Обработчик клика по суффиксу.

    Type declaration

    optionRenderer?: (option: OPT) => ReactNode

    Пользовательский рендер опции.

    Type declaration

    options: OPT[]

    Список опций выбора.

    optionsMaxHeight?: number

    Максимальная высота списка опций.

    placeholder?: string

    Текст-заполнитель.

    prefix?: ReactNode

    Префикс перед полем ввода.

    preserveValueOrdering?: boolean

    Сохранять порядок выбранных значений.

    scrollModeMaxRows?: number

    Максимальное количество строк в режиме прокрутки.

    selectAllText?: string

    Текст для кнопки "Выбрать все".

    selectedOptions?: OPT[]

    Список выбранных опций.

    selectNoneText?: string

    Текст для кнопки "Снять все".

    shouldBlurOnClose?: boolean

    Флаг необходимости терять фокус при закрытии.

    showArrow?: boolean

    Показать стрелку около поля ввода.

    showPlaceholderWhenDisabled?: boolean

    Показывать плейсхолдер, даже если поле отключено.

    showSearch?: boolean

    Флаг показа поля поиска.

    size?: SIZE

    Размер компонента.

    sortOrder?: "ASC" | "DESC"

    Порядок сортировки.

    suffix?: ReactNode

    Суффикс после поля ввода.

    targetRenderer?: (
        handleClick: (e: MouseEvent<HTMLDivElement>) => void,
        value?: SelectValue<SelectOption<OPT>>,
    ) => ReactNode

    Пользовательский рендер целевого элемента.

    Type declaration

    title?: ReactNode

    Заголовок компонента.

    tooltipPlacement?: PLACEMENT

    Позиция всплывающей подсказки.

    useClientFilter?: boolean

    Использовать клиентский фильтр.

    value?: SelectValue<SelectOptionValue<OPT>>

    Текущее значение.

    valueRenderer?: (value?: SelectValue<SelectOptionValue<OPT>>) => ReactNode

    Пользовательский рендер одиночного значения.

    Type declaration

    On This Page

    Properties