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

OpenTUI 0.4.1

npm

This release has no release notes. The list below comes from its published type declarations.

API changes#

@opentui/core#

Added

  • class Yoga.Config
  • class Yoga.Node
  • const Yoga.ALIGN_AUTO = Align.Auto
  • const Yoga.ALIGN_BASELINE = Align.Baseline
  • const Yoga.ALIGN_CENTER = Align.Center
  • const Yoga.ALIGN_FLEX_END = Align.FlexEnd
  • const Yoga.ALIGN_FLEX_START = Align.FlexStart
  • const Yoga.ALIGN_SPACE_AROUND = Align.SpaceAround
  • const Yoga.ALIGN_SPACE_BETWEEN = Align.SpaceBetween
  • const Yoga.ALIGN_SPACE_EVENLY = Align.SpaceEvenly
  • const Yoga.ALIGN_STRETCH = Align.Stretch
  • const Yoga.BOX_SIZING_BORDER_BOX = BoxSizing.BorderBox
  • const Yoga.BOX_SIZING_CONTENT_BOX = BoxSizing.ContentBox
  • const Yoga.DIMENSION_HEIGHT = Dimension.Height
  • const Yoga.DIMENSION_WIDTH = Dimension.Width
  • const Yoga.DIRECTION_INHERIT = Direction.Inherit
  • const Yoga.DIRECTION_LTR = Direction.LTR
  • const Yoga.DIRECTION_RTL = Direction.RTL
  • const Yoga.DISPLAY_CONTENTS = Display.Contents
  • const Yoga.DISPLAY_FLEX = Display.Flex
  • const Yoga.DISPLAY_NONE = Display.None
  • const Yoga.EDGE_ALL = Edge.All
  • const Yoga.EDGE_BOTTOM = Edge.Bottom
  • const Yoga.EDGE_END = Edge.End
  • const Yoga.EDGE_HORIZONTAL = Edge.Horizontal
  • const Yoga.EDGE_LEFT = Edge.Left
  • const Yoga.EDGE_RIGHT = Edge.Right
  • const Yoga.EDGE_START = Edge.Start
  • const Yoga.EDGE_TOP = Edge.Top
  • const Yoga.EDGE_VERTICAL = Edge.Vertical
  • const Yoga.ERRATA_ABSOLUTE_PERCENT_AGAINST_INNER_SIZE = Errata.AbsolutePercentAgainstInnerSize
  • const Yoga.ERRATA_ABSOLUTE_POSITION_WITHOUT_INSETS_EXCLUDES_PADDING = Errata.AbsolutePositionWithoutInsetsExcludesPadding
  • const Yoga.ERRATA_ALL = Errata.All
  • const Yoga.ERRATA_CLASSIC = Errata.Classic
  • const Yoga.ERRATA_NONE = Errata.None
  • const Yoga.ERRATA_STRETCH_FLEX_BASIS = Errata.StretchFlexBasis
  • const Yoga.EXPERIMENTAL_FEATURE_WEB_FLEX_BASIS = ExperimentalFeature.WebFlexBasis
  • const Yoga.FLEX_DIRECTION_COLUMN = FlexDirection.Column
  • const Yoga.FLEX_DIRECTION_COLUMN_REVERSE = FlexDirection.ColumnReverse
  • const Yoga.FLEX_DIRECTION_ROW = FlexDirection.Row
  • const Yoga.FLEX_DIRECTION_ROW_REVERSE = FlexDirection.RowReverse
  • const Yoga.GUTTER_ALL = Gutter.All
  • const Yoga.GUTTER_COLUMN = Gutter.Column
  • const Yoga.GUTTER_ROW = Gutter.Row
  • const Yoga.JUSTIFY_CENTER = Justify.Center
  • const Yoga.JUSTIFY_FLEX_END = Justify.FlexEnd
  • const Yoga.JUSTIFY_FLEX_START = Justify.FlexStart
  • const Yoga.JUSTIFY_SPACE_AROUND = Justify.SpaceAround
  • const Yoga.JUSTIFY_SPACE_BETWEEN = Justify.SpaceBetween
  • const Yoga.JUSTIFY_SPACE_EVENLY = Justify.SpaceEvenly
  • const Yoga.LOG_LEVEL_DEBUG = LogLevel.Debug
  • const Yoga.LOG_LEVEL_ERROR = LogLevel.Error
  • const Yoga.LOG_LEVEL_FATAL = LogLevel.Fatal
  • const Yoga.LOG_LEVEL_INFO = LogLevel.Info
  • const Yoga.LOG_LEVEL_VERBOSE = LogLevel.Verbose
  • const Yoga.LOG_LEVEL_WARN = LogLevel.Warn
  • const Yoga.MEASURE_MODE_AT_MOST = MeasureMode.AtMost
  • const Yoga.MEASURE_MODE_EXACTLY = MeasureMode.Exactly
  • const Yoga.MEASURE_MODE_UNDEFINED = MeasureMode.Undefined
  • const Yoga.NODE_TYPE_DEFAULT = NodeType.Default
  • const Yoga.NODE_TYPE_TEXT = NodeType.Text
  • const Yoga.OVERFLOW_HIDDEN = Overflow.Hidden
  • const Yoga.OVERFLOW_SCROLL = Overflow.Scroll
  • const Yoga.OVERFLOW_VISIBLE = Overflow.Visible
  • const Yoga.POSITION_TYPE_ABSOLUTE = PositionType.Absolute
  • const Yoga.POSITION_TYPE_RELATIVE = PositionType.Relative
  • const Yoga.POSITION_TYPE_STATIC = PositionType.Static
  • const Yoga.UNIT_AUTO = Unit.Auto
  • const Yoga.UNIT_PERCENT = Unit.Percent
  • const Yoga.UNIT_POINT = Unit.Point
  • const Yoga.UNIT_UNDEFINED = Unit.Undefined
  • const Yoga.WRAP_NO_WRAP = Wrap.NoWrap
  • const Yoga.WRAP_WRAP = Wrap.Wrap
  • const Yoga.WRAP_WRAP_REVERSE = Wrap.WrapReverse
  • const Yoga.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; }
  • enum Yoga.Align
  • enum Yoga.BoxSizing
  • enum Yoga.Dimension
  • enum Yoga.Direction
  • enum Yoga.Display
  • enum Yoga.Edge
  • enum Yoga.Errata
  • enum Yoga.ExperimentalFeature
  • enum Yoga.FlexDirection
  • enum Yoga.Gutter
  • enum Yoga.Justify
  • enum Yoga.LogLevel
  • enum Yoga.MeasureMode
  • enum Yoga.NodeType
  • enum Yoga.Overflow
  • enum Yoga.PositionType
  • enum Yoga.Unit
  • enum Yoga.Wrap
  • enum-member Yoga.Align.Auto = 0
  • enum-member Yoga.Align.Baseline = 5
  • enum-member Yoga.Align.Center = 2
  • enum-member Yoga.Align.FlexEnd = 3
  • enum-member Yoga.Align.FlexStart = 1
  • enum-member Yoga.Align.SpaceAround = 7
  • enum-member Yoga.Align.SpaceBetween = 6
  • enum-member Yoga.Align.SpaceEvenly = 8
  • enum-member Yoga.Align.Stretch = 4
  • enum-member Yoga.BoxSizing.BorderBox = 0
  • enum-member Yoga.BoxSizing.ContentBox = 1
  • enum-member Yoga.Dimension.Height = 1
  • enum-member Yoga.Dimension.Width = 0
  • enum-member Yoga.Direction.Inherit = 0
  • enum-member Yoga.Direction.LTR = 1
  • enum-member Yoga.Direction.RTL = 2
  • enum-member Yoga.Display.Contents = 2
  • enum-member Yoga.Display.Flex = 0
  • enum-member Yoga.Display.None = 1
  • enum-member Yoga.Edge.All = 8
  • enum-member Yoga.Edge.Bottom = 3
  • enum-member Yoga.Edge.End = 5
  • enum-member Yoga.Edge.Horizontal = 6
  • enum-member Yoga.Edge.Left = 0
  • enum-member Yoga.Edge.Right = 2
  • enum-member Yoga.Edge.Start = 4
  • enum-member Yoga.Edge.Top = 1
  • enum-member Yoga.Edge.Vertical = 7
  • enum-member Yoga.Errata.AbsolutePercentAgainstInnerSize = 4
  • enum-member Yoga.Errata.AbsolutePositionWithoutInsetsExcludesPadding = 2
  • enum-member Yoga.Errata.All = 2147483647
  • enum-member Yoga.Errata.Classic = 2147483646
  • enum-member Yoga.Errata.None = 0
  • enum-member Yoga.Errata.StretchFlexBasis = 1
  • enum-member Yoga.ExperimentalFeature.WebFlexBasis = 0
  • enum-member Yoga.FlexDirection.Column = 0
  • enum-member Yoga.FlexDirection.ColumnReverse = 1
  • enum-member Yoga.FlexDirection.Row = 2
  • enum-member Yoga.FlexDirection.RowReverse = 3
  • enum-member Yoga.Gutter.All = 2
  • enum-member Yoga.Gutter.Column = 0
  • enum-member Yoga.Gutter.Row = 1
  • enum-member Yoga.Justify.Center = 1
  • enum-member Yoga.Justify.FlexEnd = 2
  • enum-member Yoga.Justify.FlexStart = 0
  • enum-member Yoga.Justify.SpaceAround = 4
  • enum-member Yoga.Justify.SpaceBetween = 3
  • enum-member Yoga.Justify.SpaceEvenly = 5
  • enum-member Yoga.LogLevel.Debug = 3
  • enum-member Yoga.LogLevel.Error = 0
  • enum-member Yoga.LogLevel.Fatal = 5
  • enum-member Yoga.LogLevel.Info = 2
  • enum-member Yoga.LogLevel.Verbose = 4
  • enum-member Yoga.LogLevel.Warn = 1
  • enum-member Yoga.MeasureMode.AtMost = 2
  • enum-member Yoga.MeasureMode.Exactly = 1
  • enum-member Yoga.MeasureMode.Undefined = 0
  • enum-member Yoga.NodeType.Default = 0
  • enum-member Yoga.NodeType.Text = 1
  • enum-member Yoga.Overflow.Hidden = 1
  • enum-member Yoga.Overflow.Scroll = 2
  • enum-member Yoga.Overflow.Visible = 0
  • enum-member Yoga.PositionType.Absolute = 2
  • enum-member Yoga.PositionType.Relative = 1
  • enum-member Yoga.PositionType.Static = 0
  • enum-member Yoga.Unit.Auto = 3
  • enum-member Yoga.Unit.Percent = 2
  • enum-member Yoga.Unit.Point = 1
  • enum-member Yoga.Unit.Undefined = 0
  • enum-member Yoga.Wrap.NoWrap = 0
  • enum-member Yoga.Wrap.Wrap = 1
  • enum-member Yoga.Wrap.WrapReverse = 2
  • interface NativeYogaLayout
  • interface Yoga.Layout
  • interface Yoga.Size
  • interface Yoga.Value
  • method Renderable.canReuseRenderCommandList(): boolean
  • static method Yoga.Config.create(): Config
  • static method Yoga.Config.destroy(config: Config): void
  • method Yoga.Config.free(): void
  • method Yoga.Config.getErrata(): Errata
  • method Yoga.Config.getPointScaleFactor(): number
  • method Yoga.Config.isExperimentalFeatureEnabled(feature: ExperimentalFeature): boolean
  • method Yoga.Config.setErrata(errata: Errata): void
  • method Yoga.Config.setExperimentalFeatureEnabled(feature: ExperimentalFeature, enabled: boolean): void
  • method Yoga.Config.setPointScaleFactor(pointScaleFactor: number): void
  • method Yoga.Config.setUseWebDefaults(useWebDefaults: boolean): void
  • method Yoga.Config.useWebDefaults(): boolean
  • method Yoga.Node.calculateLayout(width?: number | "auto", height?: number | "auto", direction?: Direction): void
  • method Yoga.Node.copyStyle(node: Node): void
  • static method Yoga.Node.create(config?: Config): Node
  • static method Yoga.Node.createDefault(): Node
  • static method Yoga.Node.createForOpenTUI(): Node
  • static method Yoga.Node.createWithConfig(config: Config): Node
  • static method Yoga.Node.destroy(node: Node): void
  • method Yoga.Node.free(): void
  • method Yoga.Node.freeRecursive(): void
  • method Yoga.Node.getAlignContent(): Align
  • method Yoga.Node.getAlignItems(): Align
  • method Yoga.Node.getAlignSelf(): Align
  • method Yoga.Node.getAlwaysFormsContainingBlock(): boolean
  • method Yoga.Node.getAspectRatio(): number
  • method Yoga.Node.getBorder(edge: Edge): number
  • method Yoga.Node.getBoxSizing(): BoxSizing
  • method Yoga.Node.getChild(index: number): Node | null
  • method Yoga.Node.getChildCount(): number
  • method Yoga.Node.getComputedBorder(edge: Edge): number
  • method Yoga.Node.getComputedBottom(): number
  • method Yoga.Node.getComputedHeight(): number
  • method Yoga.Node.getComputedLayout(): Layout
  • method Yoga.Node.getComputedLeft(): number
  • method Yoga.Node.getComputedMargin(edge: Edge): number
  • method Yoga.Node.getComputedPadding(edge: Edge): number
  • method Yoga.Node.getComputedRight(): number
  • method Yoga.Node.getComputedTop(): number
  • method Yoga.Node.getComputedWidth(): number
  • method Yoga.Node.getDirection(): Direction
  • method Yoga.Node.getDisplay(): Display
  • method Yoga.Node.getFlex(): number
  • method Yoga.Node.getFlexBasis(): Value
  • method Yoga.Node.getFlexDirection(): FlexDirection
  • method Yoga.Node.getFlexGrow(): number
  • method Yoga.Node.getFlexShrink(): number
  • method Yoga.Node.getFlexWrap(): Wrap
  • method Yoga.Node.getGap(gutter: Gutter): Value
  • method Yoga.Node.getHeight(): Value
  • method Yoga.Node.getJustifyContent(): Justify
  • method Yoga.Node.getMargin(edge: Edge): Value
  • method Yoga.Node.getMaxHeight(): Value
  • method Yoga.Node.getMaxWidth(): Value
  • method Yoga.Node.getMinHeight(): Value
  • method Yoga.Node.getMinWidth(): Value
  • method Yoga.Node.getOverflow(): Overflow
  • method Yoga.Node.getPadding(edge: Edge): Value
  • method Yoga.Node.getParent(): Node | null
  • method Yoga.Node.getPosition(edge: Edge): Value
  • method Yoga.Node.getPositionType(): PositionType
  • method Yoga.Node.getWidth(): Value
  • method Yoga.Node.hasMeasureFunc(): boolean
  • method Yoga.Node.hasNewLayout(): boolean
  • method Yoga.Node.insertChild(child: Node, index: number): void
  • method Yoga.Node.isDirty(): boolean
  • method Yoga.Node.isFreed(): boolean
  • method Yoga.Node.isReferenceBaseline(): boolean
  • method Yoga.Node.markDirty(): void
  • method Yoga.Node.markLayoutSeen(): void
  • method Yoga.Node.removeAllChildren(): void
  • method Yoga.Node.removeChild(child: Node): void
  • method Yoga.Node.reset(): void
  • method Yoga.Node.setAlignContent(alignContent: Align): void
  • method Yoga.Node.setAlignItems(alignItems: Align): void
  • method Yoga.Node.setAlignSelf(alignSelf: Align): void
  • method Yoga.Node.setAlwaysFormsContainingBlock(alwaysFormsContainingBlock: boolean): void
  • method Yoga.Node.setAspectRatio(aspectRatio: number | undefined): void
  • method Yoga.Node.setBorder(edge: Edge, border: number | undefined): void
  • method Yoga.Node.setBoxSizing(boxSizing: BoxSizing): void
  • method Yoga.Node.setDirection(direction: Direction): void
  • method Yoga.Node.setDirtiedFunc(dirtiedFunc: DirtiedFunction | null): void
  • method Yoga.Node.setDisplay(display: Display): void
  • method Yoga.Node.setFlex(flex: number | undefined): void
  • method Yoga.Node.setFlexBasis(flexBasis: ValueInput): void
  • method Yoga.Node.setFlexBasisAuto(): void
  • method Yoga.Node.setFlexBasisPercent(flexBasis: number | undefined): void
  • method Yoga.Node.setFlexDirection(flexDirection: FlexDirection): void
  • method Yoga.Node.setFlexGrow(flexGrow: number | undefined): void
  • method Yoga.Node.setFlexShrink(flexShrink: number | undefined): void
  • method Yoga.Node.setFlexWrap(flexWrap: Wrap): void
  • method Yoga.Node.setGap(gutter: Gutter, gap: ValueInputNoAuto): void
  • method Yoga.Node.setGapPercent(gutter: Gutter, gap: number | undefined): void
  • method Yoga.Node.setHeight(height: ValueInput): void
  • method Yoga.Node.setHeightAuto(): void
  • method Yoga.Node.setHeightPercent(height: number | undefined): void
  • method Yoga.Node.setIsReferenceBaseline(isReferenceBaseline: boolean): void
  • method Yoga.Node.setJustifyContent(justifyContent: Justify): void
  • method Yoga.Node.setMargin(edge: Edge, margin: ValueInput): void
  • method Yoga.Node.setMarginAuto(edge: Edge): void
  • method Yoga.Node.setMarginPercent(edge: Edge, margin: number | undefined): void
  • method Yoga.Node.setMaxHeight(maxHeight: ValueInputNoAuto): void
  • method Yoga.Node.setMaxHeightPercent(maxHeight: number | undefined): void
  • method Yoga.Node.setMaxWidth(maxWidth: ValueInputNoAuto): void
  • method Yoga.Node.setMaxWidthPercent(maxWidth: number | undefined): void
  • method Yoga.Node.setMeasureFunc(measureFunc: MeasureFunction | null): void
  • method Yoga.Node.setMinHeight(minHeight: ValueInputNoAuto): void
  • method Yoga.Node.setMinHeightPercent(minHeight: number | undefined): void
  • method Yoga.Node.setMinWidth(minWidth: ValueInputNoAuto): void
  • method Yoga.Node.setMinWidthPercent(minWidth: number | undefined): void
  • method Yoga.Node.setOverflow(overflow: Overflow): void
  • method Yoga.Node.setPadding(edge: Edge, padding: ValueInputNoAuto): void
  • method Yoga.Node.setPaddingPercent(edge: Edge, padding: number | undefined): void
  • method Yoga.Node.setPosition(edge: Edge, position: ValueInput): void
  • method Yoga.Node.setPositionAuto(edge: Edge): void
  • method Yoga.Node.setPositionPercent(edge: Edge, position: number | undefined): void
  • method Yoga.Node.setPositionType(positionType: PositionType): void
  • method Yoga.Node.setWidth(width: ValueInput): void
  • method Yoga.Node.setWidthAuto(): void
  • method Yoga.Node.setWidthPercent(width: number | undefined): void
  • method Yoga.Node.unsetDirtiedFunc(): void
  • method Yoga.Node.unsetMeasureFunc(): void
  • property RenderLib.createYogaDirtiedCallback: (callback: NativeYogaDirtiedCallback) => FFICallbackInstance
  • property RenderLib.createYogaMeasureCallback: (callback: NativeYogaMeasureCallback) => FFICallbackInstance
  • property RenderLib.yogaConfigCreate: () => Pointer
  • property RenderLib.yogaConfigFree: (config: Pointer) => void
  • property RenderLib.yogaConfigGetErrata: (config: Pointer) => number
  • property RenderLib.yogaConfigGetPointScaleFactor: (config: Pointer) => number
  • property RenderLib.yogaConfigGetUseWebDefaults: (config: Pointer) => boolean
  • property RenderLib.yogaConfigIsExperimentalFeatureEnabled: (config: Pointer, feature: number) => boolean
  • property RenderLib.yogaConfigSetErrata: (config: Pointer, errata: number) => void
  • property RenderLib.yogaConfigSetExperimentalFeatureEnabled: (config: Pointer, feature: number, enabled: boolean) => void
  • property RenderLib.yogaConfigSetPointScaleFactor: (config: Pointer, pointScaleFactor: number) => void
  • property RenderLib.yogaConfigSetUseWebDefaults: (config: Pointer, enabled: boolean) => void
  • property RenderLib.yogaNodeCalculateLayout: (node: Pointer, width: number, height: number, direction: number) => void
  • property RenderLib.yogaNodeCopyStyle: (dstNode: Pointer, srcNode: Pointer) => void
  • property RenderLib.yogaNodeCreate: () => Pointer
  • property RenderLib.yogaNodeCreateForOpenTUI: () => Pointer
  • property RenderLib.yogaNodeCreateWithConfig: (config: Pointer) => Pointer
  • property RenderLib.yogaNodeFree: (node: Pointer) => void
  • property RenderLib.yogaNodeFreeRecursive: (node: Pointer) => void
  • property RenderLib.yogaNodeGetAlwaysFormsContainingBlock: (node: Pointer) => boolean
  • property RenderLib.yogaNodeGetChild: (node: Pointer, index: number) => Pointer | null
  • property RenderLib.yogaNodeGetChildCount: (node: Pointer) => number
  • property RenderLib.yogaNodeGetComputedLayout: (node: Pointer) => NativeYogaLayout
  • property RenderLib.yogaNodeGetHasNewLayout: (node: Pointer) => boolean
  • property RenderLib.yogaNodeGetParent: (node: Pointer) => Pointer | null
  • property RenderLib.yogaNodeHasMeasureFunc: (node: Pointer) => boolean
  • property RenderLib.yogaNodeInsertChild: (node: Pointer, child: Pointer, index: number) => void
  • property RenderLib.yogaNodeIsDirty: (node: Pointer) => boolean
  • property RenderLib.yogaNodeIsReferenceBaseline: (node: Pointer) => boolean
  • property RenderLib.yogaNodeLayoutGetEdge: (node: Pointer, kind: number, edge: number) => number
  • property RenderLib.yogaNodeMarkDirty: (node: Pointer) => void
  • property RenderLib.yogaNodeRemoveAllChildren: (node: Pointer) => void
  • property RenderLib.yogaNodeRemoveChild: (node: Pointer, child: Pointer) => void
  • property RenderLib.yogaNodeReset: (node: Pointer) => void
  • property RenderLib.yogaNodeSetAlwaysFormsContainingBlock: (node: Pointer, alwaysFormsContainingBlock: boolean) => void
  • property RenderLib.yogaNodeSetDirtiedFunc: (node: Pointer, callback: Pointer | null) => void
  • property RenderLib.yogaNodeSetHasNewLayout: (node: Pointer, hasNewLayout: boolean) => void
  • property RenderLib.yogaNodeSetIsReferenceBaseline: (node: Pointer, isReferenceBaseline: boolean) => void
  • property RenderLib.yogaNodeSetMeasureFunc: (node: Pointer, callback: Pointer | null) => void
  • property RenderLib.yogaNodeStyleGetBorder: (node: Pointer, edge: number) => number
  • property RenderLib.yogaNodeStyleGetEnum: (node: Pointer, kind: number) => number
  • property RenderLib.yogaNodeStyleGetFloat: (node: Pointer, kind: number) => number
  • property RenderLib.yogaNodeStyleGetValue: (node: Pointer, kind: number, edgeOrGutter: number) => number | bigint
  • property RenderLib.yogaNodeStyleSetBorder: (node: Pointer, edge: number, border: number) => void
  • property RenderLib.yogaNodeStyleSetEnum: (node: Pointer, kind: number, value: number) => void
  • property RenderLib.yogaNodeStyleSetFloat: (node: Pointer, kind: number, value: number) => void
  • property RenderLib.yogaNodeStyleSetValue: (node: Pointer, kind: number, edgeOrGutter: number, unit: number, value: number) => void
  • property RenderLib.yogaNodeUnsetDirtiedFunc: (node: Pointer) => void
  • property RenderLib.yogaNodeUnsetMeasureFunc: (node: Pointer) => void
  • property RenderLib.yogaStoreMeasureResult: (width: number, height: number) => void
  • readonly property Yoga.Config.ptr: Pointer
  • property Yoga.Layout.bottom: number
  • property Yoga.Layout.height: number
  • property Yoga.Layout.left: number
  • property Yoga.Layout.right: number
  • property Yoga.Layout.top: number
  • property Yoga.Layout.width: number
  • readonly property Yoga.Node.ptr: Pointer
  • property Yoga.Size.height: number
  • property Yoga.Size.width: number
  • property Yoga.Value.unit: Unit
  • property Yoga.Value.value: number
  • type NativeYogaDirtiedCallback = () => void
  • type NativeYogaMeasureCallback = (node: Pointer | null, width: number, widthMode: number, height: number, heightMode: number) => void
  • type Yoga.DirtiedFunction = (node: Node) => void
  • type Yoga.MeasureFunction = (width: number, widthMode: MeasureMode, height: number, heightMode: MeasureMode) => Size

Changed

  • namespace Yoga from "yoga-layout"namespace Yoga

@opentui/core/yoga#

Added

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

@opentui/ssh#

Added

  • call Next(): Promise<Handoff>call Next<Add extends object>(add: Add): Promise<Handoff<Add>>
  • class ConfigError extends SshError
  • class DenyError extends Error
  • class SshError extends Error
  • constructor ConfigError(message: string)
  • constructor DenyError(reason?: string)
  • constructor SshError(code: string, message: string)
  • function createServer(config?: Omit<ServerConfig, "auth"> & { auth?: "open"; }): ServerBuilder<IdentityFor<"open">>function createServer<A extends AuthConfig>(config: ServerConfig<A>): ServerBuilder<IdentityFor<A | "open">>function createServer<A extends AuthMethods>(config: Omit<ServerConfig, "auth"> & { auth: A; }): ServerBuilder<IdentityFor<A>>
  • function logging<Id extends Identity = Identity>(options?: LoggingOptions<Id>): Middleware<Id>
  • interface AuthMethods extends CredentialMethods
  • interface Handoff<Add extends object = object>
  • interface ListenInfo
  • interface LoggingOptions<Id extends Identity = Identity>
  • interface MiddlewareSession<Id extends Identity = Identity, Ctx extends object = object> extends SessionCommon<Id>
  • interface Next
  • interface PublicKeyPolicy
  • interface RemoteAddress
  • interface Server
  • interface ServerBuilder<Id extends Identity = Identity, Ctx extends object = {}>
  • interface ServerConfig<A extends AuthConfig = "open">
  • interface Session<Id extends Identity = Identity, Ctx extends object = {}> extends SessionCommon<Id>
  • type AuthConfig = "open" | AuthMethods
  • type Identity = { method: "none"; username: string; } | { method: "password"; username: string; } | { method: "keyboard-interactive"; username: string; } | { method: "publickey"; username: string; fingerprint: string; publicKey: PublicKey; }
  • type IdentityFor<A extends AuthConfig = "open"> = A extends "open" ? Extract<Identity, { method: "none"; }> : A extends AuthMethods ? CredentialVariant[ConfiguredCredentialKeys<A> & keyof CredentialVariant] : never
  • type LogEvent<Id extends Identity = Identity> = (LogEventCommon<Id> & { type: "connect"; durationMs?: never; }) | (LogEventCommon<Id> & { type: "disconnect"; durationMs: number; })
  • type Middleware<Id extends Identity = Identity, Add extends object = object> = (session: MiddlewareSession<Id>, next: Next) => Handoff<Add> | Promise<Handoff<Add>>
  • type MiddlewareFunction<Id extends Identity = Identity, Ctx extends object = object, Add extends object = object> = (session: MiddlewareSession<Id, Ctx>, next: Next) => Handoff<Add> | Promise<Handoff<Add>>
  • type PublicKey = { algorithm: string; blob: Buffer; }
  • type SessionHandler<Id extends Identity = Identity, Ctx extends object = {}> = (session: Session<Id, Ctx>) => void | Promise<void>