Interface UiButtonProps

Button Component Props

Hierarchy

Properties

color? disabled? font? fontSize? key? onMouseDown? onMouseEnter? onMouseLeave? onMouseUp? textAlign? textWrap? uiBackground? uiTransform? value variant?

Properties

Optional color

color?: PBColor4

Color of the label.

Default Value

{ r: 1, g: 1, b: 1, a: 1 }

Optional disabled

disabled?: boolean

Enable or disable the pointer events on the button

Optional font

font?: UiFontType

Label font type.

Default Value

'sans-serif'

Optional fontSize

fontSize?: ScaleUnit

Label font size.

Default Value

10

Optional key

key?: Key

Uinique key to identiy elments when iterating arrays

Optional onMouseDown

onMouseDown?: Callback

triggered on mouse down event

Optional onMouseEnter

onMouseEnter?: Callback

triggered on mouse hover event

Optional onMouseLeave

onMouseLeave?: Callback

triggered on mouse leave event

Optional onMouseUp

onMouseUp?: Callback

triggered on mouse up event

Optional textAlign

textAlign?: TextAlignType

Label align position.

Default Value

'middle-center'

Optional textWrap

textWrap?: UiTextWrapType

Behaviour when text reached.

Default Value

'wrap'

Optional uiBackground

uiBackground?: UiBackgroundProps

To define a background color or image

Optional uiTransform

uiTransform?: UiTransformProps

Layout component, to position things in the canvas

value

value: string

Primary content.

Optional variant

variant?: "primary" | "secondary"

Use any of the available button style types to create a styled button.

Settings

Member Visibility

Theme