vane-waterfall 2.0.1 → 2.0.3

package/dist/custom-plugins/ScrollAnchorPlugin/doc.json.d.ts

@@ -1,34 +1,48 @@
-declare const _default: {
-  "name": "ScrollAnchorPlugin",
-  "description": "不需要自己算索引：外部只管 `bus.emit(\"anchor:scrollToId\", { id })`，插件用 getAnchorId 找到对应项并滚过去。适合「从消息跳到某条内容」。",
-  "since": "2.0.0",
-  "tags": [
-    "interaction",
-    "滚动"
-  ],
-  "config": [
+declare const _default: {
+  "name": "ScrollAnchorPlugin",
+  "description": "不需要自己算索引：外部只管 `bus.emit(\"anchor:scrollToId\", { id })`，插件用 getAnchorId 找到对应项并滚过去。适合「从消息跳到某条内容」。",
+  "since": "2.0.0",
+  "tags": [
+    "interaction",
+    "滚动"
+  ],
+  "events": [
+    {
+      "name": "onMount",
+      "when": "瀑布流挂载完成",
+      "description": "初始化观察器与滚动监听，返回清理函数"
+    },
     {
-      "name": "getAnchorId",
-      "type": "(item, index) => string | number | undefined",
-      "default": "item.id",
-      "description": "从项里取锚点 id"
+      "name": "onUnmount",
+      "when": "瀑布流卸载前",
+      "description": "断开观察器、移除滚动监听"
     }
   ],
-  "example": "// 监听 `anchor:scrollToId` 事件，按业务 id 滚动到对应项。\nconst Waterfall = withPlugins(WaterfallCore, [\n  createScrollAnchorPlugin({\n    getAnchorId: \"item.id\",\n  }),\n]);\n\n<Waterfall items={items} renderItem={(item) => <Card data={item} />} />;",
-  "features": [
-    "按业务 id 定位，不用算下标",
-    "onMount 订阅 / onUnmount 退订（不泄漏）",
-    "平滑滚动"
-  ],
-  "useCases": [
-    "从通知跳转到具体卡片",
-    "目录点击定位",
-    "外链深链定位"
-  ],
-  "notes": [
-    "目标项必须已在 items 里；分页场景请先切到对应页再发事件。"
-  ]
-}
+  "methods": [],
+  "methodsNote": "只读取 context 字段（props / state / data），不调用上下文方法",
+  "config": [
+    {
+      "name": "getAnchorId",
+      "type": "(item, index) => string | number | undefined",
+      "default": "item.id",
+      "description": "从项里取锚点 id"
+    }
+  ],
+  "example": "// 监听 `anchor:scrollToId` 事件，按业务 id 滚动到对应项。\nconst Waterfall = withPlugins(WaterfallCore, [\n  createScrollAnchorPlugin({\n    getAnchorId: \"item.id\",\n  }),\n]);\n\n<Waterfall items={items} renderItem={(item) => <Card data={item} />} />;",
+  "features": [
+    "按业务 id 定位，不用算下标",
+    "onMount 订阅 / onUnmount 退订（不泄漏）",
+    "平滑滚动"
+  ],
+  "useCases": [
+    "从通知跳转到具体卡片",
+    "目录点击定位",
+    "外链深链定位"
+  ],
+  "notes": [
+    "目标项必须已在 items 里；分页场景请先切到对应页再发事件。"
+  ]
+}
 ;
 
 export default _default;

package/dist/custom-plugins/ScrollAnchorPlugin/index.js

@@ -1,4 +1,4 @@
-import { c, d as o } from "../../chunks/doc-BXSy2aPP.js";
+import { c, d as o } from "../../chunks/doc-CHbQXLwY.js";
 const e = Object.assign(c, { meta: o });
 export {
   e as createScrollAnchorPlugin

package/dist/custom-plugins/SearchPlugin/doc.json.d.ts

@@ -1,47 +1,61 @@
-declare const _default: {
-  "name": "SearchPlugin",
-  "description": "读取 `props.searchQuery`，在指定字段上做大小写不敏感的 `includes` 匹配。没指定字段就对对象的全部自有字段匹配。",
-  "since": "2.0.0",
-  "tags": [
-    "data",
-    "数据管线",
-    "搜索"
-  ],
-  "config": [
-    {
-      "name": "fields",
-      "type": "(keyof T)[]",
-      "default": "[]",
-      "description": "参与匹配的字段；空则匹配全部自有字段"
-    },
+declare const _default: {
+  "name": "SearchPlugin",
+  "description": "读取 `props.searchQuery`，在指定字段上做大小写不敏感的 `includes` 匹配。没指定字段就对对象的全部自有字段匹配。",
+  "since": "2.0.0",
+  "tags": [
+    "data",
+    "数据管线",
+    "搜索"
+  ],
+  "events": [
     {
-      "name": "scrollToTop",
-      "type": "boolean",
-      "default": "false",
-      "description": "关键词变化后回顶"
+      "name": "onPropsChange",
+      "when": "props 变化后",
+      "description": "数据或配置变化时请求重排"
     },
     {
-      "name": "scrollBehavior",
-      "type": "\"auto\" | \"smooth\"",
-      "default": "\"auto\"",
-      "description": "回顶行为"
+      "name": "transformProps",
+      "when": "渲染前链式改写瀑布流 props",
+      "description": "补 gap / columns 默认值、按断点覆盖配置"
     }
   ],
-  "example": "// 按 props.searchQuery 做大小写不敏感的多字段包含匹配。\nconst Waterfall = withPlugins(WaterfallCore, [\n  createSearchPlugin({\n    fields: [],\n    scrollToTop: false,\n    scrollBehavior: \"auto\",\n  }),\n]);\n\n<Waterfall items={items} renderItem={(item) => <Card data={item} />} />;",
-  "features": [
-    "大小写不敏感",
-    "多字段 OR 匹配",
-    "空关键词直接放行（不触发过滤）"
-  ],
-  "useCases": [
-    "站内搜索结果页",
-    "后台列表即时搜索",
-    "商品名 / 店铺名联合搜索"
-  ],
-  "notes": [
-    "纯前端 `includes`，不排序也不做拼音；要相关性排序请在 Search 之后接 SortPlugin。"
-  ]
-}
+  "methods": [],
+  "methodsNote": "只读取 context 字段（props / state / data），不调用上下文方法",
+  "config": [
+    {
+      "name": "fields",
+      "type": "(keyof T)[]",
+      "default": "[]",
+      "description": "参与匹配的字段；空则匹配全部自有字段"
+    },
+    {
+      "name": "scrollToTop",
+      "type": "boolean",
+      "default": "false",
+      "description": "关键词变化后回顶"
+    },
+    {
+      "name": "scrollBehavior",
+      "type": "\"auto\" | \"smooth\"",
+      "default": "\"auto\"",
+      "description": "回顶行为"
+    }
+  ],
+  "example": "// 按 props.searchQuery 做大小写不敏感的多字段包含匹配。\nconst Waterfall = withPlugins(WaterfallCore, [\n  createSearchPlugin({\n    fields: [],\n    scrollToTop: false,\n    scrollBehavior: \"auto\",\n  }),\n]);\n\n<Waterfall items={items} renderItem={(item) => <Card data={item} />} />;",
+  "features": [
+    "大小写不敏感",
+    "多字段 OR 匹配",
+    "空关键词直接放行（不触发过滤）"
+  ],
+  "useCases": [
+    "站内搜索结果页",
+    "后台列表即时搜索",
+    "商品名 / 店铺名联合搜索"
+  ],
+  "notes": [
+    "纯前端 `includes`，不排序也不做拼音；要相关性排序请在 Search 之后接 SortPlugin。"
+  ]
+}
 ;
 
 export default _default;

package/dist/custom-plugins/SearchPlugin/index.js

@@ -1,4 +1,4 @@
-import { c as e, d as a } from "../../chunks/doc-CBHjiDG7.js";
+import { c as e, d as a } from "../../chunks/doc-RwKQqySd.js";
 const r = Object.assign(e, { meta: a });
 export {
   r as createSearchPlugin

package/dist/custom-plugins/SortPlugin/doc.json.d.ts

@@ -1,46 +1,60 @@
-declare const _default: {
-  "name": "SortPlugin",
-  "description": "用比较函数排序，优先读 `props.sortComparator`。排序总是在过滤之后、分页之前执行，保证「第 N 页」是排序后的第 N 页。",
-  "since": "2.0.0",
-  "tags": [
-    "data",
-    "数据管线"
-  ],
-  "config": [
-    {
-      "name": "comparator",
-      "type": "(a, b) => number",
-      "default": "—",
-      "description": "默认比较函数，可被 props.sortComparator 覆盖"
-    },
+declare const _default: {
+  "name": "SortPlugin",
+  "description": "用比较函数排序，优先读 `props.sortComparator`。排序总是在过滤之后、分页之前执行，保证「第 N 页」是排序后的第 N 页。",
+  "since": "2.0.0",
+  "tags": [
+    "data",
+    "数据管线"
+  ],
+  "events": [
     {
-      "name": "scrollToTop",
-      "type": "boolean",
-      "default": "false",
-      "description": "排序变化后回顶"
+      "name": "onPropsChange",
+      "when": "props 变化后",
+      "description": "数据或配置变化时请求重排"
     },
     {
-      "name": "scrollBehavior",
-      "type": "\"auto\" | \"smooth\"",
-      "default": "\"auto\"",
-      "description": "回顶行为"
+      "name": "transformProps",
+      "when": "渲染前链式改写瀑布流 props",
+      "description": "补 gap / columns 默认值、按断点覆盖配置"
     }
   ],
-  "example": "// 按比较函数排序 items，比较函数变化可自动回顶。\nconst Waterfall = withPlugins(WaterfallCore, [\n  createSortPlugin({\n    scrollToTop: false,\n    scrollBehavior: \"auto\",\n  }),\n]);\n\n<Waterfall items={items} renderItem={(item) => <Card data={item} />} />;",
-  "features": [
-    "稳定排序（不改原数组）",
-    "比较函数抛错按相等处理",
-    "与 Filter / Search 顺序固定"
-  ],
-  "useCases": [
-    "价格 / 时间排序",
-    "热度排序",
-    "手动置顶项优先"
-  ],
-  "notes": [
-    "排序会复制数组（`[...items].sort`），不会改调用方传入的 items。"
-  ]
-}
+  "methods": [],
+  "methodsNote": "只读取 context 字段（props / state / data），不调用上下文方法",
+  "config": [
+    {
+      "name": "comparator",
+      "type": "(a, b) => number",
+      "default": "—",
+      "description": "默认比较函数，可被 props.sortComparator 覆盖"
+    },
+    {
+      "name": "scrollToTop",
+      "type": "boolean",
+      "default": "false",
+      "description": "排序变化后回顶"
+    },
+    {
+      "name": "scrollBehavior",
+      "type": "\"auto\" | \"smooth\"",
+      "default": "\"auto\"",
+      "description": "回顶行为"
+    }
+  ],
+  "example": "// 按比较函数排序 items，比较函数变化可自动回顶。\nconst Waterfall = withPlugins(WaterfallCore, [\n  createSortPlugin({\n    scrollToTop: false,\n    scrollBehavior: \"auto\",\n  }),\n]);\n\n<Waterfall items={items} renderItem={(item) => <Card data={item} />} />;",
+  "features": [
+    "稳定排序（不改原数组）",
+    "比较函数抛错按相等处理",
+    "与 Filter / Search 顺序固定"
+  ],
+  "useCases": [
+    "价格 / 时间排序",
+    "热度排序",
+    "手动置顶项优先"
+  ],
+  "notes": [
+    "排序会复制数组（`[...items].sort`），不会改调用方传入的 items。"
+  ]
+}
 ;
 
 export default _default;

package/dist/custom-plugins/SortPlugin/index.js

@@ -1,4 +1,4 @@
-import { c as t, d as e } from "../../chunks/doc-BfWnfTst.js";
+import { c as t, d as e } from "../../chunks/doc-CInpKZNU.js";
 const r = Object.assign(t, { meta: e });
 export {
   r as createSortPlugin

package/dist/custom-plugins/StatePersistencePlugin/create.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"create.d.ts","sourceRoot":"","sources":["../../../src/custom-plugins/StatePersistencePlugin/create.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gDAAgD,CAAC;AAEtF,MAAM,MAAM,sBAAsB,GAAG;IACnC,wBAAwB;IACxB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,gBAAgB;IAChB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,6BAA6B;IAC7B,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;CACxB,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,4BAA4B,CAAC,CAAC,GAAG,GAAG,EAAE,MAAM,GAAE,sBAA2B,GAAG,eAAe,CAAC,CAAC,CAAC,CAiG7G"}
+{"version":3,"file":"create.d.ts","sourceRoot":"","sources":["../../../src/custom-plugins/StatePersistencePlugin/create.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,eAAe,EAEhB,MAAM,gDAAgD,CAAC;AAExD,MAAM,MAAM,sBAAsB,GAAG;IACnC,wBAAwB;IACxB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,gBAAgB;IAChB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,6BAA6B;IAC7B,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;CACxB,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,4BAA4B,CAAC,CAAC,GAAG,GAAG,EAAE,MAAM,GAAE,sBAA2B,GAAG,eAAe,CAAC,CAAC,CAAC,CAoH7G"}

package/dist/custom-plugins/StatePersistencePlugin/doc.json.d.ts

@@ -1,47 +1,81 @@
-declare const _default: {
-  "name": "StatePersistencePlugin",
-  "description": "三个时机各做一件事：首次渲染把快照里的 pageIndex / searchQuery 注入 props；挂载后恢复 scrollTop；props 变化与卸载时写回快照。刷新页面不丢进度。",
-  "since": "2.0.0",
-  "tags": [
-    "ui",
-    "持久化"
-  ],
-  "config": [
+declare const _default: {
+  "name": "StatePersistencePlugin",
+  "description": "三个时机各做一件事：首次渲染把快照里的 pageIndex / searchQuery 注入 props；挂载后恢复 scrollTop；props 变化与卸载时写回快照。刷新页面不丢进度。",
+  "since": "2.0.0",
+  "tags": [
+    "ui",
+    "持久化"
+  ],
+  "events": [
+    {
+      "name": "onMount",
+      "when": "瀑布流挂载完成",
+      "description": "初始化观察器与滚动监听，返回清理函数"
+    },
+    {
+      "name": "onUnmount",
+      "when": "瀑布流卸载前",
+      "description": "断开观察器、移除滚动监听"
+    },
     {
-      "name": "storageKey",
-      "type": "string",
-      "default": "\"waterfall-state\"",
-      "description": "localStorage 键名"
+      "name": "onPropsChange",
+      "when": "props 变化后",
+      "description": "数据或配置变化时请求重排"
     },
     {
-      "name": "persistScroll",
-      "type": "boolean",
-      "default": "true",
-      "description": "是否持久化滚动位置"
+      "name": "onLayoutComplete",
+      "when": "DOM 落位完成（可安全测量）",
+      "description": "测量真实高度、懒加载判定、曝光上报"
     },
     {
-      "name": "persistKeys",
-      "type": "string[]",
-      "default": "[\"pageIndex\",\"pageSize\",\"searchQuery\"]",
-      "description": "要持久化的 props 键"
+      "name": "transformProps",
+      "when": "渲染前链式改写瀑布流 props",
+      "description": "补 gap / columns 默认值、按断点覆盖配置"
+    },
+    {
+      "name": "state:restored",
+      "when": "从持久化恢复滚动位置 / 顺序后",
+      "description": "广播恢复后的状态快照"
     }
   ],
-  "example": "// 把滚动位置与分页/查询状态存 localStorage，回来时恢复。\nconst Waterfall = withPlugins(WaterfallCore, [\n  createStatePersistencePlugin({\n    storageKey: \"waterfall-state\",\n    persistScroll: true,\n    persistKeys: [\"pageIndex\",\"pageSize\",\"searchQuery\"],\n  }),\n]);\n\n<Waterfall items={items} renderItem={(item) => <Card data={item} />} />;",
-  "features": [
-    "滚动位置 + 分页/查询一起存",
-    "首帧注入只做一次，不会覆盖用户操作",
-    "SSR / 隐私模式下降级为不持久化"
-  ],
-  "useCases": [
-    "后台列表刷新不丢页",
-    "搜索结果返回定位",
-    "移动端来回切换页面"
-  ],
-  "notes": [
-    "只能恢复「值」，不能替你把它写回 React state——页面应订阅 `state:restored` 事件或读 bus。",
-    "localStorage 不可用（隐私模式/配额满）时静默跳过，不会抛错。"
-  ]
-}
+  "methods": [],
+  "methodsNote": "只读取 context 字段（props / state / data），不调用上下文方法",
+  "config": [
+    {
+      "name": "storageKey",
+      "type": "string",
+      "default": "\"waterfall-state\"",
+      "description": "localStorage 键名"
+    },
+    {
+      "name": "persistScroll",
+      "type": "boolean",
+      "default": "true",
+      "description": "是否持久化滚动位置"
+    },
+    {
+      "name": "persistKeys",
+      "type": "string[]",
+      "default": "[\"pageIndex\",\"pageSize\",\"searchQuery\"]",
+      "description": "要持久化的 props 键"
+    }
+  ],
+  "example": "// 把滚动位置与分页/查询状态存 localStorage，回来时恢复。\nconst Waterfall = withPlugins(WaterfallCore, [\n  createStatePersistencePlugin({\n    storageKey: \"waterfall-state\",\n    persistScroll: true,\n    persistKeys: [\"pageIndex\",\"pageSize\",\"searchQuery\"],\n  }),\n]);\n\n<Waterfall items={items} renderItem={(item) => <Card data={item} />} />;",
+  "features": [
+    "滚动位置 + 分页/查询一起存",
+    "首帧注入只做一次，不会覆盖用户操作",
+    "SSR / 隐私模式下降级为不持久化"
+  ],
+  "useCases": [
+    "后台列表刷新不丢页",
+    "搜索结果返回定位",
+    "移动端来回切换页面"
+  ],
+  "notes": [
+    "只能恢复「值」，不能替你把它写回 React state——页面应订阅 `state:restored` 事件或读 bus。",
+    "localStorage 不可用（隐私模式/配额满）时静默跳过，不会抛错。"
+  ]
+}
 ;
 
 export default _default;

package/dist/custom-plugins/StatePersistencePlugin/index.js

@@ -1,4 +1,4 @@
-import { c as e, d as t } from "../../chunks/doc-NhL4Ux8q.js";
+import { c as e, d as t } from "../../chunks/doc-RlBMCMNs.js";
 const a = Object.assign(e, { meta: t });
 export {
   a as createStatePersistencePlugin

package/dist/custom-plugins/StickyHeaderPlugin/create.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"create.d.ts","sourceRoot":"","sources":["../../../src/custom-plugins/StickyHeaderPlugin/create.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gDAAgD,CAAC;AAEtF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,sBAAsB;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,+BAA+B;IAC/B,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF;;;GAGG;AACH,wBAAgB,wBAAwB,CAAC,CAAC,GAAG,GAAG,EAAE,MAAM,GAAE,kBAAuB,GAAG,eAAe,CAAC,CAAC,CAAC,CAoCrG"}
+{"version":3,"file":"create.d.ts","sourceRoot":"","sources":["../../../src/custom-plugins/StickyHeaderPlugin/create.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gDAAgD,CAAC;AAEtF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,sBAAsB;IACtB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,+BAA+B;IAC/B,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF;;;GAGG;AACH,wBAAgB,wBAAwB,CAAC,CAAC,GAAG,GAAG,EAAE,MAAM,GAAE,kBAAuB,GAAG,eAAe,CAAC,CAAC,CAAC,CA6CrG"}

package/dist/custom-plugins/StickyHeaderPlugin/doc.json.d.ts

@@ -1,40 +1,49 @@
-declare const _default: {
-  "name": "StickyHeaderPlugin",
-  "description": "在滚动容器内渲染一条 `position: sticky` 的标题条，始终贴住容器顶部。装了 GroupingPlugin 时自动显示第一个分组名，也可用 title 写死。",
-  "since": "2.0.0",
-  "tags": [
-    "ui",
-    "吸顶"
-  ],
-  "config": [
-    {
-      "name": "title",
-      "type": "string",
-      "default": "\"分组标题\"",
-      "description": "标题文案"
-    },
+declare const _default: {
+  "name": "StickyHeaderPlugin",
+  "description": "在滚动容器内渲染一条 `position: sticky` 的标题条，始终贴住容器顶部。装了 GroupingPlugin 时自动显示第一个分组名，也可用 title 写死。",
+  "since": "2.0.0",
+  "tags": [
+    "ui",
+    "吸顶"
+  ],
+  "events": [
     {
-      "name": "showHint",
-      "type": "boolean",
-      "default": "false",
-      "description": "是否显示「向下滚动观察」提示"
+      "name": "renderOverlay",
+      "when": "每次渲染，滚动容器内的内容层之上",
+      "description": "回到顶部、加载提示、浮层工具"
     }
   ],
-  "example": "// 滚动容器内的吸顶标题条，可与分组联动显示当前组。\nconst Waterfall = withPlugins(WaterfallCore, [\n  createStickyHeaderPlugin({\n    title: \"分组标题\",\n    showHint: false,\n  }),\n]);\n\n<Waterfall items={items} renderItem={(item) => <Card data={item} />} />;",
-  "features": [
-    "sticky 吸顶，不依赖额外容器",
-    "与 Grouping 联动显示当前组",
-    "提示文案默认关闭"
-  ],
-  "useCases": [
-    "分组信息流",
-    "按日期分组的时间线",
-    "长列表的上下文提示"
-  ],
-  "notes": [
-    "sticky 生效要求它作为滚动容器的直接子元素——由 composeSlots 保证，单测已锁。"
-  ]
-}
+  "methods": [],
+  "methodsNote": "只读取 context 字段（props / state / data），不调用上下文方法",
+  "config": [
+    {
+      "name": "title",
+      "type": "string",
+      "default": "\"分组标题\"",
+      "description": "标题文案"
+    },
+    {
+      "name": "showHint",
+      "type": "boolean",
+      "default": "false",
+      "description": "是否显示「向下滚动观察」提示"
+    }
+  ],
+  "example": "// 滚动容器内的吸顶标题条，可与分组联动显示当前组。\nconst Waterfall = withPlugins(WaterfallCore, [\n  createStickyHeaderPlugin({\n    title: \"分组标题\",\n    showHint: false,\n  }),\n]);\n\n<Waterfall items={items} renderItem={(item) => <Card data={item} />} />;",
+  "features": [
+    "sticky 吸顶，不依赖额外容器",
+    "与 Grouping 联动显示当前组",
+    "提示文案默认关闭"
+  ],
+  "useCases": [
+    "分组信息流",
+    "按日期分组的时间线",
+    "长列表的上下文提示"
+  ],
+  "notes": [
+    "sticky 生效要求它作为滚动容器的直接子元素——由 composeSlots 保证，单测已锁。"
+  ]
+}
 ;
 
 export default _default;

package/dist/custom-plugins/StickyHeaderPlugin/index.js

@@ -1,4 +1,4 @@
-import { c as e, d as t } from "../../chunks/doc-BtzhgTYj.js";
+import { c as e, d as t } from "../../chunks/doc-DtxS1-P0.js";
 const c = Object.assign(e, { meta: t });
 export {
   c as createStickyHeaderPlugin

package/dist/custom-plugins/ThrottlePlugin/doc.json.d.ts

@@ -1,40 +1,49 @@
-declare const _default: {
-  "name": "ThrottlePlugin",
-  "description": "接管 Core 的 throttleDelay（滚动回调节流）与 debounceDelay（尺寸变化后多久重排）。默认 16ms / 150ms，长列表滚动卡顿时可以放宽到 32 / 300。",
-  "since": "2.0.0",
-  "tags": [
-    "perf",
-    "性能"
-  ],
-  "config": [
-    {
-      "name": "scroll",
-      "type": "number",
-      "default": "—",
-      "description": "滚动节流 ms（必填）"
-    },
+declare const _default: {
+  "name": "ThrottlePlugin",
+  "description": "接管 Core 的 throttleDelay（滚动回调节流）与 debounceDelay（尺寸变化后多久重排）。默认 16ms / 150ms，长列表滚动卡顿时可以放宽到 32 / 300。",
+  "since": "2.0.0",
+  "tags": [
+    "perf",
+    "性能"
+  ],
+  "events": [
     {
-      "name": "resize",
-      "type": "number",
-      "default": "props.debounceDelay",
-      "description": "布局防抖 ms"
+      "name": "transformProps",
+      "when": "渲染前链式改写瀑布流 props",
+      "description": "补 gap / columns 默认值、按断点覆盖配置"
     }
   ],
-  "example": "// 调整滚动节流与尺寸防抖，弱网/低端机可放宽。\nconst Waterfall = withPlugins(WaterfallCore, [\n  createThrottlePlugin(),\n]);\n\n<Waterfall items={items} renderItem={(item) => <Card data={item} />} />;",
-  "features": [
-    "滚动节流与布局防抖分开调",
-    "只改 props，不改算法",
-    "与 DebounceLayoutPlugin 叠加时后者优先"
-  ],
-  "useCases": [
-    "低端安卓机长列表",
-    "滚动时 CPU 占用过高",
-    "拖拽侧栏时减少重排"
-  ],
-  "notes": [
-    "scroll 低于 16ms 没有意义（浏览器帧率上限）。"
-  ]
-}
+  "methods": [],
+  "methodsNote": "只读取 context 字段（props / state / data），不调用上下文方法",
+  "config": [
+    {
+      "name": "scroll",
+      "type": "number",
+      "default": "—",
+      "description": "滚动节流 ms（必填）"
+    },
+    {
+      "name": "resize",
+      "type": "number",
+      "default": "props.debounceDelay",
+      "description": "布局防抖 ms"
+    }
+  ],
+  "example": "// 调整滚动节流与尺寸防抖，弱网/低端机可放宽。\nconst Waterfall = withPlugins(WaterfallCore, [\n  createThrottlePlugin(),\n]);\n\n<Waterfall items={items} renderItem={(item) => <Card data={item} />} />;",
+  "features": [
+    "滚动节流与布局防抖分开调",
+    "只改 props，不改算法",
+    "与 DebounceLayoutPlugin 叠加时后者优先"
+  ],
+  "useCases": [
+    "低端安卓机长列表",
+    "滚动时 CPU 占用过高",
+    "拖拽侧栏时减少重排"
+  ],
+  "notes": [
+    "scroll 低于 16ms 没有意义（浏览器帧率上限）。"
+  ]
+}
 ;
 
 export default _default;

package/dist/custom-plugins/ThrottlePlugin/index.js

@@ -1,4 +1,4 @@
-import { c as t, d as e } from "../../chunks/doc-DzvTrZ13.js";
+import { c as t, d as e } from "../../chunks/doc-CaJ02INP.js";
 const r = Object.assign(t, { meta: e });
 export {
   r as createThrottlePlugin