Юниверс DG SDK UI
v2.15.0

Интерфейс UserSelectProps<T>

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

Параметры типа

Иерархия

  • Omit<
        SelectProps,
        | "value"
        | "onChange"
        | "mode"
        | "selectedOptions"
        | "isWaiting"
        | "options"
        | "onSearch"
        | "onDropdownVisibleChange",
    >
    • UserSelectProps
Индекс

Свойства

addText?: string

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

allowClear?: boolean

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

autoFocus?: boolean

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

canAdd?: boolean

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

canCreate?: boolean

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

canSelectAll?: boolean

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

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

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

Объявление типа

"data-readonly"?: true

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

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

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

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

dropdownOverflowType?: OVERFLOW_TYPE

Поведение при переполнении содержимого выпадающего списка

dropdownRef?: Ref<HTMLDivElement>

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

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

errorMessage?: ReactNode

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

excludeUsernames?: string[]
hasBorder?: boolean

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

hasError?: boolean

Флаг ошибки.

inputRef?: Ref<HTMLInputElement>

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

inputRowsMode?: SelectInputRowsMode

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

isAllSelected?: boolean

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

isDefaultOpen?: boolean

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

isDisabled?: boolean

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

isHighlighted?: boolean

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

isOpen?: boolean

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

isReadOnly?: boolean

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

mode?: T
Окончание поддержки:2.16.0
multipleValueRenderer?: (
    option: SelectOption,
    onDeleteSelectedOption: (
        option: SelectOption,
    ) => (e: SyntheticEvent) => void,
) => ReactNode

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

Объявление типа

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

multiValueRenderer?: (
    option: SelectOption,
    onDeleteSelectedOption: (
        option: SelectOption,
    ) => (e: SyntheticEvent) => void,
    defaultRenderer: (
        value: SelectSingleValueType,
        displayValue: string,
        title: string,
        option: SelectOption,
    ) => ReactNode,
) => ReactNode

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

Объявление типа

notFoundContent?: ReactNode

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

notFoundText?: string

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

onAdd?: () => void

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

onBlur?: () => void

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

onChange?: (value?: UserSelectValue<T>) => void
onClear?: () => void

Обработчик очистки.

onDeselect?: (value: SelectValue<SelectSingleValueType>) => void

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

Объявление типа

onDeselectAll?: () => void

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

onFocus?: () => void

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

onPrefixClick?: (e: MouseEvent) => void

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

Объявление типа

    • (e: MouseEvent): void
    • Параметры

      Возвращает void

onSelect?: (value: SelectValue<SelectSingleValueType>) => void

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

Объявление типа

onSelectAll?: () => void

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

onSuffixClick?: (e: MouseEvent) => void

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

Объявление типа

    • (e: MouseEvent): void
    • Параметры

      Возвращает void

optionRenderer?: (option: SelectOption) => ReactNode

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

Объявление типа

optionsMaxHeight?: number

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

placeholder?: string

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

prefix?: ReactNode

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

preserveValueOrdering?: boolean

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

scrollModeMaxRows?: number

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

selectAllText?: string

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

selectNoneText?: string

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

shouldBlurOnClose?: boolean

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

showArrow?: boolean

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

showPlaceholderWhenDisabled?: boolean

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

showSearch?: boolean

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

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

sortOrder?: "ASC" | "DESC"

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

suffix?: ReactNode

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

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

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

Объявление типа

title?: ReactNode

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

tooltipPlacement?: PLACEMENT

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

useClientFilter?: boolean

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

usersStatus?: UserStatus
valueRenderer?: (value?: SelectValue<SelectSingleValueType>) => ReactNode

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

Объявление типа

withSystemUser?: boolean