yoga.ts
ink/layout/yoga.ts
309
Lines
7400
Bytes
2
Exports
2
Imports
10
Keywords
What this is
This page documents one file from the repository and includes its full source so you can read it without leaving the docs site.
Beginner explanation
This file is one piece of the larger system. Its name, directory, imports, and exports show where it fits. Start by reading the exports and related files first.
How it is used
Start from the exports list and related files. Those are the easiest clues for where this file fits into the system.
Expert explanation
Architecturally, this file intersects with ui-flow. It contains 309 lines, 2 detected imports, and 2 detected exports.
Important relationships
Detected exports
YogaLayoutNodecreateYogaLayoutNode
Keywords
yogavoidedgealignjustifywraplayoutedgegutteredge_maprecord
Detected imports
src/native-ts/yoga-layout/index.js./node.js
Source notes
This page embeds the full file contents. Small or leaf files are still indexed honestly instead of being over-explained.
Full source
import Yoga, {
Align,
Direction,
Display,
Edge,
FlexDirection,
Gutter,
Justify,
MeasureMode,
Overflow,
PositionType,
Wrap,
type Node as YogaNode,
} from 'src/native-ts/yoga-layout/index.js'
import {
type LayoutAlign,
LayoutDisplay,
type LayoutEdge,
type LayoutFlexDirection,
type LayoutGutter,
type LayoutJustify,
type LayoutMeasureFunc,
LayoutMeasureMode,
type LayoutNode,
type LayoutOverflow,
type LayoutPositionType,
type LayoutWrap,
} from './node.js'
// --
// Edge/Gutter mapping
const EDGE_MAP: Record<LayoutEdge, Edge> = {
all: Edge.All,
horizontal: Edge.Horizontal,
vertical: Edge.Vertical,
left: Edge.Left,
right: Edge.Right,
top: Edge.Top,
bottom: Edge.Bottom,
start: Edge.Start,
end: Edge.End,
}
const GUTTER_MAP: Record<LayoutGutter, Gutter> = {
all: Gutter.All,
column: Gutter.Column,
row: Gutter.Row,
}
// --
// Yoga adapter
export class YogaLayoutNode implements LayoutNode {
readonly yoga: YogaNode
constructor(yoga: YogaNode) {
this.yoga = yoga
}
// Tree
insertChild(child: LayoutNode, index: number): void {
this.yoga.insertChild((child as YogaLayoutNode).yoga, index)
}
removeChild(child: LayoutNode): void {
this.yoga.removeChild((child as YogaLayoutNode).yoga)
}
getChildCount(): number {
return this.yoga.getChildCount()
}
getParent(): LayoutNode | null {
const p = this.yoga.getParent()
return p ? new YogaLayoutNode(p) : null
}
// Layout
calculateLayout(width?: number, _height?: number): void {
this.yoga.calculateLayout(width, undefined, Direction.LTR)
}
setMeasureFunc(fn: LayoutMeasureFunc): void {
this.yoga.setMeasureFunc((w, wMode) => {
const mode =
wMode === MeasureMode.Exactly
? LayoutMeasureMode.Exactly
: wMode === MeasureMode.AtMost
? LayoutMeasureMode.AtMost
: LayoutMeasureMode.Undefined
return fn(w, mode)
})
}
unsetMeasureFunc(): void {
this.yoga.unsetMeasureFunc()
}
markDirty(): void {
this.yoga.markDirty()
}
// Computed layout
getComputedLeft(): number {
return this.yoga.getComputedLeft()
}
getComputedTop(): number {
return this.yoga.getComputedTop()
}
getComputedWidth(): number {
return this.yoga.getComputedWidth()
}
getComputedHeight(): number {
return this.yoga.getComputedHeight()
}
getComputedBorder(edge: LayoutEdge): number {
return this.yoga.getComputedBorder(EDGE_MAP[edge]!)
}
getComputedPadding(edge: LayoutEdge): number {
return this.yoga.getComputedPadding(EDGE_MAP[edge]!)
}
// Style setters
setWidth(value: number): void {
this.yoga.setWidth(value)
}
setWidthPercent(value: number): void {
this.yoga.setWidthPercent(value)
}
setWidthAuto(): void {
this.yoga.setWidthAuto()
}
setHeight(value: number): void {
this.yoga.setHeight(value)
}
setHeightPercent(value: number): void {
this.yoga.setHeightPercent(value)
}
setHeightAuto(): void {
this.yoga.setHeightAuto()
}
setMinWidth(value: number): void {
this.yoga.setMinWidth(value)
}
setMinWidthPercent(value: number): void {
this.yoga.setMinWidthPercent(value)
}
setMinHeight(value: number): void {
this.yoga.setMinHeight(value)
}
setMinHeightPercent(value: number): void {
this.yoga.setMinHeightPercent(value)
}
setMaxWidth(value: number): void {
this.yoga.setMaxWidth(value)
}
setMaxWidthPercent(value: number): void {
this.yoga.setMaxWidthPercent(value)
}
setMaxHeight(value: number): void {
this.yoga.setMaxHeight(value)
}
setMaxHeightPercent(value: number): void {
this.yoga.setMaxHeightPercent(value)
}
setFlexDirection(dir: LayoutFlexDirection): void {
const map: Record<LayoutFlexDirection, FlexDirection> = {
row: FlexDirection.Row,
'row-reverse': FlexDirection.RowReverse,
column: FlexDirection.Column,
'column-reverse': FlexDirection.ColumnReverse,
}
this.yoga.setFlexDirection(map[dir]!)
}
setFlexGrow(value: number): void {
this.yoga.setFlexGrow(value)
}
setFlexShrink(value: number): void {
this.yoga.setFlexShrink(value)
}
setFlexBasis(value: number): void {
this.yoga.setFlexBasis(value)
}
setFlexBasisPercent(value: number): void {
this.yoga.setFlexBasisPercent(value)
}
setFlexWrap(wrap: LayoutWrap): void {
const map: Record<LayoutWrap, Wrap> = {
nowrap: Wrap.NoWrap,
wrap: Wrap.Wrap,
'wrap-reverse': Wrap.WrapReverse,
}
this.yoga.setFlexWrap(map[wrap]!)
}
setAlignItems(align: LayoutAlign): void {
const map: Record<LayoutAlign, Align> = {
auto: Align.Auto,
stretch: Align.Stretch,
'flex-start': Align.FlexStart,
center: Align.Center,
'flex-end': Align.FlexEnd,
}
this.yoga.setAlignItems(map[align]!)
}
setAlignSelf(align: LayoutAlign): void {
const map: Record<LayoutAlign, Align> = {
auto: Align.Auto,
stretch: Align.Stretch,
'flex-start': Align.FlexStart,
center: Align.Center,
'flex-end': Align.FlexEnd,
}
this.yoga.setAlignSelf(map[align]!)
}
setJustifyContent(justify: LayoutJustify): void {
const map: Record<LayoutJustify, Justify> = {
'flex-start': Justify.FlexStart,
center: Justify.Center,
'flex-end': Justify.FlexEnd,
'space-between': Justify.SpaceBetween,
'space-around': Justify.SpaceAround,
'space-evenly': Justify.SpaceEvenly,
}
this.yoga.setJustifyContent(map[justify]!)
}
setDisplay(display: LayoutDisplay): void {
this.yoga.setDisplay(display === 'flex' ? Display.Flex : Display.None)
}
getDisplay(): LayoutDisplay {
return this.yoga.getDisplay() === Display.None
? LayoutDisplay.None
: LayoutDisplay.Flex
}
setPositionType(type: LayoutPositionType): void {
this.yoga.setPositionType(
type === 'absolute' ? PositionType.Absolute : PositionType.Relative,
)
}
setPosition(edge: LayoutEdge, value: number): void {
this.yoga.setPosition(EDGE_MAP[edge]!, value)
}
setPositionPercent(edge: LayoutEdge, value: number): void {
this.yoga.setPositionPercent(EDGE_MAP[edge]!, value)
}
setOverflow(overflow: LayoutOverflow): void {
const map: Record<LayoutOverflow, Overflow> = {
visible: Overflow.Visible,
hidden: Overflow.Hidden,
scroll: Overflow.Scroll,
}
this.yoga.setOverflow(map[overflow]!)
}
setMargin(edge: LayoutEdge, value: number): void {
this.yoga.setMargin(EDGE_MAP[edge]!, value)
}
setPadding(edge: LayoutEdge, value: number): void {
this.yoga.setPadding(EDGE_MAP[edge]!, value)
}
setBorder(edge: LayoutEdge, value: number): void {
this.yoga.setBorder(EDGE_MAP[edge]!, value)
}
setGap(gutter: LayoutGutter, value: number): void {
this.yoga.setGap(GUTTER_MAP[gutter]!, value)
}
// Lifecycle
free(): void {
this.yoga.free()
}
freeRecursive(): void {
this.yoga.freeRecursive()
}
}
// --
// Instance management
//
// The TS yoga-layout port is synchronous — no WASM loading, no linear memory
// growth, so no preload/swap/reset machinery is needed. The Yoga instance is
// just a plain JS object available at import time.
export function createYogaLayoutNode(): LayoutNode {
return new YogaLayoutNode(Yoga.Node.create())
}