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

OpenTUI 0.4.3

npm

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

API changes#

@opentui/core#

Added

  • const NativeMeasureTargetKind: { readonly None: 0; readonly TextBufferView: 1; readonly EditorView: 2; }
  • method ScrollBoxRenderable.getRenderable(id: string): Renderable | undefined
  • property RenderLib.createNativeRenderable: () => NativeRenderableHandle
  • property RenderLib.destroyNativeRenderable: (handle: NativeRenderableHandle) => void
  • property RenderLib.nativeRenderableAttachYogaNode: (handle: NativeRenderableHandle, node: Pointer) => boolean
  • property RenderLib.nativeRenderableSetMeasureTarget: (handle: NativeRenderableHandle, kind: NativeMeasureTargetKind, target: NativeMeasureTargetHandle | 0) => boolean
  • property RenderLib.yogaSetDirtiedCallback: (callback: Pointer | null) => void
  • property RenderLib.yogaSetMeasureCallback: (callback: Pointer | null) => void
  • property SelectRenderable.showSelectionIndicator: boolean
  • property SelectRenderableOptions.showSelectionIndicator?: boolean
  • type NativeMeasureTargetHandle = TextBufferViewHandle | EditorViewHandle
  • type NativeMeasureTargetKind = (typeof NativeMeasureTargetKind)[keyof typeof NativeMeasureTargetKind]
  • type NativeRenderableHandle = NativeHandle<"native_renderable">

Changed

  • abstract method BaseRenderable.remove(id: string): voidabstract method BaseRenderable.remove(child: BaseRenderable): void
  • method LineNumberRenderable.remove(id: string): voidmethod LineNumberRenderable.remove(child: BaseRenderable): void
  • method Renderable.remove(id: string): voidmethod Renderable.remove(child: BaseRenderable): void
  • method ScrollBoxRenderable.remove(id: string): voidmethod ScrollBoxRenderable.remove(child: BaseRenderable): void
  • method TextNodeRenderable.remove(id: string): thismethod TextNodeRenderable.remove(child: BaseRenderable): void
  • method TextRenderable.remove(id: string): voidmethod TextRenderable.remove(child: BaseRenderable): void
  • property RenderLib.yogaNodeSetDirtiedFunc: (node: Pointer, callback: Pointer | null) => voidproperty RenderLib.yogaNodeSetDirtiedFunc: (node: Pointer, enabled: boolean) => void
  • property RenderLib.yogaNodeSetMeasureFunc: (node: Pointer, callback: Pointer | null) => voidproperty RenderLib.yogaNodeSetMeasureFunc: (node: Pointer, enabled: boolean) => void
  • protected property SelectRenderable._defaultOptions: { backgroundColor: string; textColor: string; focusedBackgroundColor: string; focusedTextColor: string; selectedBackgroundColor: string; selectedTextColor: string; selectedIndex: number; descriptionColor: string; selectedDescriptionColor: string; showScrollIndicator: false; wrapSelection: false; showDescription: true; itemSpacing: number; fastScrollStep: number; }protected property SelectRenderable._defaultOptions: { backgroundColor: string; textColor: string; focusedBackgroundColor: string; focusedTextColor: string; selectedBackgroundColor: string; selectedTextColor: string; selectedIndex: number; descriptionColor: string; selectedDescriptionColor: string; showScrollIndicator: false; wrapSelection: false; showDescription: true; showSelectionIndicator: true; itemSpacing: number; fastScrollStep: number; }
  • type NativeYogaDirtiedCallback = () => voidtype NativeYogaDirtiedCallback = (node: Pointer | null) => void

Removed

  • enum-member LayoutEvents.ADDED = "added"
  • enum-member LayoutEvents.REMOVED = "removed"
  • property Renderable.id: string