PixiFancyButtonProps

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

Props for PixiFancyButton.

Extends

• LayoutProps.ConsumeInputProps

Properties

alignSelf?

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

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

Inherited from

LayoutProps.alignSelf

---

anchor?

optional anchor?: number

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

---

animations?

optional animations?: FancyButtonAnimations

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

---

bottom?

optional bottom?: PositionValue

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

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

Inherited from

LayoutProps.bottom

---

consumeInput?

optional consumeInput?: boolean

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

Inherited from

ConsumeInputProps.consumeInput

---

defaultView?

optional defaultView?: PixiViewType

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

---

disabled?

optional disabled?: boolean

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

---

disabledView?

optional disabledView?: PixiViewType

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

---

flex?

optional flex?: number

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

Shorthand for the common CSS flex: <number> case — expands to flexGrow: <number>, flexShrink: 1, flexBasis: 0. Use it for a child that should fill the remaining main-axis space (e.g. the text column between a fixed icon and a fixed button): sizing from a 0 basis means it won’t claim its content width and push its siblings, and its text wraps cleanly. Prefer this over flexGrow: 1 alone, which keeps flexBasis: auto (content width) and overflows. Explicit flexGrow/flexShrink/flexBasis override the parts this expands to.

Inherited from

LayoutProps.flex

---

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

---

hoverView?

optional hoverView?: PixiViewType

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

---

icon?

optional icon?: DisplayContainer

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

---

left?

optional left?: PositionValue

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

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

---

nineSliceSprite?

optional nineSliceSprite?: [number, number, number, number]

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

---

onClick?

optional onClick?: () => void

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

Returns

void

---

padding?

optional padding?: number

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

---

position?

optional position?: "relative" | "absolute"

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

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

---

pressedView?

optional pressedView?: PixiViewType

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

---

right?

optional right?: PositionValue

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

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

Inherited from

LayoutProps.right

---

scale?

optional scale?: number

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

---

text?

optional text?: string

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

---

textOffset?

optional textOffset?: object & object

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

Type Declaration

x?

optional x?: number

y?

optional y?: number

Type Declaration

default?

optional default?: object

default.x?

optional x?: number

default.y?

optional y?: number

disabled?

optional disabled?: object

disabled.x?

optional x?: number

disabled.y?

optional y?: number

hover?

optional hover?: object

hover.x?

optional x?: number

hover.y?

optional y?: number

pressed?

optional pressed?: object

pressed.x?

optional x?: number

pressed.y?

optional y?: number

---

textStyle?

optional textStyle?: Partial<TextStyleOptions>

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

---

top?

optional top?: PositionValue

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

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:164

Inherited from

LayoutProps.visible

---

width?

optional width?: LayoutValue

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

Inherited from

LayoutProps.width