The parameters for creating a button element.
See UIButtonElement for more details.
id is optional but recommended if you want to be able to perform updates.
type: "Button"
label: string
The label to display in the button.
onClick: (args: { id: string; }) => void
The action to perform when the button is clicked.
The arguments passed to the function.
void
optional variant: "filled" | "transparent" | "outlined"
The style variant of the button.
"filled": a button with background.
background color is based on button's tint (defaults to default tint)
"transparent": a transparent button that gets a subtle dark background when hovered.
text color is based on button's tint (defaults to default tint)
"outlined": a transparent button with a border.
text and border colors are based on button's tint (defaults to default tint)
"filled"
optional tint: "default" | "primary" | "accent" | "danger"
The tint of the button.
"default": Felt's theme-based light/dark colors.
"primary": Felt's primary color (pink).
"accent": Felt's accent color (blue).
"danger": Felt's danger color (red).
"default"
optional disabled: boolean
Whether the button is disabled.
false
optional onCreate: (args: { id: string; }) => void
A function to call when the element is created.
The arguments passed to the function.
void
optional onDestroy: (args: { id: string; }) => void
A function to call when the element is destroyed.
The arguments passed to the function.
void
optional id: string
The ID of the element.
If not provided, the element will be assigned a random ID, but it is recommended to provide it to perform further updates on the element.
If provided, it must be unique within the UI.
undefined
Last updated
