These docs describe the main branch, including unreleased changes. Read the 0.6.0 docs.

`@opentui/core/yoga`

Every export of @opentui/core/yoga in the main-branch source, from its type declarations. A version names the release that added an export after the module's first release.

Classes#

class Config

Yoga API

method Config.assertAlive(): void0.6.0
method Config.assertUnused(): void0.6.0
method Config.ensureCallbacks(): void0.6.0
method Config.free(): void
method Config.getErrata(): Errata
method Config.getPointScaleFactor(): number
method Config.isExperimentalFeatureEnabled(feature: ExperimentalFeature): boolean
method Config.setErrata(errata: Errata): void
method Config.setExperimentalFeatureEnabled(feature: ExperimentalFeature, enabled: boolean): void
method Config.setPointScaleFactor(pointScaleFactor: number): void
method Config.setUseWebDefaults(useWebDefaults: boolean): void
method Config.useWebDefaults(): boolean
readonly property Config.dirtied: Map<Pointer, { node: Node; callback: DirtiedFunction; }>0.6.0
readonly property Config.measures: Map<Pointer, MeasureFunction>0.6.0
readonly property Config.nodes: Map<Pointer, Node>0.6.0
readonly property Config.ptr: Pointer
readonly property Config.renderLib: RenderLib0.6.0
static method Config.create(renderLib?: RenderLib): Config
static method Config.destroy(config: Config): void
static method Config.fromBorrowedPointer(ptr: Pointer, renderLib?: RenderLib): Config0.6.0

class Node

Yoga API

method Node.assertMutable(): void0.6.0
method Node.calculateLayout(width?: number | "auto", height?: number | "auto", direction?: Direction): void
method Node.copyStyle(node: Node): void
method Node.free(): void
method Node.freeRecursive(): void
method Node.getAlignContent(): Align
method Node.getAlignItems(): Align
method Node.getAlignSelf(): Align
method Node.getAlwaysFormsContainingBlock(): boolean
method Node.getAspectRatio(): number
method Node.getBorder(edge: Edge): number
method Node.getBoxSizing(): BoxSizing
method Node.getChild(index: number): Node | null
method Node.getChildCount(): number
method Node.getComputedBorder(edge: Edge): number
method Node.getComputedBottom(): number
method Node.getComputedHeight(): number
method Node.getComputedLayout(): Layout
method Node.getComputedLeft(): number
method Node.getComputedMargin(edge: Edge): number
method Node.getComputedPadding(edge: Edge): number
method Node.getComputedRight(): number
method Node.getComputedTop(): number
method Node.getComputedWidth(): number
method Node.getDirection(): Direction
method Node.getDisplay(): Display
method Node.getFlex(): number
method Node.getFlexBasis(): Value
method Node.getFlexDirection(): FlexDirection
method Node.getFlexGrow(): number
method Node.getFlexShrink(): number
method Node.getFlexWrap(): Wrap
method Node.getGap(gutter: Gutter): Value
method Node.getHeight(): Value
method Node.getJustifyContent(): Justify
method Node.getMargin(edge: Edge): Value
method Node.getMaxHeight(): Value
method Node.getMaxWidth(): Value
method Node.getMinHeight(): Value
method Node.getMinWidth(): Value
method Node.getOverflow(): Overflow
method Node.getPadding(edge: Edge): Value
method Node.getParent(): Node | null
method Node.getPosition(edge: Edge): Value
method Node.getPositionType(): PositionType
method Node.getWidth(): Value
method Node.hasMeasureFunc(): boolean
method Node.hasNewLayout(): boolean
method Node.insertChild(child: Node, index: number): void
method Node.isDirty(): boolean
method Node.isFreed(): boolean
method Node.isReferenceBaseline(): boolean
method Node.markDirty(): void
method Node.markLayoutSeen(): void
method Node.removeAllChildren(): void
method Node.removeChild(child: Node): void
method Node.reset(): void
method Node.runMutation<T>(operation: () => T): T0.6.0
method Node.setAlignContent(alignContent: Align): void
method Node.setAlignItems(alignItems: Align): void
method Node.setAlignSelf(alignSelf: Align): void
method Node.setAlwaysFormsContainingBlock(alwaysFormsContainingBlock: boolean): void
method Node.setAspectRatio(aspectRatio: number | undefined): void
method Node.setBorder(edge: Edge, border: number | undefined): void
method Node.setBoxSizing(boxSizing: BoxSizing): void
method Node.setDirection(direction: Direction): void
method Node.setDirtiedFunc(dirtiedFunc: DirtiedFunction | null): void
method Node.setDisplay(display: Display): void
method Node.setFlex(flex: number | undefined): void
method Node.setFlexBasis(flexBasis: ValueInput): void
method Node.setFlexBasisAuto(): void
method Node.setFlexBasisPercent(flexBasis: number | undefined): void
method Node.setFlexDirection(flexDirection: FlexDirection): void
method Node.setFlexGrow(flexGrow: number | undefined): void
method Node.setFlexShrink(flexShrink: number | undefined): void
method Node.setFlexWrap(flexWrap: Wrap): void
method Node.setGap(gutter: Gutter, gap: ValueInputNoAuto): void
method Node.setGapPercent(gutter: Gutter, gap: number | undefined): void
method Node.setHeight(height: ValueInput): void
method Node.setHeightAuto(): void
method Node.setHeightPercent(height: number | undefined): void
method Node.setIsReferenceBaseline(isReferenceBaseline: boolean): void
method Node.setJustifyContent(justifyContent: Justify): void
method Node.setMargin(edge: Edge, margin: ValueInput): void
method Node.setMarginAuto(edge: Edge): void
method Node.setMarginPercent(edge: Edge, margin: number | undefined): void
method Node.setMaxHeight(maxHeight: ValueInputNoAuto): void
method Node.setMaxHeightPercent(maxHeight: number | undefined): void
method Node.setMaxWidth(maxWidth: ValueInputNoAuto): void
method Node.setMaxWidthPercent(maxWidth: number | undefined): void
method Node.setMeasureFunc(measureFunc: MeasureFunction | null): void
method Node.setMinHeight(minHeight: ValueInputNoAuto): void
method Node.setMinHeightPercent(minHeight: number | undefined): void
method Node.setMinWidth(minWidth: ValueInputNoAuto): void
method Node.setMinWidthPercent(minWidth: number | undefined): void
method Node.setOverflow(overflow: Overflow): void
method Node.setPadding(edge: Edge, padding: ValueInputNoAuto): void
method Node.setPaddingPercent(edge: Edge, padding: number | undefined): void
method Node.setPosition(edge: Edge, position: ValueInput): void
method Node.setPositionAuto(edge: Edge): void
method Node.setPositionPercent(edge: Edge, position: number | undefined): void
method Node.setPositionType(positionType: PositionType): void
method Node.setWidth(width: ValueInput): void
method Node.setWidthAuto(): void
method Node.setWidthPercent(width: number | undefined): void
method Node.unsetDirtiedFunc(): void
method Node.unsetMeasureFunc(): void
readonly property Node.ptr: Pointer
static method Node.create(config?: Config): Node
static method Node.createDefault(): Node
static method Node.createForOpenTUI(): Node
static method Node.createWithConfig(config: Config): Node
static method Node.destroy(node: Node): void

class YogaError extends Errorconstructor YogaError(operation: string, status: YogaStatus)

Added in 0.6.0Yoga API

readonly property YogaError.name = "YogaError"0.6.0
readonly property YogaError.operation: string0.6.0
readonly property YogaError.status: YogaStatus0.6.0

Interfaces#

interface Layout

Yoga API

property Layout.bottom: number
property Layout.height: number
property Layout.left: number
property Layout.right: number
property Layout.top: number
property Layout.width: number

interface Size

Yoga API

property Size.height: number
property Size.width: number

interface Value

Yoga API

property Value.unit: Unit
property Value.value: number

Types#

type DirtiedFunction = (node: Node) => void: Yoga API
type MeasureFunction = (width: number, widthMode: MeasureMode, height: number, heightMode: MeasureMode) => Size: Yoga API

Enums#

enum Align

Yoga API

enum-member Align.Auto
enum-member Align.Baseline
enum-member Align.Center
enum-member Align.FlexEnd
enum-member Align.FlexStart
enum-member Align.SpaceAround
enum-member Align.SpaceBetween
enum-member Align.SpaceEvenly
enum-member Align.Stretch

enum BoxSizing

Yoga API

enum-member BoxSizing.BorderBox
enum-member BoxSizing.ContentBox

enum Dimension

Yoga API

enum-member Dimension.Height
enum-member Dimension.Width

enum Direction

Yoga API

enum-member Direction.Inherit
enum-member Direction.LTR
enum-member Direction.RTL

enum Display

Yoga API

enum-member Display.Contents = 2
enum-member Display.Flex = 0
enum-member Display.None = 1

enum Edge

Yoga API

enum-member Edge.All
enum-member Edge.Bottom
enum-member Edge.End
enum-member Edge.Horizontal
enum-member Edge.Left
enum-member Edge.Right
enum-member Edge.Start
enum-member Edge.Top
enum-member Edge.Vertical

enum Errata

Yoga API

enum-member Errata.AbsolutePercentAgainstInnerSize = 4
enum-member Errata.AbsolutePositionWithoutInsetsExcludesPadding = 2
enum-member Errata.All = 2147483647
enum-member Errata.Classic = 2147483646
enum-member Errata.None = 0
enum-member Errata.StretchFlexBasis = 1

enum ExperimentalFeature

Yoga API

enum-member ExperimentalFeature.WebFlexBasis = 0

enum FlexDirection

Yoga API

enum-member FlexDirection.Column
enum-member FlexDirection.ColumnReverse
enum-member FlexDirection.Row
enum-member FlexDirection.RowReverse

enum Gutter

Yoga API

enum-member Gutter.All
enum-member Gutter.Column
enum-member Gutter.Row

enum Justify

Yoga API

enum-member Justify.Center
enum-member Justify.FlexEnd
enum-member Justify.FlexStart
enum-member Justify.SpaceAround
enum-member Justify.SpaceBetween
enum-member Justify.SpaceEvenly

enum LogLevel

Yoga API

enum-member LogLevel.Debug = 3
enum-member LogLevel.Error = 0
enum-member LogLevel.Fatal = 5
enum-member LogLevel.Info = 2
enum-member LogLevel.Verbose = 4
enum-member LogLevel.Warn = 1

enum MeasureMode

Yoga API

enum-member MeasureMode.AtMost
enum-member MeasureMode.Exactly
enum-member MeasureMode.Undefined

enum NodeType

Yoga API

enum-member NodeType.Default = 0
enum-member NodeType.Text = 1

enum Overflow

Yoga API

enum-member Overflow.Hidden
enum-member Overflow.Scroll
enum-member Overflow.Visible

enum PositionType

Yoga API

enum-member PositionType.Absolute
enum-member PositionType.Relative
enum-member PositionType.Static

enum Unit

Yoga API

enum-member Unit.Auto
enum-member Unit.Percent
enum-member Unit.Point
enum-member Unit.Undefined

enum Wrap

Yoga API

enum-member Wrap.NoWrap
enum-member Wrap.Wrap
enum-member Wrap.WrapReverse

enum YogaStatus

Added in 0.6.0Yoga API

enum-member YogaStatus.Busy = 50.6.0
enum-member YogaStatus.DepthLimit = 60.6.0
enum-member YogaStatus.Exception = 30.6.0
enum-member YogaStatus.InvalidArgument = 10.6.0
enum-member YogaStatus.Ok = 00.6.0
enum-member YogaStatus.OutOfMemory = 20.6.0
enum-member YogaStatus.Poisoned = 40.6.0

Constants and variables#

const ALIGN_AUTO = Align.Auto: Yoga API
const ALIGN_BASELINE = Align.Baseline: Yoga API
const ALIGN_CENTER = Align.Center: Yoga API
const ALIGN_FLEX_END = Align.FlexEnd: Yoga API
const ALIGN_FLEX_START = Align.FlexStart: Yoga API
const ALIGN_SPACE_AROUND = Align.SpaceAround: Yoga API
const ALIGN_SPACE_BETWEEN = Align.SpaceBetween: Yoga API
const ALIGN_SPACE_EVENLY = Align.SpaceEvenly: Yoga API
const ALIGN_STRETCH = Align.Stretch: Yoga API
const BOX_SIZING_BORDER_BOX = BoxSizing.BorderBox: Yoga API
const BOX_SIZING_CONTENT_BOX = BoxSizing.ContentBox: Yoga API
const default: { Config: typeof Config; Node: typeof Node; Align: typeof Align; BoxSizing: typeof BoxSizing; Dimension: typeof Dimension; Direction: typeof Direction; Display: typeof Display; Edge: typeof Edge; Errata: typeof Errata; ExperimentalFeature: typeof ExperimentalFeature; FlexDirection: typeof FlexDirection; Gutter: typeof Gutter; Justify: typeof Justify; LogLevel: typeof LogLevel; MeasureMode: typeof MeasureMode; NodeType: typeof NodeType; Overflow: typeof Overflow; PositionType: typeof PositionType; Unit: typeof Unit; Wrap: typeof Wrap; ALIGN_AUTO: Align; ALIGN_FLEX_START: Align; ALIGN_CENTER: Align; ALIGN_FLEX_END: Align; ALIGN_STRETCH: Align; ALIGN_BASELINE: Align; ALIGN_SPACE_BETWEEN: Align; ALIGN_SPACE_AROUND: Align; ALIGN_SPACE_EVENLY: Align; BOX_SIZING_BORDER_BOX: BoxSizing; BOX_SIZING_CONTENT_BOX: BoxSizing; DIMENSION_WIDTH: Dimension; DIMENSION_HEIGHT: Dimension; DIRECTION_INHERIT: Direction; DIRECTION_LTR: Direction; DIRECTION_RTL: Direction; DISPLAY_FLEX: Display; DISPLAY_NONE: Display; DISPLAY_CONTENTS: Display; EDGE_LEFT: Edge; EDGE_TOP: Edge; EDGE_RIGHT: Edge; EDGE_BOTTOM: Edge; EDGE_START: Edge; EDGE_END: Edge; EDGE_HORIZONTAL: Edge; EDGE_VERTICAL: Edge; EDGE_ALL: Edge; ERRATA_NONE: Errata; ERRATA_STRETCH_FLEX_BASIS: Errata; ERRATA_ABSOLUTE_POSITION_WITHOUT_INSETS_EXCLUDES_PADDING: Errata; ERRATA_ABSOLUTE_PERCENT_AGAINST_INNER_SIZE: Errata; ERRATA_ALL: Errata; ERRATA_CLASSIC: Errata; EXPERIMENTAL_FEATURE_WEB_FLEX_BASIS: ExperimentalFeature; FLEX_DIRECTION_COLUMN: FlexDirection; FLEX_DIRECTION_COLUMN_REVERSE: FlexDirection; FLEX_DIRECTION_ROW: FlexDirection; FLEX_DIRECTION_ROW_REVERSE: FlexDirection; GUTTER_COLUMN: Gutter; GUTTER_ROW: Gutter; GUTTER_ALL: Gutter; JUSTIFY_FLEX_START: Justify; JUSTIFY_CENTER: Justify; JUSTIFY_FLEX_END: Justify; JUSTIFY_SPACE_BETWEEN: Justify; JUSTIFY_SPACE_AROUND: Justify; JUSTIFY_SPACE_EVENLY: Justify; LOG_LEVEL_ERROR: LogLevel; LOG_LEVEL_WARN: LogLevel; LOG_LEVEL_INFO: LogLevel; LOG_LEVEL_DEBUG: LogLevel; LOG_LEVEL_VERBOSE: LogLevel; LOG_LEVEL_FATAL: LogLevel; MEASURE_MODE_UNDEFINED: MeasureMode; MEASURE_MODE_EXACTLY: MeasureMode; MEASURE_MODE_AT_MOST: MeasureMode; NODE_TYPE_DEFAULT: NodeType; NODE_TYPE_TEXT: NodeType; OVERFLOW_VISIBLE: Overflow; OVERFLOW_HIDDEN: Overflow; OVERFLOW_SCROLL: Overflow; POSITION_TYPE_STATIC: PositionType; POSITION_TYPE_RELATIVE: PositionType; POSITION_TYPE_ABSOLUTE: PositionType; UNIT_UNDEFINED: Unit; UNIT_POINT: Unit; UNIT_PERCENT: Unit; UNIT_AUTO: Unit; WRAP_NO_WRAP: Wrap; WRAP_WRAP: Wrap; WRAP_WRAP_REVERSE: Wrap; }: Yoga API
const DIMENSION_HEIGHT = Dimension.Height: Yoga API
const DIMENSION_WIDTH = Dimension.Width: Yoga API
const DIRECTION_INHERIT = Direction.Inherit: Yoga API
const DIRECTION_LTR = Direction.LTR: Yoga API
const DIRECTION_RTL = Direction.RTL: Yoga API
const DISPLAY_CONTENTS = Display.Contents: Yoga API
const DISPLAY_FLEX = Display.Flex: Yoga API
const DISPLAY_NONE = Display.None: Yoga API
const EDGE_ALL = Edge.All: Yoga API
const EDGE_BOTTOM = Edge.Bottom: Yoga API
const EDGE_END = Edge.End: Yoga API
const EDGE_HORIZONTAL = Edge.Horizontal: Yoga API
const EDGE_LEFT = Edge.Left: Yoga API
const EDGE_RIGHT = Edge.Right: Yoga API
const EDGE_START = Edge.Start: Yoga API
const EDGE_TOP = Edge.Top: Yoga API
const EDGE_VERTICAL = Edge.Vertical: Yoga API
const ERRATA_ABSOLUTE_PERCENT_AGAINST_INNER_SIZE = Errata.AbsolutePercentAgainstInnerSize: Yoga API
const ERRATA_ABSOLUTE_POSITION_WITHOUT_INSETS_EXCLUDES_PADDING = Errata.AbsolutePositionWithoutInsetsExcludesPadding: Yoga API
const ERRATA_ALL = Errata.All: Yoga API
const ERRATA_CLASSIC = Errata.Classic: Yoga API
const ERRATA_NONE = Errata.None: Yoga API
const ERRATA_STRETCH_FLEX_BASIS = Errata.StretchFlexBasis: Yoga API
const EXPERIMENTAL_FEATURE_WEB_FLEX_BASIS = ExperimentalFeature.WebFlexBasis: Yoga API
const FLEX_DIRECTION_COLUMN = FlexDirection.Column: Yoga API
const FLEX_DIRECTION_COLUMN_REVERSE = FlexDirection.ColumnReverse: Yoga API
const FLEX_DIRECTION_ROW = FlexDirection.Row: Yoga API
const FLEX_DIRECTION_ROW_REVERSE = FlexDirection.RowReverse: Yoga API
const GUTTER_ALL = Gutter.All: Yoga API
const GUTTER_COLUMN = Gutter.Column: Yoga API
const GUTTER_ROW = Gutter.Row: Yoga API
const JUSTIFY_CENTER = Justify.Center: Yoga API
const JUSTIFY_FLEX_END = Justify.FlexEnd: Yoga API
const JUSTIFY_FLEX_START = Justify.FlexStart: Yoga API
const JUSTIFY_SPACE_AROUND = Justify.SpaceAround: Yoga API
const JUSTIFY_SPACE_BETWEEN = Justify.SpaceBetween: Yoga API
const JUSTIFY_SPACE_EVENLY = Justify.SpaceEvenly: Yoga API
const LOG_LEVEL_DEBUG = LogLevel.Debug: Yoga API
const LOG_LEVEL_ERROR = LogLevel.Error: Yoga API
const LOG_LEVEL_FATAL = LogLevel.Fatal: Yoga API
const LOG_LEVEL_INFO = LogLevel.Info: Yoga API
const LOG_LEVEL_VERBOSE = LogLevel.Verbose: Yoga API
const LOG_LEVEL_WARN = LogLevel.Warn: Yoga API
const MEASURE_MODE_AT_MOST = MeasureMode.AtMost: Yoga API
const MEASURE_MODE_EXACTLY = MeasureMode.Exactly: Yoga API
const MEASURE_MODE_UNDEFINED = MeasureMode.Undefined: Yoga API
const NODE_TYPE_DEFAULT = NodeType.Default: Yoga API
const NODE_TYPE_TEXT = NodeType.Text: Yoga API
const OVERFLOW_HIDDEN = Overflow.Hidden: Yoga API
const OVERFLOW_SCROLL = Overflow.Scroll: Yoga API
const OVERFLOW_VISIBLE = Overflow.Visible: Yoga API
const POSITION_TYPE_ABSOLUTE = PositionType.Absolute: Yoga API
const POSITION_TYPE_RELATIVE = PositionType.Relative: Yoga API
const POSITION_TYPE_STATIC = PositionType.Static: Yoga API
const UNIT_AUTO = Unit.Auto: Yoga API
const UNIT_PERCENT = Unit.Percent: Yoga API
const UNIT_POINT = Unit.Point: Yoga API
const UNIT_UNDEFINED = Unit.Undefined: Yoga API
const WRAP_NO_WRAP = Wrap.NoWrap: Yoga API
const WRAP_WRAP = Wrap.Wrap: Yoga API
const WRAP_WRAP_REVERSE = Wrap.WrapReverse: Yoga API