Interface ButtonProps

interface ButtonProps {
    additionalEvents?: Partial<Record<GenericEvents, DomBuilderEventHandler | DomBuilderEventHandlerWithOptions>>;
    attributes?: Record<string, string>;
    border?: boolean;
    children?: (string | HTMLElement | ExtendedHTMLElement)[];
    classNames?: string[];
    confirmation?: {
        cancelButtonText: string;
        confirmButtonText: string;
        description?: string;
        title: string;
    };
    disabled?: boolean;
    fillState?: "hover" | "always";
    hidden?: boolean;
    icon?: HTMLElement | ExtendedHTMLElement;
    label?: string | HTMLElement | ExtendedHTMLElement;
    onClick: ((e) => void);
    onHover?: ((e) => void);
    primary?: boolean;
    status?: "info" | "warning" | "error" | "success" | "main" | "primary" | "clear" | "dimmed-clear";
    testId?: string;
    tooltip?: string;
    tooltipHorizontalDirection?: OverlayHorizontalDirection;
    tooltipVerticalDirection?: OverlayVerticalDirection;
}

Properties

additionalEvents? attributes? border? children? classNames? confirmation? disabled? fillState? hidden? icon? label? onClick onHover? primary? status? testId? tooltip? tooltipHorizontalDirection? tooltipVerticalDirection?

Properties

Optional additionalEvents

additionalEvents?: Partial<Record<GenericEvents, DomBuilderEventHandler | DomBuilderEventHandlerWithOptions>>

Optional attributes

attributes?: Record<string, string>

Optional border

border?: boolean

Optional children

children?: (string | HTMLElement | ExtendedHTMLElement)[]

Optional classNames

classNames?: string[]

Optional confirmation

confirmation?: {
    cancelButtonText: string;
    confirmButtonText: string;
    description?: string;
    title: string;
}

Type declaration

  • cancelButtonText: string
  • confirmButtonText: string
  • Optional description?: string
  • title: string

Optional disabled

disabled?: boolean

Optional fillState

fillState?: "hover" | "always"

Optional hidden

hidden?: boolean

Optional icon

icon?: HTMLElement | ExtendedHTMLElement

Optional label

label?: string | HTMLElement | ExtendedHTMLElement

onClick

onClick: ((e) => void)

Type declaration

    • (e): void

    • Parameters

      • e: Event

      Returns void

Optional onHover

onHover?: ((e) => void)

Type declaration

    • (e): void

    • Parameters

      • e: Event

      Returns void

Optional primary

primary?: boolean

Optional status

status?: "info" | "warning" | "error" | "success" | "main" | "primary" | "clear" | "dimmed-clear"

Optional testId

testId?: string

Optional tooltip

tooltip?: string

Optional tooltipHorizontalDirection

tooltipHorizontalDirection?: OverlayHorizontalDirection

Optional tooltipVerticalDirection

tooltipVerticalDirection?: OverlayVerticalDirection

Settings

Member Visibility

Theme

On This Page

additionalEventsattributesborderchildrenclassNamesconfirmationdisabledfillStatehiddeniconlabelonClickonHoverprimarystatustestIdtooltiptooltipHorizontalDirectiontooltipVerticalDirection