Cuttlefish Docs
  • 简体中文

    • APIs

    API 是可以用来在 JavaScript 代码中调用组件的公共方法。使用 SPZ.whenApiDefined 来获取组件的 API。

    API 用法

    <spz-render layout="container" id="render">
  <!-- ... -->
</spz-render>

<spz-script layout="logic" type="application/javascript">
  const render = document.getElementById('render');
  SPZ.whenApiDefined(render).then((apis) => {
    apis.render(data='Test data');
    // ...
  });
</spz-script>

    spz-render

    API说明类型
    render重新渲染元素。redo 可选项，用于指定重新渲染时是否先将上一次的渲染内容卸载掉(data, redo) => Promise
    getData获取渲染的数据() => Object | Array

    spz-list

    API说明类型
    refresh重新渲染元素。redo 可选项，用于指定重新渲染时是否先将上一次的属性重置(options, redo) => Promise
    getData获取渲染的数据() => Array

    AI 使用建议（LLM Ready）

    • 章节密度：检测到 3 个二级标题。
    • 示例密度：检测到 1 个代码块。
    • 先读结论：优先提取本页“定义、约束、边界条件”。
    • 再读证据：根据代码示例确认可执行写法，不直接依赖自然语言段落。
    • 最后联动：涉及组件时同步查看对应组件页，避免文档与实现偏差。