API 参考
brk 的全部能力都集中在 brk 命名空间下,
一共 10 项:2 个组件、2 个导航方法、1 个加载方法、3 个网络方法、2 个缓存容器。
这一页是总览,每项都会拆成单独的详细页。
组件
// 内置的两个 FunctionComponent全局统一的卡片组件。一个带边框、内边距、圆角的容器,用于承载内容块。 之所以内置,是因为它在页面里出现的频率极高——几乎每个独立内容单元都会被包一层。
用法和原生元素一致:<brk.card>...</brk.card>,返回 HTMLElement。
渲染一个 SVG 图标。底层使用 document.createElementNS 创建 SVG 命名空间下的节点,
因此属性处理方式与普通元素不同——尺寸、颜色等通过 styles 对象传入,而非 css 字符串。
d 是 SVG 路径数据;c 是颜色简写。
加载
// 动态引入模块
加载一个异步模块,本质是浏览器的动态 import()。
加载完成后返回模块对象,通常包含 page.vino。
页面之间互相加载、外壳挂载子页面、扩展能力挂到 brk 上——都走这里。
网络
// 三个最小 HTTP 封装发起 GET 请求,返回解析后的 JSON。用于拉取数据。
发起 POST 请求,提交 JSON body,返回解析后的 JSON。用于创建资源。
发起 PATCH 请求,提交 JSON body,返回解析后的 JSON。用于局部更新资源。
只提供 GET / POST / PATCH 三种最常用的语义。DELETE、PUT
等其余方法需要自行调用 fetch——这是"骨架"定位的一部分。
缓存
// 两个不同生命周期的存储
全局共享缓存,初始值为 {}。用于跨页面存放数据——
即使页面卸载,这里的数据依然保留。
典型用法:存登录态、主题偏好、用户信息、跨页面的业务数据。
一个以 DOM 为 key 的弱引用存储。把一个 DOM 元素作为 key, 就能挂上任意关联数据;当这个 DOM 被移除并被垃圾回收后,关联数据自动消失。
典型用法:把 { state, handlers } 挂到行 DOM 上,
父组件通过事件冒泡的 currentTarget 反查到对应的数据。
三个符号的语义
card、icon、opens、v、weak
直接以名字挂在 brk 上。它们要么是组件,要么是应用层高频使用的语义。
_load、_open、_json、_post、_edit
带下划线。它们是对浏览器原生能力的薄封装,属于"底层工具",
不常直接出现在业务代码里,也不鼓励被应用层覆盖。
v 是 value / vault 的缩写,
代表全局值容器;weak 直接取自 WeakMap。
这类名字只在 brk 命名空间下使用,不会污染全局。
这一页是总览。 每一项都会拆成单独的详细页,包含参数说明、返回值、示例、源码位置与注意事项。目前所有条目都已列出,但详细页尚未完成。