Interface ColorPickerProps

Public

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

Hierarchy

  • Pick<PopoverProps,
        | "target"
        | "onVisibleChange"
        | "onOpen"
        | "onClose"
        | "isOpen"
        | "isDefaultOpen">
    • ColorPickerProps

Properties

colorHex? colorsInPaletteRow? isDefaultOpen? isOpen? onClose? onColorChange? onOpen? onVisibleChange? palette? target

Properties

OptionalcolorHex

colorHex?: string

OptionalcolorsInPaletteRow

colorsInPaletteRow?: number

OptionalisDefaultOpen

isDefaultOpen?: boolean

The window is open by default?

Specifies whether the window should have been opened when creating it. This property is only relevant in unmanaged mode.

OptionalisOpen

isOpen?: boolean

Is the pop-up window open?

If the Boolean type, the component goes into managed mode and opens/closes only when this property is changed from the outside. If undefined, the component is in an unmanaged state mode, and opens/closes according to the internal state.

OptionalonClose

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

Handler for the popup window closing event

OptionalonColorChange

onColorChange?: ColorPickerChangeHandler

OptionalonOpen

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

Handler for the popup window opening event

OptionalonVisibleChange

onVisibleChange?: ((visible: boolean) => void)

Handler for changing the visibility of a window

Optionalpalette

palette?: string[]

target

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

The goal that the popup window will be attached to.

Can be an element or can be set via the Render Props pattern.

On This Page

Properties