Keel v0.5.1 中文 GitHub

Components

ui/kit provides ready-to-use el views. Browse by purpose below. Each page describes usage, APIs, and interaction behavior, with an interactive example on the documentation site.

Basics

Components Purpose
Label Wrapping labels, secondary text and keyword highlighting
Icon vector icon
Image Image: asynchronous loading, SVG, GIF animation, memory and disk cache, preview
Avatar Fixed size avatar and name fallback
AvatarGroup Stacked avatar groups, maximum number of people and overflow mark
Badge Number/dot/icon badge, size and custom color
Tag Select/remove tags, stroke, size, rounded corners, custom content and color
Marker Geometric markers
StatusMarker Message status, timeline boundaries and system prompts
Kbd Shortcut key caps, platform formats, independent/inherited font sizes and custom styles
DescriptionList Multiple columns/spanning columns, horizontal and vertical labels, custom values and separators
GroupBox Title/description grouping, appearance, outside-box footer and style configuration

Actions

Components Purpose
Button Operation buttons, icons, keyboard and loading state, selected state
ButtonGroup Several buttons connected into one, horizontal or vertical
Link Link
CopyButton Copy and show feedback
Tabs Four visual variants, icons/rich tags, single item disable, upper width limit, scrolling/overflow and drag rearrangement
Accordion Folding panel, four sizes, optional border
Collapsible Independent trigger and content, interruptible expansion animation
Pagination Pagination
Stepper Horizontal and vertical step progress, icon, size, single step disable
Command Command Panel

Inputs

Components Purpose
Input / TextArea Text box, suffix, clear, error
Input Group Input/multiline editor with four-way add-ons
Checkbox Checkbox with an indeterminate state
Switch switch
Radio A single radio button that can be placed anywhere
RadioGroup Radio group
Toggle Button with persistent pressed state
ToggleGroup Single- or multi-select button group
Select Drop-down selection, searchable
Combobox Filterable input
NumberInput Number input
OtpInput Verification code, password mask, grouping and size
TimeField Time input
Calendar calendar, range
DatePicker Date field
Slider Linear/logarithmic slider, range selection and end callback
Rating Star rating, points deduction for filled stars, custom size and color
ColorPicker Color selection
EmojiPicker Searchable emoji, skin tones and recent choices
Form Forms and validation
Questionnaire Paginated questionnaire and answer model

Overlays

Components Purpose
Popover Trigger non-modal panel next to element
Tooltip Rich content tips, action keys and positioning
HoverCard Hover preview, instance delay and anchor positioning
Menu Command menu and submenu
DropdownButton Button with menu, split button
Dialog Modal dialog box, confirmation box; Show(cx) does not need to be placed in the view tree
Sheet A modal panel that slides in and can be dragged to adjust the size; Show(cx) does not need to be placed in the view tree
Notifier Eight-directional notification stack, rich content and operations, system notification delivery; WindowNotifier(cx) is the one that comes with the window
Alert Inline/banner alerts, sizes, icons and rich content, supports light and dark colors
Empty Empty state rich content, media, actions/footer and per-part styling
Spinner Indeterminate progress, reduced animation, custom icon/color/cycle
Skeleton Placeholder, circle, custom rounded corner, secondary color level and Shimmer sweep
Progress Progress bar, custom height/color/rounded corners and track style
ProgressCircle Circle progress, center content and indeterminate state
ShimmerText Text sweep
RisingGlow Rising and fading decorative particles

Lists and tables

Components Purpose
List Long list: single/multiple selection, search, grouping, load more, status slots, drag to rearrange
VirtualList Equal height virtual list
VariableList Natural height virtual list, stable key and reading position maintenance
Tree Tree: lazy loading, multi-selection, dragging and rearranging (automatic expansion and scrolling)
Table Table: sorting, column width, cell slots

Chat

Components Purpose
Message Conversation message
MessageContent Mixing multiple bubbles, attachments and views in one message
MessageGroup Continuous message grouping
Bubble Chat Bubble
BubbleGroup Continuous bubble grouping
MessageScroller Conversation scrolling area
Attachment Attachment Card
AttachmentGroup Horizontally arranged, scrollable attachment group
CodeEditor Code editor: highlighting, completion, diagnosis, multi-cursor, folding, soft line wrapping, find and replace
Diff Text comparison, change review and unified patches
Terminal ANSI terminal output and application-owned input

Charts

Components Purpose
Chart Line chart, area chart, column chart, stacked column chart
PieChart Pie chart, donut chart, interactive legend
CandlestickChart Open/high/low/close data, dense-data aggregation, data table
RadarChart Radar Chart
SankeyChart Sankey Chart
Plot x/y plotting with zoom and pan
Shared plotting primitives ui/plot: Scales and immediate-mode drawing for custom charts

Layout

Components Purpose
TitleBar The title bar of a borderless window
GooeyDock Proximity magnification dock with spring lift
AppShell Retained application pages, navigation and page transitions
NavStack Retained list/detail navigation stack
Sidebar Navigation sidebar
Toolbar Toolbar and overflow menu
StatusBar Fixed 24dp left and right status bar
Resizable Draggable separated two columns
ResizableGroup Multi-panel splitting, vertical and horizontal and nesting
Dock Dockable panels, splitting, maximizing, collapsing sidebars, saving across windows and layouts
Settings Settings page
Carousel Carousel: multiple viewports, dragging, trackpad and wheel, loop track

Shared conventions

The component instance saves the state, which should be created once when constructing the view, saved in the field, and then used in Render(cx). SetValue is a programmatic assignment and does not trigger OnChange; only user operations trigger the callback. Background updates comply with threading rules.

The overlay component needs to be placed in el.Root. For layout and combination, see Elements and Views, for colors and sizes, see Theme, and for new frame components, see Component Development Specification.

Optional features and binary size

Code highlighting and network images are introduced on demand:

Function Import When not imported
Code highlighting: CodeEditor, TextView, Markdown code blocks _ "github.com/dyike/keel/ui/highlight" Display plain text
Network pictures: http(s) addresses for Image, Avatar, Attachment, Markdown _ "github.com/dyike/keel/ui/netimage" Local files and data URLs as usual, the network address returns core.ErrNoImageFetcher

Both items add approximately 4 MB each. keel build removes debugging information by default, and the application using only kit is about 10 MB.