Skip to content

PixiCheckboxProps

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

Props for PixiCheckbox.

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

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

LayoutProps.alignSelf


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").

LayoutProps.bottom


optional checked?: boolean

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


checkedView: PixiViewType

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


optional consumeInput?: boolean

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

ConsumeInputProps.consumeInput


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.

LayoutProps.flex


optional flexBasis?: LayoutValue

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

LayoutProps.flexBasis


optional flexGrow?: number

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

LayoutProps.flexGrow


optional flexShrink?: number

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

LayoutProps.flexShrink


optional height?: LayoutValue

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

LayoutProps.height


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").

LayoutProps.left


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

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

LayoutProps.margin


optional maxHeight?: LayoutValue

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

LayoutProps.maxHeight


optional maxWidth?: LayoutValue

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

LayoutProps.maxWidth


optional minHeight?: LayoutValue

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

LayoutProps.minHeight


optional minWidth?: LayoutValue

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

LayoutProps.minWidth


optional onChange?: (checked) => void

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

boolean

void


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.

LayoutProps.position


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").

LayoutProps.right


optional text?: string

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


optional textOffset?: object

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

optional x?: number

optional y?: number


optional textStyle?: Partial<TextStyleOptions>

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


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").

LayoutProps.top


uncheckedView: PixiViewType

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


optional visible?: boolean

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

LayoutProps.visible


optional width?: LayoutValue

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

LayoutProps.width