mizchi/tui/core - mooncakes.io

README
U
ActionMenu
U
App
U
BorderChars
U
ButtonState
U
CharBuffer
U
CharCell
U
Color
U
Component
U
EditConfig
U
EventHandlers
U
FocusManager
U
FocusState
U
HitTestResult
U
InputEvent
U
InputMode
U
InputResult
U
InputState
U
ItemScroller
U
KeyEvent
U
KeyModifier
U
ModalState
U
MouseButton
U
MouseEvent
U
MouseEventType
U
ProgressStyle
U
RenderStyleMap
U
ScrollState
U
SpecialKey
U
StreamingState
U
TextContentMap
U
TextStyle
U
TextareaState

mizchi/tui/core does not have a README file

BorderChars

pub(all) struct BorderChars {
  top_left : Char
  top_right : Char
  bottom_left : Char
  bottom_right : Char
  horizontal : Char
  vertical : Char
}

Border characters for box drawing

BorderChars::ascii

source

fn BorderChars::ascii() -> BorderChars

BorderChars::double

source

fn BorderChars::double() -> BorderChars

BorderChars::rounded

source

fn BorderChars::rounded() -> BorderChars

BorderChars::single

source

fn BorderChars::single() -> BorderChars

ClickHandler

source

pub(all) type ClickHandler () -> Unit

Click handler type for component-level event handling

ClickHandler::inner

source

#deprecated("Use `struct T(A)` to declare a newtype and use `.0` access the underlying type instead.")
fn ClickHandler::inner(self : ClickHandler) -> (() -> Unit)

Convert newtype to its underlying type, automatically derived.

ClickHandler::invoke

source

fn ClickHandler::invoke(self : ClickHandler) -> Unit

Invoke click handler

ClickHandler::new

source

fn ClickHandler::new(handler : () -> Unit) -> ClickHandler

Create a new click handler

ClickHandlers

source

pub(all) type ClickHandlers Map[String, ClickHandler]

Click handlers map (component ID -> handler)

ClickHandlers::get

source

fn ClickHandlers::get(self : ClickHandlers, id : String) -> ClickHandler?

ClickHandlers::inner

source

#deprecated("Use `struct T(A)` to declare a newtype and use `.0` access the underlying type instead.")
fn ClickHandlers::inner(self : ClickHandlers) -> Map[String, ClickHandler]

Convert newtype to its underlying type, automatically derived.

ClickHandlers::iter

source

fn ClickHandlers::iter(self : ClickHandlers) -> Iter[(String, ClickHandler)]

ClickHandlers::new

source

fn ClickHandlers::new() -> ClickHandlers

ClickHandlers::set

source

fn ClickHandlers::set(self : ClickHandlers, id : String, handler : ClickHandler) -> Unit

Color

source

pub(all) struct Color {
  r : Int
  g : Int
  b : Int
  a : Double
}

TUI Color type (RGBA)

impl Eq for Color

Color::black

source

fn Color::black() -> Color

Color::blue

source

fn Color::blue() -> Color

Color::cyan

source

fn Color::cyan() -> Color

Color::from_crater

source

fn Color::from_crater(c : @mizchi/crater/types.Color
Color) -> Color

Convert from crater Color

Color::green

source

fn Color::green() -> Color

Color::is_transparent

source

fn Color::is_transparent(self : Color) -> Bool

Color::magenta

source

fn Color::magenta() -> Color

Color::red

source

fn Color::red() -> Color

Color::rgb

source

fn Color::rgb(r : Int, g : Int, b : Int) -> Color

Color::rgba

source

fn Color::rgba(r : Int, g : Int, b : Int, a : Double) -> Color

Color::transparent

source

fn Color::transparent() -> Color

Color::white

source

fn Color::white() -> Color

Color::yellow

source

fn Color::yellow() -> Color

Component

source

pub struct Component {
  node : @mizchi/crater/layout/node.Node
Node
  styles : RenderStyleMap
  texts : TextContentMap
  click_handlers : ClickHandlers
  roles : RoleMap
}

Component represents a renderable UI element with its layout, style, and content

RenderStyle

source

pub(all) struct RenderStyle {
  fg : Color
  bg : Color
  bold : Bool
  underline : Bool
  border : BorderChars?
  border_fg : Color
}

Rendering options for a node

RenderStyle::default

source

fn RenderStyle::default() -> RenderStyle

RenderStyleMap

source

pub type RenderStyleMap Map[String, RenderStyle]

Map from node ID to render style

RenderStyleMap::get

source

fn RenderStyleMap::get(self : RenderStyleMap, id : String) -> RenderStyle

RenderStyleMap::inner

source

#deprecated("Use `struct T(A)` to declare a newtype and use `.0` access the underlying type instead.")
fn RenderStyleMap::inner(self : RenderStyleMap) -> Map[String, RenderStyle]

Convert newtype to its underlying type, automatically derived.

RenderStyleMap::new

source

fn RenderStyleMap::new() -> RenderStyleMap

RenderStyleMap::set

source

fn RenderStyleMap::set(self : RenderStyleMap, id : String, style : RenderStyle) -> Unit

Role

source

pub(all) enum Role {
  Button
  Checkbox
  Link
  Menuitem
  Option
  Radio
  Slider
  Switch
  Tab
  Textbox
  Listbox
  Menu
  Menubar
  Radiogroup
  Tablist
  Tree
  Treegrid
  Article
  Cell
  Columnheader
  Definition
  Directory
  Document
  Group
  Heading
  Img
  List
  Listitem
  Row
  Rowgroup
  Rowheader
  Separator
  Table
  Term
  Banner
  Complementary
  Contentinfo
  Form
  Main
  Navigation
  Region
  Search
  Alert
  Log
  Marquee
  Status
  Timer
  Alertdialog
  Dialog
  Custom(String)
}

ARIA role for accessibility Based on WAI-ARIA 1.2 roles

impl Eq for Role

impl Show for Role

RoleMap

source

pub(all) type RoleMap Map[String, Role]

Role map (component ID -> role)

RoleMap::get

source

fn RoleMap::get(self : RoleMap, id : String) -> Role?

RoleMap::inner

source

#deprecated("Use `struct T(A)` to declare a newtype and use `.0` access the underlying type instead.")
fn RoleMap::inner(self : RoleMap) -> Map[String, Role]

Convert newtype to its underlying type, automatically derived.

RoleMap::iter

source

fn RoleMap::iter(self : RoleMap) -> Iter[(String, Role)]

RoleMap::new

source

fn RoleMap::new() -> RoleMap

RoleMap::set

source

fn RoleMap::set(self : RoleMap, id : String, role : Role) -> Unit

TextContentMap

source

pub type TextContentMap Map[String, String]

Map from node ID to text content

TextContentMap::get

source

fn TextContentMap::get(self : TextContentMap, id : String) -> String?

TextContentMap::inner

source

#deprecated("Use `struct T(A)` to declare a newtype and use `.0` access the underlying type instead.")
fn TextContentMap::inner(self : TextContentMap) -> Map[String, String]

Convert newtype to its underlying type, automatically derived.

TextContentMap::new

source

fn TextContentMap::new() -> TextContentMap

TextContentMap::set

source

fn TextContentMap::set(self : TextContentMap, id : String, text : String) -> Unit

box

source

fn box(children : Array[Component], id? : String, width? : @mizchi/crater/types.Dimension
Dimension, height? : @mizchi/crater/types.Dimension
Dimension, min_width? : @mizchi/crater/types.Dimension
Dimension, min_height? : @mizchi/crater/types.Dimension
Dimension, max_width? : @mizchi/crater/types.Dimension
Dimension, max_height? : @mizchi/crater/types.Dimension
Dimension, flex_grow? : Double, flex_shrink? : Double, flex_basis? : @mizchi/crater/types.Dimension
Dimension, flex_direction? : @mizchi/crater/types.FlexDirection
FlexDirection, flex_wrap? : @mizchi/crater/types.FlexWrap
FlexWrap, justify_content? : @mizchi/crater/types.Alignment
Alignment, align_items? : @mizchi/crater/types.Alignment
Alignment, align_content? : @mizchi/crater/types.Alignment
Alignment, gap? : Double, padding? : Double, padding_x? : Double, padding_y? : Double, margin? : Double, margin_x? : Double, margin_y? : Double, position? : @mizchi/crater/types.Position
Position, inset_top? : @mizchi/crater/types.Dimension
Dimension, inset_right? : @mizchi/crater/types.Dimension
Dimension, inset_bottom? : @mizchi/crater/types.Dimension
Dimension, inset_left? : @mizchi/crater/types.Dimension
Dimension, border? : BorderChars?, border_color? : Color, bg? : Color, fg? : Color, on_click? : () -> Unit?, role? : Role?) -> Component

Create a box component

char_display_width

source

fn char_display_width(c : Char) -> Int

Get display width of a character (1 for normal, 2 for wide/CJK)

spacer

source

fn spacer(flex_grow? : Double) -> Component

Spacer component - flexible empty space

string_display_width

source

fn string_display_width(s : String) -> Int

Calculate display width of a string

styled_text

source

fn styled_text(content : String, fg? : Color, bg? : Color, bold? : Bool, underline? : Bool) -> Component

Create a styled text (alias for text with labeled arguments)

text

source

fn text(content : String, fg? : Color, bg? : Color, bold? : Bool, underline? : Bool) -> Component

Create a text component

text_box

source

fn text_box(content : String, id? : String, width? : @mizchi/crater/types.Dimension
Dimension, height? : @mizchi/crater/types.Dimension
Dimension, min_width? : @mizchi/crater/types.Dimension
Dimension, min_height? : @mizchi/crater/types.Dimension
Dimension, max_width? : @mizchi/crater/types.Dimension
Dimension, max_height? : @mizchi/crater/types.Dimension
Dimension, flex_grow? : Double, flex_shrink? : Double, flex_basis? : @mizchi/crater/types.Dimension
Dimension, padding? : Double, padding_x? : Double, padding_y? : Double, margin? : Double, margin_x? : Double, margin_y? : Double, border? : BorderChars?, border_color? : Color, bg? : Color, fg? : Color, bold? : Bool, underline? : Bool) -> Component

Create a box with text content that wraps within the box's bounds Unlike text(), this renders the text directly within the box's layout dimensions

text_measure_func

source

fn text_measure_func(text : String) -> @mizchi/crater/types.MeasureFunc
MeasureFunc

Create a MeasureFunc for text that uses character width

Source Files

Site source Report issue Packages Build queue Skills Statistics

#BorderChars

#BorderChars::ascii

#BorderChars::double

#BorderChars::rounded

#BorderChars::single

#ClickHandler

#ClickHandler::inner

#ClickHandler::invoke

#ClickHandler::new

#ClickHandlers

#ClickHandlers::get

#ClickHandlers::inner

#ClickHandlers::iter

#ClickHandlers::new

#ClickHandlers::set

#Color

#Color::black

#Color::blue

#Color::cyan

#Color::from_crater

#Color::green

#Color::is_transparent

#Color::magenta

#Color::red

#Color::rgb

#Color::rgba

#Color::transparent

#Color::white

#Color::yellow

#Component

#RenderStyle

#RenderStyle::default

#RenderStyleMap

#RenderStyleMap::get

#RenderStyleMap::inner

#RenderStyleMap::new

#RenderStyleMap::set

#Role

#RoleMap

#RoleMap::get

#RoleMap::inner

#RoleMap::iter

#RoleMap::new

#RoleMap::set

#TextContentMap

#TextContentMap::get

#TextContentMap::inner

#TextContentMap::new

#TextContentMap::set

#box

#char_display_width

#spacer

#string_display_width

#styled_text

#text

#text_box

#text_measure_func

Source Files

BorderChars

BorderChars::ascii

BorderChars::double

BorderChars::rounded

BorderChars::single

ClickHandler

ClickHandler::inner

ClickHandler::invoke

ClickHandler::new

ClickHandlers

ClickHandlers::get

ClickHandlers::inner

ClickHandlers::iter

ClickHandlers::new

ClickHandlers::set

Color

Color::black

Color::blue

Color::cyan

Color::from_crater

Color::green

Color::is_transparent

Color::magenta

Color::red

Color::rgb

Color::rgba

Color::transparent

Color::white

Color::yellow

Component

RenderStyle

RenderStyle::default

RenderStyleMap

RenderStyleMap::get

RenderStyleMap::inner

RenderStyleMap::new

RenderStyleMap::set

Role

RoleMap

RoleMap::get

RoleMap::inner

RoleMap::iter

RoleMap::new

RoleMap::set

TextContentMap

TextContentMap::get

TextContentMap::inner

TextContentMap::new

TextContentMap::set

box

char_display_width

spacer

string_display_width

styled_text

text

text_box

text_measure_func