Search
    Preparing search index...

    Interface FieldSelectProps

    Свойства компонента FieldSelect

    interface FieldSelectProps {
        addText?: string;
        allowClear?: boolean;
        autoFocus?: boolean;
        canAdd?: boolean;
        canCreate?: boolean;
        canSelectAll?: boolean;
        createOption?: (baseData: SelectOption<string>) => SelectOption;
        "data-qaid"?: string;
        "data-readonly"?: true;
        defaultValue?: SelectValue<SelectSingleValueType>;
        dropdownMatchSelectWidth?: "autoContent" | "1.5:1";
        dropdownOverflowType?: OVERFLOW_TYPE;
        dropdownRef?: Ref<HTMLDivElement>;
        dropdownRender?: DropdownRenderFunction<
            SelectOption<SelectSingleValueType>,
        >;
        error?: null | string | string[];
        errorMessage?: ReactNode;
        hasBorder?: boolean;
        hasError?: boolean;
        hasLeaderDots?: boolean;
        hint?: ReactNode;
        inputRef?: Ref<HTMLInputElement>;
        inputRowsMode?: SelectInputRowsMode;
        inputWidth?: number;
        isAllSelected?: boolean;
        isDefaultOpen?: boolean;
        isDisabled?: boolean;
        isExtraItemsCentered?: boolean;
        isHighlighted?: boolean;
        isMultiLine?: boolean;
        isOpen?: boolean;
        isReadOnly?: boolean;
        isRequired?: boolean;
        isWaiting?: boolean;
        isWide?: boolean;
        label?: ReactNode;
        labelWidth?: number;
        mode?: SelectMode;
        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;
        name: string;
        notFoundContent?: ReactNode;
        notFoundText?: string;
        onAdd?: () => void;
        onBlur?: () => void;
        onChange?: (name: string, value: SelectValue) => void;
        onClear?: () => void;
        onDeselect?: (name: string, value: string) => void;
        onDeselectAll?: () => void;
        onDropdownVisibleChange?: (isOpen: boolean) => void;
        onFocus?: () => void;
        onPrefixClick?: (e: MouseEvent) => void;
        onSearch?: (name: string, value: any) => void;
        onSelect?: (name: string, value: SelectValue) => void;
        onSelectAll?: () => void;
        onSuffixClick?: (e: MouseEvent) => void;
        optionRenderer?: (option: SelectOption) => ReactNode;
        options: SelectOption<SelectSingleValueType>[];
        optionsMaxHeight?: number;
        overlapButton?: Element;
        placeholder?: string;
        prefix?: ReactNode;
        preserveValueOrdering?: boolean;
        rightExtraItems?: ReactNode;
        scrollModeMaxRows?: number;
        selectAllText?: string;
        selectedOptions?: SelectOption<SelectSingleValueType>[];
        selectNoneText?: string;
        shouldBlurOnClose?: boolean;
        showArrow?: boolean;
        showPlaceholderWhenDisabled?: boolean;
        showSearch?: boolean;
        size?: Universe.Platform.Uikit.SIZE;
        sortOrder?: "ASC" | "DESC";
        sublabel?: string;
        suffix?: ReactNode;
        targetRenderer?: (
            handleClick: (e: MouseEvent<HTMLDivElement>) => void,
            value?: SelectValue<SelectSingleValueType>,
        ) => ReactNode;
        title?: ReactNode;
        tooltipPlacement?: PLACEMENT;
        useClientFilter?: boolean;
        value?: SelectValue<SelectSingleValueType>;
        valueRenderer?: (value?: SelectValue<SelectSingleValueType>) => ReactNode;
        viewMode?: FIELD_MODE;
    }

    Hierarchy (View Summary)

    Index

    Properties

    addText? allowClear? autoFocus? canAdd? canCreate? canSelectAll? createOption? data-qaid? data-readonly? defaultValue? dropdownMatchSelectWidth? dropdownOverflowType? dropdownRef? dropdownRender? error? errorMessage? hasBorder? hasError? hasLeaderDots? hint? inputRef? inputRowsMode? inputWidth? isAllSelected? isDefaultOpen? isDisabled? isExtraItemsCentered? isHighlighted? isMultiLine? isOpen? isReadOnly? isRequired? isWaiting? isWide? label? labelWidth? mode? multipleValueRenderer? multiValueRenderer? name notFoundContent? notFoundText? onAdd? onBlur? onChange? onClear? onDeselect? onDeselectAll? onDropdownVisibleChange? onFocus? onPrefixClick? onSearch? onSelect? onSelectAll? onSuffixClick? optionRenderer? options optionsMaxHeight? overlapButton? placeholder? prefix? preserveValueOrdering? rightExtraItems? scrollModeMaxRows? selectAllText? selectedOptions? selectNoneText? shouldBlurOnClose? showArrow? showPlaceholderWhenDisabled? showSearch? size? sortOrder? sublabel? suffix? targetRenderer? title? tooltipPlacement? useClientFilter? value? valueRenderer? viewMode?

    Properties

    addText?: string

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

    allowClear?: boolean

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

    autoFocus?: boolean

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

    canAdd?: boolean

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

    canCreate?: boolean

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

    canSelectAll?: boolean

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

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

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

    Type declaration

    "data-qaid"?: string
    "data-readonly"?: true

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

    defaultValue?: SelectValue<SelectSingleValueType>

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

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

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

    dropdownOverflowType?: OVERFLOW_TYPE

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

    dropdownRef?: Ref<HTMLDivElement>

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

    dropdownRender?: DropdownRenderFunction<SelectOption<SelectSingleValueType>>

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

    error?: null | string | string[]

    Ошибки поля

    errorMessage?: ReactNode

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

    hasBorder?: boolean

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

    hasError?: boolean

    Флаг ошибки.

    hasLeaderDots?: boolean

    Есть ли направляющие точки от лейбла к полю

    hint?: ReactNode

    Подсказка

    inputRef?: Ref<HTMLInputElement>

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

    inputRowsMode?: SelectInputRowsMode

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

    inputWidth?: number

    Ширина поля

    isAllSelected?: boolean

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

    isDefaultOpen?: boolean

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

    isDisabled?: boolean

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

    isExtraItemsCentered?: boolean
    isHighlighted?: boolean

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

    isMultiLine?: boolean
    isOpen?: boolean

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

    isReadOnly?: boolean

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

    isRequired?: boolean

    Является ли поле обязательным к заполнению

    isWaiting?: boolean

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

    isWide?: boolean

    На всю ширину контейнера

    label?: ReactNode

    Лейбл

    labelWidth?: number

    Ширина лейбла

    mode?: SelectMode

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

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

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

    Type declaration

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

    @universe-platform/uikit 2.0.0

    @universe-ee/sdk 6.16.0

    @universe-dg/sdk 2.16.0

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

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

    Type declaration

    name: string
    notFoundContent?: ReactNode

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

    notFoundText?: string

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

    onAdd?: () => void

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

    onBlur?: () => void

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

    onChange?: (name: string, value: SelectValue) => void
    onClear?: () => void

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

    onDeselect?: (name: string, value: string) => void
    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?: (name: string, value: any) => void
    onSelect?: (name: string, value: SelectValue) => void
    onSelectAll?: () => void

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

    onSuffixClick?: (e: MouseEvent) => void

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

    Type declaration

    optionRenderer?: (option: SelectOption) => ReactNode

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

    Type declaration

    options: SelectOption<SelectSingleValueType>[]

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

    optionsMaxHeight?: number

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

    overlapButton?: Element
    placeholder?: string

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

    prefix?: ReactNode

    Префикс поля

    preserveValueOrdering?: boolean

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

    rightExtraItems?: ReactNode

    Дополнительные элементы справа

    scrollModeMaxRows?: number

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

    selectAllText?: string

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

    selectedOptions?: SelectOption<SelectSingleValueType>[]

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

    selectNoneText?: string

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

    shouldBlurOnClose?: boolean

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

    showArrow?: boolean

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

    showPlaceholderWhenDisabled?: boolean

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

    showSearch?: boolean

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

    size?: Universe.Platform.Uikit.SIZE

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

    sortOrder?: "ASC" | "DESC"

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

    sublabel?: string

    Дополнительный текст лейбла

    suffix?: ReactNode

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

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

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

    Type declaration

    title?: ReactNode

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

    tooltipPlacement?: PLACEMENT

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

    useClientFilter?: boolean

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

    value?: SelectValue<SelectSingleValueType>

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

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

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

    Type declaration

    viewMode?: FIELD_MODE

    Тип отображения поля

    On This Page

    Properties
    addTextallowClearautoFocuscanAddcanCreatecanSelectAllcreateOptiondata-qaiddata-readonlydefaultValuedropdownMatchSelectWidthdropdownOverflowTypedropdownRefdropdownRendererrorerrorMessagehasBorderhasErrorhasLeaderDotshintinputRefinputRowsModeinputWidthisAllSelectedisDefaultOpenisDisabledisExtraItemsCenteredisHighlightedisMultiLineisOpenisReadOnlyisRequiredisWaitingisWidelabellabelWidthmodemultipleValueRenderermultiValueRenderernamenotFoundContentnotFoundTextonAddonBluronChangeonClearonDeselectonDeselectAllonDropdownVisibleChangeonFocusonPrefixClickonSearchonSelectonSelectAllonSuffixClickoptionRendereroptionsoptionsMaxHeightoverlapButtonplaceholderprefixpreserveValueOrderingrightExtraItemsscrollModeMaxRowsselectAllTextselectedOptionsselectNoneTextshouldBlurOnCloseshowArrowshowPlaceholderWhenDisabledshowSearchsizesortOrdersublabelsuffixtargetRenderertitletooltipPlacementuseClientFiltervaluevalueRendererviewMode