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

Интерфейс ColorPickerProps

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

interface ColorPickerProps {
    colorHex?: string;
    colorsInPaletteRow?: number;
    isDefaultOpen?: boolean;
    isOpen?: boolean;
    onClose?: (e: Event | SyntheticEvent<Element, Event>) => void;
    onColorChange?: ColorPickerChangeHandler;
    onOpen?: (e: SyntheticEvent<Element>) => void;
    onVisibleChange?: (visible: boolean) => void;
    palette?: string[];
    target:
        | ((renderProps: Required<PopoverTargetProps>) => ReactNode)
        | ReactElement<PopoverTargetProps, string | JSXElementConstructor<any>>;
}

Иерархия

  • Pick<
        PopoverProps,
        | "target"
        | "onVisibleChange"
        | "onOpen"
        | "onClose"
        | "isOpen"
        | "isDefaultOpen",
    >
    • ColorPickerProps
Индекс

Свойства

colorHex?: string

Текущий цвет в формате HEX.

colorsInPaletteRow?: number

Количество цветов в одной строке палитры.

isDefaultOpen?: boolean

Признак, что окно открыто по умолчанию. Актуально в неуправляемом состоянии.

isOpen?: boolean

Признак, что всплывающее окно открыто. Если тип - Boolean, то компонент управляется извне: открывается/закрывается только при изменении этого свойства. Если не задано, компонент находится в неуправляемом состоянии.

onClose?: (e: Event | SyntheticEvent<Element, Event>) => void

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

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

    • (e: Event | SyntheticEvent<Element, Event>): void
    • Параметры

      Возвращает void

onColorChange?: ColorPickerChangeHandler

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

Новый цвет.

Событие изменения.

onOpen?: (e: SyntheticEvent<Element>) => void

Обработчик события открытия окна.

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

onVisibleChange?: (visible: boolean) => void

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

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

    • (visible: boolean): void
    • Параметры

      • visible: boolean

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

      Возвращает void

palette?: string[]

Массив доступных цветов в палитре.

target:
    | ((renderProps: Required<PopoverTargetProps>) => ReactNode)
    | ReactElement<PopoverTargetProps, string | JSXElementConstructor<any>>

Целевой элемент или функция рендера (Render Props).

Свойства целевого элемента.