Raxol.View.Components (Raxol v2.0.1)

View Source

Basic view components for Raxol UI rendering.

This module provides fundamental components for building terminal UIs, including text, boxes, rows, columns, and other layout elements.

Summary

Functions

box(opts \\ [])

Creates a box component.

button(opts \\ [])

Creates a button component.

checkbox(opts \\ [])

Creates a checkbox component.

column(opts \\ [])

Creates a column layout component.

container(opts \\ [])

Creates a container component with optional scrolling.

divider(opts \\ [])

Creates a divider component.

input(opts \\ [])

Creates an input field component.

label(opts \\ [])

Creates a label component.

list(opts \\ [])

Creates a list component.

modal(opts \\ [])

Creates a modal component.

progress(opts \\ [])

Creates a progress bar component.

radio_group(opts \\ [])

Creates a radio button group component.

row(opts \\ [])

Creates a row layout component.

select(opts \\ [])

Creates a select/dropdown component.

spacer(opts \\ [])

Creates a spacer component.

span(content, opts \\ [])

Helper to wrap content in a styled span.

table(opts \\ [])

Creates a table component.

tabs(opts \\ [])

Creates a tabs component.

text(opts)

Creates a text component with the given content.

textarea(opts \\ [])

Creates a textarea component.

Functions

box(opts \\ [])

@spec box(keyword() | map()) :: map()

Creates a box component.

button(opts \\ [])

@spec button(keyword() | map()) :: map()

Creates a button component.

checkbox(opts \\ [])

@spec checkbox(keyword() | map()) :: map()

Creates a checkbox component.

column(opts \\ [])

@spec column(keyword() | map()) :: map()

Creates a column layout component.

container(opts \\ [])

@spec container(keyword() | map()) :: map()

Creates a container component with optional scrolling.

divider(opts \\ [])

@spec divider(keyword() | map()) :: map()

Creates a divider component.

input(opts \\ [])

@spec input(keyword() | map()) :: map()

Creates an input field component.

label(opts \\ [])

@spec label(keyword() | map()) :: map()

Creates a label component.

list(opts \\ [])

@spec list(keyword() | map()) :: map()

Creates a list component.

modal(opts \\ [])

@spec modal(keyword() | map()) :: map()

Creates a modal component.

progress(opts \\ [])

@spec progress(keyword() | map()) :: map()

Creates a progress bar component.

radio_group(opts \\ [])

@spec radio_group(keyword() | map()) :: map()

Creates a radio button group component.

row(opts \\ [])

@spec row(keyword() | map()) :: map()

Creates a row layout component.

select(opts \\ [])

@spec select(keyword() | map()) :: map()

Creates a select/dropdown component.

spacer(opts \\ [])

@spec spacer(keyword() | map()) :: map()

Creates a spacer component.

span(content, opts \\ [])

@spec span(
  binary(),
  keyword()
) :: map()

Helper to wrap content in a styled span.

table(opts \\ [])

@spec table(keyword() | map()) :: map()

Creates a table component.

tabs(opts \\ [])

@spec tabs(keyword() | map()) :: map()

Creates a tabs component.

text(opts)

@spec text(keyword() | map()) :: map()

Creates a text component with the given content.

Options

  • :content - The text content to display
  • :style - Optional style attributes
  • :id - Optional component identifier

textarea(opts \\ [])

@spec textarea(keyword() | map()) :: map()

Creates a textarea component.