Interface CardHeaderSelectableActionsObject

interface CardHeaderSelectableActionsObject {
    className?: string;
    hasNoOffset?: boolean;
    isChecked?: boolean;
    isExternalLink?: boolean;
    name?: string;
    onChange?: ((event: FormEvent<HTMLInputElement>, checked: boolean) => void);
    onClickAction?: ((event: MouseEvent<Element, MouseEvent> | FormEvent<HTMLInputElement>) => void);
    selectableActionAriaLabel?: string;
    selectableActionAriaLabelledby?: string;
    selectableActionId: string;
    to?: string;
    variant?: "multiple" | "single";
}

Properties

className? hasNoOffset? isChecked? isExternalLink? name? onChange? onClickAction? selectableActionAriaLabel? selectableActionAriaLabelledby? selectableActionId to? variant?

Properties

OptionalclassName

className?: string

Additional classes added to the selectable actions wrapper

OptionalhasNoOffset

hasNoOffset?: boolean

Flag indicating that the actions have no offset

OptionalisChecked

isChecked?: boolean

Deprecated

Flag indicating whether the selectable card input is checked. We recommend using the isSelected prop on the card component instead.

OptionalisExternalLink

isExternalLink?: boolean

Flag to indicate whether a clickable card's link should open in a new tab/window.

Optionalname

name?: string

Name for the input element of a clickable or selectable card.

OptionalonChange

onChange?: ((event: FormEvent<HTMLInputElement>, checked: boolean) => void)

Callback for when a selectable card input changes

OptionalonClickAction

onClickAction?: ((event: MouseEvent<Element, MouseEvent> | FormEvent<HTMLInputElement>) => void)

Action to call when clickable card is clicked

OptionalselectableActionAriaLabel

selectableActionAriaLabel?: string

Adds an accessible label to the selectable or clickable input

OptionalselectableActionAriaLabelledby

selectableActionAriaLabelledby?: string

Adds an accessible label to the selectable or clickable input by passing in a space separated list of id's.

selectableActionId

selectableActionId: string

ID passed to the selectable or clickable input

Optionalto

to?: string

Link to navigate to when clickable card is clicked

Optionalvariant

variant?: "multiple" | "single"

Determines the type of input to be used for a selectable card.

Settings

Member Visibility

On This Page

Properties