UI Package Documentation ¶

Auto-generated documentation for all exported functions in the UI package.

Quick Start ¶

1# Install the package
2go get github.com/emad-elsaid/ui
3
4# Generate documentation
5make docs

Table of Contents ¶

• Atoms (6 functions)
• Components (10 functions)
• Layouts (6 functions)
• Molecules (8 functions)
• Spacing (1 functions)
• Theme (9 functions)
• Utilities (32 functions)
• Widgets (5 functions)

Atoms ¶

• Background - Background fills the area behind a widget with the specified color.
• Border - Border wraps a widget with a border using the theme’s border color and size.
• BorderActive - BorderActive wraps a widget with an active/focused border color.
• HR - HR creates a horizontal rule (divider line) with the specified thickness.
• RoundedCorners - RoundedCorners applies rounded corners to any widget using the theme’s border…
• VR - VR creates a vertical rule (divider line) with the specified thickness.

Components ¶

• Button - Button creates a clickable button widget with accent colors and hover effects.
• Checkbox - Checkbox creates an interactive checkbox that calls onclick when toggled.
• CheckboxBool - CheckboxBool creates a checkbox that automatically toggles a boolean pointer.
• CheckboxBtn - CheckboxBtn creates a checkbox button widget that displays checked/unchecked …
• NewRadioGroup - NewRadioGroup creates a new radio button group with the specified number of o…
• RadioButton - RadioButton renders a single radio button with label
• RadioButtonIcon - RadioButtonIcon renders the radio button visual indicator
• TabButton - TabButton renders a single tab button with hover and active states.
• TextInput - TextInput creates a bordered text input field with optional hint text.
• ToolbarButton

Layouts ¶

• Centered - Centered centers a widget both vertically and horizontally in available space.
• Columns - Columns arranges flex children horizontally in a row layout.
• ColumnsVCentered - ColumnsVCentered arranges flex children horizontally with vertical centering.
• FormRow - FormRow creates a horizontal layout with vertical centering for form elements.
• Grid - Grid creates a responsive grid layout that adapts to available width.
• Rows - Rows arranges flex children vertically in a column layout.

Molecules ¶

• CircleFilled - CircleFilled renders a filled circle with the specified radius and color.
• CircleOutline - CircleOutline renders a circle outline with specified radius, color, and stro…
• RectangleFilled - RectangleFilled renders a filled rectangle with the specified dimensions and …
• RectangleOutline - RectangleOutline renders a rectangle outline with specified dimensions, color…
• SquareFilled - SquareFilled renders a filled square with the specified size and color.
• SquareOutline - SquareOutline renders a square outline with the specified size, color, and st…
• TriangleFilled - TriangleFilled renders a filled triangle defined by three points.
• TriangleOutline - TriangleOutline renders a triangle outline defined by three points.

Spacing ¶

• Margin

Theme ¶

• Color
• Font
• FontEnlarge
• FontSize
• FontWeight
• MixColor
• Text
• TextAlignment
• TextColor

Utilities ¶

• (*ClickableList).Layout
• (*DirectoryBrowser).Layout
• (*RadioGroup).Layout - Layout renders the radio group with the given labels
• (*Slideshow).Layout - Layout renders the slideshow with navigation controls
• (*Slideshow).Next - Next advances to the next slide
• (*Slideshow).Prev - Prev goes back to the previous slide
• (*Slideshow).SetCurrent - SetCurrent sets the current slide index
• (*Tabs).Layout
• Alpha
• Constraint - Constraint limits a widget’s maximum dimensions to the specified width and he…
• EmptyWidget
• GetExample - GetExample retrieves a registered example by name
• Icon - Icon creates a widget from icon bytes with the specified color.
• Label
• LayoutToWidget - LayoutToWidget converts a layout function that takes (C, W) into a standard w…
• LayoutToWrapper - LayoutToWrapper converts a layout function into a wrapper that returns a widg…
• LineEditor - LineEditor creates a single-line text editor configured to submit on Enter.
• Max
• MaxLines
• NewDirectoryBrowser
• OnClick - OnClick wraps any widget with click handling functionality.
• Panel - Panel creates a titled container with a bold header and content below.
• RegisterAllExamples - RegisterAllExamples registers all widget examples for documentation rendering
• RegisterExample - RegisterExample registers a widget for documentation rendering
• RunVisualTests - RunVisualTests runs multiple visual regression tests
• ShowWidget - ShowWidget opens a window displaying the widget for interactive development
• TestWidget - TestWidget runs a visual regression test for a widget
• TestWidgetWithConfig - TestWidgetWithConfig runs a visual regression test with custom configuration
• TestWidgetWithSize - TestWidgetWithSize runs a visual regression test with custom dimensions
• Tooltip
• WidgetIf
• Wrap

Widgets ¶

• Chart
• NewClickableList - NewClickableList creates a new clickable list with zebra striping.
• NewSlideshow - NewSlideshow creates a new slideshow with the given items
• NewVerticalList - NewVerticalList creates a new vertical scrollable list widget.
• ZebraList - ZebraList wraps a list with alternating row backgrounds for improved readabil…

---

Documentation generated with make docs