Keel v0.5.1 English GitHub

组件参考

ui/kit 提供现成的 el 视图。按用途从下面的分类找组件,每篇文档包含用法、API 和交互说明;在线文档中的示例可以直接操作。

基础展示

组件 用途
Label 可换行标签、次级文案与关键词高亮
Icon 矢量图标
Image 图片:异步加载、SVG、GIF 动图、内存与磁盘缓存、预览
Avatar 固定尺寸头像和姓名回退
AvatarGroup 叠放头像组、人数上限与溢出标记
Badge 数字/圆点/图标角标、尺寸与自定义颜色
Tag 可选择/移除标签,描边、尺寸、圆角、自定义内容与配色
Marker 纯图形标记
StatusMarker 消息状态、时间线边界和系统提示
Kbd 快捷键键帽、平台格式、独立/继承字号与自定义样式
DescriptionList 多列/跨列、横纵标签、自定义值与分隔线
GroupBox 标题/描述分组、外观、框外 footer 与样式配置

操作与导航

组件 用途
Button 操作按钮、图标、键盘与加载状态、选中状态
ButtonGroup 几个按钮连成一体,横向或竖向
Link 链接
CopyButton 复制并显示反馈
Tabs 四种外观、图标/富标签、单项禁用、宽度上限、滚动/溢出与拖动重排
Accordion 折叠面板、四档尺寸、边框开关
Collapsible 独立触发器与内容、可中断展开动画
Pagination 分页
Stepper 横纵步骤进度、图标、尺寸、单步禁用
Command 命令面板

输入与选择

组件 用途
Input / TextArea 文本框、前后缀、清空、错误
Input Group 输入/多行编辑器与四方向附加内容
Checkbox 复选框、半选
Switch 开关
Radio 可以放在任意位置的单个单选按钮
RadioGroup 单选组
Toggle 保持按下的按钮
ToggleGroup 单选或多选按钮组
Select 下拉选择、可搜索
Combobox 可筛选输入
NumberInput 数字输入
OtpInput 验证码、密码遮罩、分组与尺寸
TimeField 时间输入
Calendar 日历、范围
DatePicker 日期字段
Slider 线性/对数滑块、范围选择与结束回调
Rating 星级评分、已填星减分、自定义尺寸与颜色
ColorPicker 颜色选择
EmojiPicker 表情搜索、肤色和最近使用
Form 表单与校验
Questionnaire 分页问卷与答案模型

浮层与反馈

组件 用途
Popover 触发元素旁的非模态面板
Tooltip 富内容提示、动作键位与定位
HoverCard 悬停预览、实例延时与锚点定位
Menu 命令菜单与子菜单
DropdownButton 带菜单的按钮、分体按钮
Dialog 模态对话框、确认框;Show(cx) 不用放进视图树
Sheet 贴边滑入的模态面板,可拖动调整尺寸;Show(cx) 不用放进视图树
Notifier 八个方位的通知栈、富内容与操作、系统通知投递;WindowNotifier(cx) 是窗口自带的一个
Alert 行内/横幅提示、尺寸、图标与富内容,支持浅深色
Empty 空状态富内容、媒体、操作/尾部与分区样式
Spinner 不确定进度、减少动画、自定义图标/颜色/周期
Skeleton 占位、圆形、自定义圆角、次级色阶与 Shimmer 扫光
Progress 进度条、自定义高度/颜色/圆角与轨道样式
ProgressCircle 圆形进度、中心内容与不确定状态
ShimmerText 文字扫光
RisingGlow 上升淡入淡出的装饰粒子

列表与表格

组件 用途
List 长列表:单选/多选、搜索、分组、加载更多、状态插槽、拖动重排
VirtualList 等高虚拟列表
VariableList 自然高度虚拟列表、稳定 key 与阅读位置保持
Tree 树:懒加载、多选、拖动重排(自动展开与滚动)
Table 表格:排序、列宽、单元格插槽

聊天与内容

组件 用途
Message 对话消息
MessageContent 一条消息里混排多个气泡、附件和视图
MessageGroup 连续消息分组
Bubble 聊天气泡
BubbleGroup 连续气泡分组
MessageScroller 对话滚动区
Attachment 附件卡片
AttachmentGroup 横向排列、可滚动的附件组
CodeEditor 代码编辑器:高亮、补全、诊断、多光标、折叠、软换行、查找替换
Diff 文本比较、差异审阅与统一补丁
Terminal ANSI 终端显示与应用输入通道

图表与绘图

组件 用途
Chart 折线图、面积图、柱状图、堆叠柱状图
PieChart 饼图、环形图、交互图例
CandlestickChart 开高低收、密集聚合、数据表
RadarChart 雷达图
SankeyChart 桑基图
Plot 可缩放平移的 x/y 绘图
公共绘图基础件 ui/plot:自定义图表的比例尺与即时绘制

应用布局

组件 用途
TitleBar 无边框窗口的标题栏
GooeyDock 指针感应放大、弹簧上浮的 Dock
AppShell 应用布局、页面状态保留和切页动效
NavStack 保留页面状态的列表/详情导航栈
Sidebar 导航侧栏
Toolbar 工具栏与溢出菜单
StatusBar 固定 24dp 左右状态栏
Resizable 可拖动分隔的两栏
ResizableGroup 多面板分割,横纵和嵌套
Dock 可停靠面板、拆分、最大化、收起侧栏、跨窗口与布局保存
Settings 设置页
Carousel 轮播:多项视口、拖动、触控板与滚轮、循环轨道

公共用法

组件实例保存状态,应在构造视图时创建一次,保存在字段里,再在 Render(cx) 中使用。SetValue 是程序赋值,不触发 OnChange;用户操作才触发回调。后台更新遵守 线程规则。

浮层组件需要放在 el.Root 中。布局和组合见 元素与视图,颜色和尺寸见 主题,新增框架组件见 组件开发规范。

可选功能与体积

代码高亮和网络图片按需引入:

功能 引入 不引入时
代码高亮:CodeEditor、TextView、Markdown 代码块 _ "github.com/dyike/keel/ui/highlight" 显示纯文本
网络图片:Image、Avatar、Attachment、Markdown 的 http(s) 地址 _ "github.com/dyike/keel/ui/netimage" 本地文件和 data URL 照常,网络地址返回 core.ErrNoImageFetcher

两项各增加约 4 MB。keel build 默认去掉调试信息,只使用 kit 的应用约 10 MB。