UIButtonProps

Defined in: ui/src/types.ts:257

Props for UIButton (used by reconciler and props-driven constructor).

Extends

• LayoutProps.ConsumeInputProps.PointerEventProps

Properties

alignSelf?

optional alignSelf?: "stretch" | "auto" | "flex-start" | "center" | "flex-end" | "baseline"

Defined in: ui/src/types.ts:126

Inherited from

LayoutProps.alignSelf

---

background?

optional background?: BackgroundOptions

Defined in: ui/src/types.ts:263

---

bottom?

optional bottom?: PositionValue

Defined in: ui/src/types.ts:152

Offset from the containing block’s bottom edge — px or "<n>%" (only applies to position: "absolute").

Inherited from

LayoutProps.bottom

---

children?

optional children?: string

Defined in: ui/src/types.ts:261

---

consumeInput?

optional consumeInput?: boolean

Defined in: ui/src/types.ts:198

Inherited from

ConsumeInputProps.consumeInput

---

disabled?

optional disabled?: boolean

Defined in: ui/src/types.ts:267

---

flexBasis?

optional flexBasis?: LayoutValue

Defined in: ui/src/types.ts:125

Inherited from

LayoutProps.flexBasis

---

flexGrow?

optional flexGrow?: number

Defined in: ui/src/types.ts:123

Inherited from

LayoutProps.flexGrow

---

flexShrink?

optional flexShrink?: number

Defined in: ui/src/types.ts:124

Inherited from

LayoutProps.flexShrink

---

height?

optional height?: LayoutValue

Defined in: ui/src/types.ts:115

Inherited from

LayoutProps.height

---

hoverBackground?

optional hoverBackground?: BackgroundOptions

Defined in: ui/src/types.ts:264

---

left?

optional left?: PositionValue

Defined in: ui/src/types.ts:146

Offset from the containing block’s left edge — px or "<n>%" (only applies to position: "absolute").

Inherited from

LayoutProps.left

---

margin?

optional margin?: number | { bottom?: number; left?: number; right?: number; top?: number; }

Defined in: ui/src/types.ts:120

Inherited from

LayoutProps.margin

---

maxHeight?

optional maxHeight?: LayoutValue

Defined in: ui/src/types.ts:119

Inherited from

LayoutProps.maxHeight

---

maxWidth?

optional maxWidth?: LayoutValue

Defined in: ui/src/types.ts:117

Inherited from

LayoutProps.maxWidth

---

minHeight?

optional minHeight?: LayoutValue

Defined in: ui/src/types.ts:118

Inherited from

LayoutProps.minHeight

---

minWidth?

optional minWidth?: LayoutValue

Defined in: ui/src/types.ts:116

Inherited from

LayoutProps.minWidth

---

onClick?

optional onClick?: () => void

Defined in: ui/src/types.ts:262

Returns

void

---

onHover?

optional onHover?: (hovering) => void

Defined in: ui/src/types.ts:220

Parameters

hovering

boolean

Returns

void

Inherited from

PointerEventProps.onHover

---

onPointerOut?

optional onPointerOut?: () => void

Defined in: ui/src/types.ts:219

Returns

void

Inherited from

PointerEventProps.onPointerOut

---

onPointerOver?

optional onPointerOver?: () => void

Defined in: ui/src/types.ts:218

Returns

void

Inherited from

PointerEventProps.onPointerOver

---

position?

optional position?: "relative" | "absolute"

Defined in: ui/src/types.ts:144

Positioning mode for this element relative to its parent. Defaults to "relative" — the element flows in the parent’s flex layout. Set to "absolute" to lift the element out of the flow and pin it via left / top / right / bottom against the parent’s content box.

A position: "relative" ancestor acts as the containing block for any absolute-positioned descendants — useful for HUD overlays, modal backdrops, and badge markers. See <ZStack> in @yagejs/ui-react for an opinionated overlay primitive.

Inherited from

LayoutProps.position

---

pressBackground?

optional pressBackground?: BackgroundOptions

Defined in: ui/src/types.ts:265

---

right?

optional right?: PositionValue

Defined in: ui/src/types.ts:150

Offset from the containing block’s right edge — px or "<n>%" (only applies to position: "absolute").

Inherited from

LayoutProps.right

---

textStyle?

optional textStyle?: Partial<TextStyleOptions>

Defined in: ui/src/types.ts:266

---

top?

optional top?: PositionValue

Defined in: ui/src/types.ts:148

Offset from the containing block’s top edge — px or "<n>%" (only applies to position: "absolute").

Inherited from

LayoutProps.top

---

visible?

optional visible?: boolean

Defined in: ui/src/types.ts:153

Inherited from

LayoutProps.visible

---

width?

optional width?: LayoutValue

Defined in: ui/src/types.ts:114

Inherited from

LayoutProps.width