x4js - v2.3.17
    Preparing search index...

    Interface ColorInputProps

    interface ColorInputProps {
        attrs?: Record<string, string | number | boolean>;
        change?: EventCallback<EvColorChange>;
        cls?: string;
        color: string | Color;
        content?: ComponentContent;
        disabled?: boolean;
        dom_events?: GlobalDOMEvents;
        existingDOM?: HTMLElement;
        flex?: number | boolean;
        format?: "rgb" | "hex";
        height?: string | number;
        hidden?: boolean;
        id?: string;
        name?: string;
        ns?: string;
        nullable?: boolean;
        picker?: boolean;
        stretch?: boolean;
        style?: StyleProps;
        swatches?: Swatches | (() => Swatches);
        tag?: string;
        tooltip?: string;
        width?: string | number;
    }

    Hierarchy (View Summary)

    Index
    attrs? change? cls? color content? disabled? dom_events? existingDOM? flex? format? height? hidden? id? name? ns? nullable? picker? stretch? style? swatches? tag? tooltip? width?
    attrs?: Record<string, string | number | boolean>

    HTML attributes.

    change?: EventCallback<EvColorChange>

    The user changed the color (not fired by setColor).

    cls?: string

    Additional CSS classes.

    color: string | Color

    The color at start. null: no color is shown.

    Optionalcontent

    content?: ComponentContent

    Child content (components, strings, or HTML).

    disabled?: boolean

    Component is initialy disabled.

    dom_events?: GlobalDOMEvents

    DOM event listeners.

    existingDOM?: HTMLElement

    Existing DOM element to wrap.

    flex?: number | boolean

    Enables flex layout (boolean) or sets flex-grow (number).

    format?: "rgb" | "hex"

    How the field writes the color. "rgb" by default: rgb(r,g,b). "hex": #rrggbb.

    height?: string | number

    Height (px or string like "50%").

    hidden?: boolean

    Component is initialy hidden.

    id?: string

    Element ID.

    name?: string

    Name of the field: with it, a Form reads and writes the color (as "#rrggbb").

    ns?: string

    Namespace for SVG/MathML elements.

    nullable?: boolean

    The field may have no color: emptied, or "no color" picked.

    picker?: boolean

    A click on the swatch opens a color picker.

    stretch?: boolean
    style?: StyleProps

    Inline CSS styles.

    swatches?: Swatches | (() => Swatches)

    Colors offered in the picker. A function is called each time the picker opens: the list may change with time.

    tag?: string

    Optional HTML tag to use for the box.

    tooltip?: string

    Tooltip text.

    width?: string | number

    Width (px or string like "50%" or "3em").

    Settings
    Member Visibility

    On This Page
    Properties