直接跳到内容

OptionList / Option 选项列表

OptionList 是带键盘导航的选项列表,使用 Option 定义每个选项。

底层:Textual OptionList

注意:当前不支持 OptionGroup 分组;请直接将 Option 作为 OptionList 的子节点。

基本用法

Props

OptionList

属性类型默认值说明
selectedintNone初始选中项的索引
highlightedintNone初始高亮项的索引

Option

属性类型默认值说明
promptstr必填,选项显示文字
idstrNone选项唯一 ID,用于通过代码获取选项

v-model

  • OptionListv-model 默认绑定属性 selected,双向绑定当前选中项索引
  • Optionv-model 默认绑定属性 prompt

事件

事件说明
@option_list_option_selected选项被 Enter 选中时触发(OptionList.OptionSelected),event.option.prompt 为选中文字,event.option_index 为索引
@option_list_option_highlighted键盘移动高亮时触发(OptionList.OptionHighlighted),event.option_index 为当前高亮索引

通过 ref 调用方法

方法说明
.get_option(option_id)通过 ID 获取选项对象
.get_option_index(option_id)通过 ID 获取选项索引
.highlighted属性,获取/设置当前高亮索引

通用属性

所有 Textual-vuepy 组件均支持以下属性:

属性类型说明
idstr组件 CSS ID
stylestrTCSS 内联样式
classstrTCSS 类名(空格分隔)
border_titlestr边框标题
border_subtitlestr边框副标题
OptionList / Option 选项列表已经加载完毕