vane-waterfall 2.0.2 → 2.0.3

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

@@ -1,50 +1,64 @@
-declare const _default: {
-  "name": "PaginationPlugin",
-  "description": "读 `props.pageIndex`（1 基）与 `props.pageSize` 切片。放在数据管线最末端，保证切的是「过滤 + 排序 + 搜索」之后的结果。",
-  "since": "2.0.0",
-  "tags": [
-    "data",
-    "数据管线",
-    "分页"
-  ],
-  "config": [
-    {
-      "name": "pageSize",
-      "type": "number",
-      "default": "props.pageSize ?? 20",
-      "description": "每页条数"
-    },
+declare const _default: {
+  "name": "PaginationPlugin",
+  "description": "读 `props.pageIndex`（1 基）与 `props.pageSize` 切片。放在数据管线最末端，保证切的是「过滤 + 排序 + 搜索」之后的结果。",
+  "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.pageIndex / pageSize 切片，页码从 1 开始。\nconst Waterfall = withPlugins(WaterfallCore, [\n  createPaginationPlugin({\n    scrollToTop: false,\n    scrollBehavior: \"auto\",\n  }),\n]);\n\n<Waterfall items={items} renderItem={(item) => <Card data={item} />} />;",
-  "conflicts": [
-    "InfiniteScrollPlugin"
-  ],
-  "features": [
-    "1 基页码（与 UI 分页器一致）",
-    "pageIndex 非法值自动夹到 1",
-    "翻页自动回顶可选"
-  ],
-  "useCases": [
-    "后台列表分页",
-    "搜索结果分页",
-    "与 URLSyncPlugin 配合做可分享链接"
-  ],
-  "notes": [
-    "pageSize 优先级：props.pageSize > 工厂 config.pageSize > 20。"
-  ]
-}
+  "methods": [],
+  "methodsNote": "只读取 context 字段（props / state / data），不调用上下文方法",
+  "config": [
+    {
+      "name": "pageSize",
+      "type": "number",
+      "default": "props.pageSize ?? 20",
+      "description": "每页条数"
+    },
+    {
+      "name": "scrollToTop",
+      "type": "boolean",
+      "default": "false",
+      "description": "翻页后回顶"
+    },
+    {
+      "name": "scrollBehavior",
+      "type": "\"auto\" | \"smooth\"",
+      "default": "\"auto\"",
+      "description": "回顶行为"
+    }
+  ],
+  "example": "// 按 props.pageIndex / pageSize 切片，页码从 1 开始。\nconst Waterfall = withPlugins(WaterfallCore, [\n  createPaginationPlugin({\n    scrollToTop: false,\n    scrollBehavior: \"auto\",\n  }),\n]);\n\n<Waterfall items={items} renderItem={(item) => <Card data={item} />} />;",
+  "conflicts": [
+    "InfiniteScrollPlugin"
+  ],
+  "features": [
+    "1 基页码（与 UI 分页器一致）",
+    "pageIndex 非法值自动夹到 1",
+    "翻页自动回顶可选"
+  ],
+  "useCases": [
+    "后台列表分页",
+    "搜索结果分页",
+    "与 URLSyncPlugin 配合做可分享链接"
+  ],
+  "notes": [
+    "pageSize 优先级：props.pageSize > 工厂 config.pageSize > 20。"
+  ]
+}
 ;
 
 export default _default;

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

@@ -1,4 +1,4 @@
-import { c as a, d as t } from "../../chunks/doc-DAieSXLy.js";
+import { c as a, d as t } from "../../chunks/doc-DlJICsyN.js";
 const n = Object.assign(a, { meta: t });
 export {
   n as createPaginationPlugin

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

@@ -1,43 +1,57 @@
-declare const _default: {
-  "name": "PinItemPlugin",
-  "description": "把若干索引的项钉在顶部指定列，其余项从它们下方继续排。走 D1-A 布局钩子（calculateItemPosition），是旧版宣称但从未生效的能力。",
-  "since": "2.0.0",
-  "tags": [
-    "layout",
-    "layout-hook",
-    "置顶"
-  ],
-  "config": [
+declare const _default: {
+  "name": "PinItemPlugin",
+  "description": "把若干索引的项钉在顶部指定列，其余项从它们下方继续排。走 D1-A 布局钩子（calculateItemPosition），是旧版宣称但从未生效的能力。",
+  "since": "2.0.0",
+  "tags": [
+    "layout",
+    "layout-hook",
+    "置顶"
+  ],
+  "events": [
     {
-      "name": "pinnedIndices",
-      "type": "number[]",
-      "default": "[]",
-      "description": "要钉住的项索引"
+      "name": "onBeforeLayout",
+      "when": "开始一次布局之前",
+      "description": "返回 false 可阻止本次布局（如数据仍在加载）"
     },
     {
-      "name": "column",
-      "type": "number",
-      "default": "0",
-      "description": "钉到第几列"
+      "name": "calculateItemPosition",
+      "when": "每个卡片参与布局时（拿到 index / item / columns）",
+      "description": "返回坐标片段可覆盖列分配结果（置顶、跨列、错位）"
     }
   ],
-  "example": "// 把指定索引的项钉在顶部同一列，不参与常规列高推进（广告位 / 公告卡）。\nconst Waterfall = withPlugins(WaterfallCore, [\n  createPinItemPlugin({\n    pinnedIndices: [],\n    column: 0,\n  }),\n]);\n\n<Waterfall items={items} renderItem={(item) => <Card data={item} />} />;",
-  "features": [
-    "置顶项不占常规列高：后续项从置顶块下方开始",
-    "支持多列分别置顶（column 可不同）",
-    "每次布局前重置偏移，items 变化后不会累加错位"
-  ],
-  "useCases": [
-    "信息流首位的推广卡",
-    "公告 / 置顶帖",
-    "需要固定在左上角的活动位"
-  ],
-  "notes": [
-    "置顶项之间按 pinnedIndices 顺序纵向堆叠，同一列多条会依次往下排。",
-    "置顶会挤掉该列的正常网格位置，pinnedIndices 建议控制在 1~2 条。",
-    "换列后的 x 由布局引擎按本轮列宽补齐，插件只返回 column 即可 —— 自己用「列宽 + 间距」反推 x 会在间距由其它插件（GapPlugin）注入时算错。"
-  ]
-}
+  "methods": [],
+  "methodsNote": "只读取 context 字段（props / state / data），不调用上下文方法",
+  "config": [
+    {
+      "name": "pinnedIndices",
+      "type": "number[]",
+      "default": "[]",
+      "description": "要钉住的项索引"
+    },
+    {
+      "name": "column",
+      "type": "number",
+      "default": "0",
+      "description": "钉到第几列"
+    }
+  ],
+  "example": "// 把指定索引的项钉在顶部同一列，不参与常规列高推进（广告位 / 公告卡）。\nconst Waterfall = withPlugins(WaterfallCore, [\n  createPinItemPlugin({\n    pinnedIndices: [],\n    column: 0,\n  }),\n]);\n\n<Waterfall items={items} renderItem={(item) => <Card data={item} />} />;",
+  "features": [
+    "置顶项不占常规列高：后续项从置顶块下方开始",
+    "支持多列分别置顶（column 可不同）",
+    "每次布局前重置偏移，items 变化后不会累加错位"
+  ],
+  "useCases": [
+    "信息流首位的推广卡",
+    "公告 / 置顶帖",
+    "需要固定在左上角的活动位"
+  ],
+  "notes": [
+    "置顶项之间按 pinnedIndices 顺序纵向堆叠，同一列多条会依次往下排。",
+    "置顶会挤掉该列的正常网格位置，pinnedIndices 建议控制在 1~2 条。",
+    "换列后的 x 由布局引擎按本轮列宽补齐，插件只返回 column 即可 —— 自己用「列宽 + 间距」反推 x 会在间距由其它插件（GapPlugin）注入时算错。"
+  ]
+}
 ;
 
 export default _default;

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

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

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

@@ -1,35 +1,64 @@
-declare const _default: {
-  "name": "RecyclePlugin",
-  "description": "纯绘制层优化：项离开视口就 `visibility: hidden`，回来再显示。DOM 节点不销毁，滚动位置与已加载的图片都保留，适合「项里有视频/Canvas，重建代价高」的场景。",
-  "since": "2.0.0",
-  "tags": [
-    "interaction",
-    "性能"
-  ],
-  "config": [
+declare const _default: {
+  "name": "RecyclePlugin",
+  "description": "纯绘制层优化：项离开视口就 `visibility: hidden`，回来再显示。DOM 节点不销毁，滚动位置与已加载的图片都保留，适合「项里有视频/Canvas，重建代价高」的场景。",
+  "since": "2.0.0",
+  "tags": [
+    "interaction",
+    "性能"
+  ],
+  "events": [
+    {
+      "name": "onUnmount",
+      "when": "瀑布流卸载前",
+      "description": "断开观察器、移除滚动监听"
+    },
+    {
+      "name": "onItemUnmount",
+      "when": "单个卡片卸载时",
+      "description": "解绑该卡片的监听与观察器"
+    },
+    {
+      "name": "onItemEnterViewport",
+      "when": "单个卡片进入视口",
+      "description": "卡片级曝光、视频自动播放等"
+    },
     {
-      "name": "poolSize",
-      "type": "number",
-      "default": "—",
-      "description": "同时保持可见的项数上限（超出则回收最早的）"
+      "name": "onItemLeaveViewport",
+      "when": "单个卡片离开视口",
+      "description": "暂停播放、回收资源"
     }
   ],
-  "example": "// 视口外的项设 `visibility: hidden`，降低长列表的绘制压力。\nconst Waterfall = withPlugins(WaterfallCore, [\n  createRecyclePlugin(),\n]);\n\n<Waterfall items={items} renderItem={(item) => <Card data={item} />} />;",
-  "features": [
-    "不销毁 DOM，只隐藏",
-    "项内媒体不重新加载",
-    "与虚拟化正交（一个省绘制、一个省节点）"
-  ],
-  "useCases": [
-    "项内含视频 / canvas",
-    "长列表滚动发虚",
-    "低端设备省电"
+  "methods": [
+    {
+      "name": "getItemRef",
+      "signature": "ctx.getItemRef(index: number): HTMLElement | null",
+      "description": "取第 index 张卡片的 DOM 引用，可能为 null（尚未挂载 / 已回收）"
+    }
   ],
-  "notes": [
-    "与 Core 的 `virtualize` 同开会让项被卸载又隐藏，收益互相抵消，建议只选一个。",
-    "只改 visibility 不改布局，所以不会引起重排。"
-  ]
-}
+  "config": [
+    {
+      "name": "poolSize",
+      "type": "number",
+      "default": "—",
+      "description": "同时保持可见的项数上限（超出则回收最早的）"
+    }
+  ],
+  "example": "// 视口外的项设 `visibility: hidden`，降低长列表的绘制压力。\nconst Waterfall = withPlugins(WaterfallCore, [\n  createRecyclePlugin(),\n]);\n\n<Waterfall items={items} renderItem={(item) => <Card data={item} />} />;",
+  "features": [
+    "不销毁 DOM，只隐藏",
+    "项内媒体不重新加载",
+    "与虚拟化正交（一个省绘制、一个省节点）"
+  ],
+  "useCases": [
+    "项内含视频 / canvas",
+    "长列表滚动发虚",
+    "低端设备省电"
+  ],
+  "notes": [
+    "与 Core 的 `virtualize` 同开会让项被卸载又隐藏，收益互相抵消，建议只选一个。",
+    "只改 visibility 不改布局，所以不会引起重排。"
+  ]
+}
 ;
 
 export default _default;

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

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

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

@@ -6,6 +6,35 @@ declare const _default: {
     "perf",
     "a11y"
   ],
+  "events": [
+    {
+      "name": "onUnmount",
+      "when": "瀑布流卸载前",
+      "description": "断开观察器、移除滚动监听"
+    },
+    {
+      "name": "onItemMount",
+      "when": "单个卡片挂载并拿到 DOM 元素时",
+      "description": "按卡片绑定监听、观察器、埋点"
+    },
+    {
+      "name": "onItemUnmount",
+      "when": "单个卡片卸载时",
+      "description": "解绑该卡片的监听与观察器"
+    },
+    {
+      "name": "onLayoutComplete",
+      "when": "DOM 落位完成（可安全测量）",
+      "description": "测量真实高度、懒加载判定、曝光上报"
+    },
+    {
+      "name": "transformProps",
+      "when": "渲染前链式改写瀑布流 props",
+      "description": "补 gap / columns 默认值、按断点覆盖配置"
+    }
+  ],
+  "methods": [],
+  "methodsNote": "只读取 context 字段（props / state / data），不调用上下文方法",
   "config": [
     {
       "name": "disableTransform",

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

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

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

@@ -1,37 +1,46 @@
-declare const _default: {
-  "name": "ResponsiveColumnsPlugin",
-  "description": "用一张断点表控制列数，命中哪档用哪档。走 D1-A 布局钩子（calculateColumns），按容器宽度匹配断点。",
-  "since": "2.0.0",
-  "tags": [
-    "layout",
-    "layout-hook",
-    "响应式"
-  ],
-  "config": [
+declare const _default: {
+  "name": "ResponsiveColumnsPlugin",
+  "description": "用一张断点表控制列数，命中哪档用哪档。走 D1-A 布局钩子（calculateColumns），按容器宽度匹配断点。",
+  "since": "2.0.0",
+  "tags": [
+    "layout",
+    "layout-hook",
+    "响应式"
+  ],
+  "events": [
     {
-      "name": "breakpoints",
-      "type": "Record<string, { width: number; columns: number }>",
-      "default": "—",
-      "description": "断点表，按 width 升序匹配"
+      "name": "calculateColumns",
+      "when": "每次布局前，询问列数",
+      "description": "返回列数则覆盖 props.columns；返回 undefined 沿用配置"
     }
   ],
-  "example": "// 按断点表决定列数（如 640 → 2 列、1024 → 3 列、1440 → 4 列）。\nconst Waterfall = withPlugins(WaterfallCore, [\n  createResponsiveColumnsPlugin(),\n]);\n\n<Waterfall items={items} renderItem={(item) => <Card data={item} />} />;",
-  "conflicts": [
-    "AutoColumnPlugin"
-  ],
-  "features": [
-    "断点表驱动，设计稿几档就写几档",
-    "按容器宽度而非视口宽度匹配",
-    "未命中任何断点时回退到 props.columns"
-  ],
-  "useCases": [
-    "严格对齐设计断点的站点",
-    "同一个组件嵌在不同宽度的容器里"
-  ],
-  "notes": [
-    "与 AutoColumnPlugin 互斥。"
-  ]
-}
+  "methods": [],
+  "methodsNote": "只读取 context 字段（props / state / data），不调用上下文方法",
+  "config": [
+    {
+      "name": "breakpoints",
+      "type": "Record<string, { width: number; columns: number }>",
+      "default": "—",
+      "description": "断点表，按 width 升序匹配"
+    }
+  ],
+  "example": "// 按断点表决定列数（如 640 → 2 列、1024 → 3 列、1440 → 4 列）。\nconst Waterfall = withPlugins(WaterfallCore, [\n  createResponsiveColumnsPlugin(),\n]);\n\n<Waterfall items={items} renderItem={(item) => <Card data={item} />} />;",
+  "conflicts": [
+    "AutoColumnPlugin"
+  ],
+  "features": [
+    "断点表驱动，设计稿几档就写几档",
+    "按容器宽度而非视口宽度匹配",
+    "未命中任何断点时回退到 props.columns"
+  ],
+  "useCases": [
+    "严格对齐设计断点的站点",
+    "同一个组件嵌在不同宽度的容器里"
+  ],
+  "notes": [
+    "与 AutoColumnPlugin 互斥。"
+  ]
+}
 ;
 
 export default _default;

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

@@ -1,4 +1,4 @@
-import { c as e, d as s } from "../../chunks/doc-DElLNjIc.js";
+import { c as e, d as s } from "../../chunks/doc-C206ZwYC.js";
 const n = Object.assign(e, { meta: s });
 export {
   n as createResponsiveColumnsPlugin

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