Skip to main content

Interface: ButtonWidgetSettings

Configuration for button widget appearance and behavior.

ButtonWidgetSettings defines the visual styling and layout properties for button widget. These settings control how it appears and responds to user interaction in the configurator interface.

Properties​

backgroundColor?​

optional backgroundColor: string

Optional custom background color for the button. Only used when buttonColor is set to CUSTOM. Overrides the default background color when specified.

backgroundColorHover?​

optional backgroundColorHover: string

Optional custom background color for the button on hover state. Only used when buttonColor is set to CUSTOM. Applied when user hovers over the button, providing visual feedback for interaction.

borderColor?​

optional borderColor: string

Optional custom border color for the button. Only used when buttonColor is set to CUSTOM. Primarily relevant for OUTLINED button variant.

borderColorHover?​

optional borderColorHover: string

Optional custom border color for the button on hover state. Only used when buttonColor is set to CUSTOM. Applied when user hovers over the button, providing visual feedback for interaction.

buttonColor​

buttonColor: ButtonColor

Color scheme for the button. Determines whether to use predefined theme colors or custom color values. When set to CUSTOM, the custom color properties below become active.

cssClass?​

optional cssClass: string

Optional custom CSS class to apply to the button. Allows for additional styling beyond standard button properties.

eventName?​

optional eventName: string

Name of the custom event which will be triggered upon button click. This event can be listened to for executing custom business logic or workflows.

shape​

shape: ButtonShape

Visual shape style of the button. Determines corner rounding and overall button appearance.

size​

size: ButtonSizeType

Size of the button. Controls button height and padding for different interface contexts.

textColor?​

optional textColor: string

Optional custom text color for the button label. Only used when buttonColor is set to CUSTOM. Overrides the default text color when specified.

textColorHover?​

optional textColorHover: string

Optional custom text color for the button label on hover state. Only used when buttonColor is set to CUSTOM. Applied when user hovers over the button, providing visual feedback for interaction.

uppercase?​

optional uppercase: boolean

If true, text at button will be converted to uppercase. Provides consistent text styling across button instances.

variant​

variant: ButtonVariantType

Visual style variant of the button. Controls background, border, and overall prominence through outlined, contained, or text-only styling.

width​

width: ButtonWidth

Horizontal space occupied by the button. Controls whether buttons use single or double column width in grid layouts.