@heybox/hb-sdk API Reference - v0.9.5
    正在准备搜索索引...

    模块 card-controller

    接口

    BarChartOptions

    barChart 节点的可选项。

    ButtonOptions

    button 节点的可选项。

    CarouselOptions

    carousel 节点的可选项。

    FrameOptions

    frame 节点的可选项。

    GroupOptions

    group 节点的可选项。

    HStackOptions

    hstack 节点的可选项。

    ImageOptions

    image 节点的可选项。

    ListOptions

    list 节点的可选项。

    MeterOptions

    meter 节点的可选项。

    RadialProgressOptions

    radialProgress 节点的可选项。

    RegionOptions

    Region 的可选项。

    RendererOptions

    renderer 节点的可选项。

    TabsOptions

    tabs 节点的可选项。

    TextFieldOptions

    textField 节点的可选项。

    TextOptions

    text 节点的可选项。

    ToggleOptions

    switch 节点的可选项。

    ViewDocumentOptions

    ViewDocument 根的可选配置。

    WorkspaceCardActionHandle
    WorkspaceCardAuthorDefinition
    WorkspaceCardController
    WorkspaceCardControllerContext
    WorkspaceCardControllerResult
    WorkspaceCardDefinition
    WorkspaceCardsControllerAuthoring
    WorkspaceCardState

    类型别名

    BoxOptions

    容器节点的可选项;与 ViewBoxModifiers 同形。

    ViewAction

    节点动作。

    ViewDocument

    视图文档根。

    ViewNode

    视图文档中的一个内容节点。

    WorkspaceCardActionInputSchema
    WorkspaceCardDocuments
    WorkspaceCardJson
    WorkspaceCardRefreshContext

    静态类型收窄作者 API;运行期仍必须由 Extension 按触发来源重新校验。

    WorkspaceCardSize

    变量

    actionInput

    函数

    badge

    状态标记。

    barChart

    有限分类柱图;Runtime 提交原始非负值,宿主负责归一化和视觉配方。

    button

    按钮节点。

    可触摸、鼠标拖拽及键盘翻页的轮播容器;每个直接子节点是一页。

    defineAction

    工作区卡片 action 定义入口。

    defineCard

    工作区卡片定义入口。

    defineOpenMiniProgramAction

    打开小程序 action 定义入口。

    defineWorkspaceCardController

    定义控制器;构建器和 Host 分别验证静态 action 表。

    defineWorkspaceCardsController

    工作区卡片控制器定义入口。

    divider

    分隔线。

    expandable

    长文本展开控件;展开状态由宿主自持,不产生 Command 往返。

    fields

    标签值字段组;value 缺省时渲染 placeholder,不虚构字段。

    frame

    Frame 引用节点:文档只声明"在这里显示哪个引擎",iframe 与视图端口归 Runtime 侧的 frame 引擎。

    grid

    等宽多列网格。

    group

    带可选小标题的语义分组;渲染为带标题的 section,纵向排列。

    hstack

    横向排列子节点。

    icon

    图标节点。

    image

    图片节点。

    invoke

    生成固定受管 invoke 入口;身份由 Host 根据真实卡片绑定。

    list

    列表节点;条目 action 缺省即不可点击。

    meter

    横向比例条;可渐进增强为受控厚度、均匀刻度和多数据段。

    openMiniProgram

    只允许打开当前小程序。

    radialProgress

    环形进度;同时保留可访问名称与环内文本,不能只靠圆弧传达结果。

    region

    构造一个内容区域。

    renderer

    Renderer Module 逃生舱节点;尺寸静态声明,宿主渲染前即可预留空间。

    spacer

    吃掉父容器主轴剩余空间的弹性空隙;用于把同一行的内容推向两端。

    tabs

    分段容器;当前分段由宿主自持,不产生 Command 往返。

    text

    文本节点。

    textField

    文本输入字段;草稿由宿主持有,只有动作按 inputFrom 提交时才回送 Runtime。

    toggle

    胶囊开关;状态由 Runtime 持有,宿主只回送切换请求并等待新文档确认。

    viewDocument

    构造一个携带当前 schema 版本的视图文档。

    vstack

    纵向排列子节点。

    zstack

    层叠排列子节点;首个子节点决定尺寸,其余子节点铺满其上。