vlist-vue 3.0.1 → 3.1.0-next.3

package/README.md

@@ -2,6 +2,21 @@
 
 Vue composable for [vlist](https://github.com/floor/vlist) — lightweight, zero-dependency virtual scrolling.
 
+> **Deprecated.** Use [`vlist/vue`](https://github.com/floor/vlist#frameworks) from the `vlist` package instead. Change the import path, and pass features as plugins:
+>
+> ```ts
+> // before
+> import { useVList } from "vlist-vue";
+> useVList({ items, item, selection: { mode: "single" } });
+>
+> // after
+> import { useVList } from "vlist/vue";
+> import { selection } from "vlist";
+> useVList({ items, item }, [selection({ mode: "single" })]);
+> ```
+>
+> From 3.1 this package is built on `vlist/vue` and keeps its config-based API, so existing code keeps working while you migrate. It needs `vlist ^3.1.0-next.3`; on vlist 3.0.x, stay on `vlist-vue` 3.0.x.
+
 ## Install
 
 ```bash
@@ -32,7 +47,7 @@ const { containerRef, instance } = useVList({
 ## API
 
 - **`useVList(config)`** — Creates a virtual list. Returns `{ containerRef, instance }`. Config can be a plain object or a reactive `Ref` for automatic updates.
-- **`useVListEvent(instance, event, handler)`** — Subscribe to vlist events; the subscription ends when the component unmounts (fixed in 3.0.1).
+- **`useVListEvent(instance, event, handler)`** — Subscribe to vlist events with automatic cleanup.
 
 Config accepts all [vlist options](https://vlist.dev/docs/api/reference) minus `container` (handled by the ref). Feature fields like `adapter`, `grid`, `groups`, `selection`, `scrollbar`, and `estimatedHeight` are resolved into plugins automatically.
 
@@ -42,18 +57,17 @@ Full usage guide, feature config examples, and TypeScript types: **[Framework Ad
 
 ## Synthetic input
 
-Requires `vlist ^3.0.0`. Pass the synthetic entry as `factory` to opt in; the adapter forwards it unchanged through `vlist/config`. `VListFactory` is re-exported for typed custom factories. The factory is selected at mount; remount to change it.
+Every list scrolls natively by default, and hands itself to synthetic input past the browser's element size limit: `scroll.mode` is `"auto"`. Pass `scroll: { mode: "synthetic" }` for synthetic input from the start, or `"native"` to stay native; the adapter forwards `scroll` unchanged through `vlist/config`. A synthetic list draws its own scrollbar. Requires `vlist ^3.1.0-next.3`. A carousel honours `"synthetic"` too. `VListFactory` is re-exported for typed custom factories.
 
 ```vue
 <script setup lang="ts">
 import { useVList } from "vlist-vue";
-import { createVList } from "vlist/synthetic";
 
 const items = Array.from({ length: 1000 }, (_, id) => ({ id }));
 const { containerRef } = useVList({
-  factory: createVList,
   items,
   item: { height: 48, template: item => String(item.id) },
+  scroll: { mode: "synthetic" },
 });
 </script>
 

package/dist/index.d.ts

@@ -1,10 +1,17 @@
 /**
  * Vue composable for vlist - lightweight virtual scrolling
+ *
+ * Deprecated: use `vlist/vue` from the vlist package, which takes features as
+ * plugins (`useVList({ items, item }, [selection()])`). This package keeps the
+ * config-based API on top of it: the composables are `vlist/vue`'s, building
+ * the list with `createVListFromConfig` so feature fields still resolve to
+ * plugins.
  */
-import { type Ref, type ShallowRef } from "vue";
-import type { VListItem, VListEvents, EventHandler } from "vlist";
-import type { VList } from "vlist";
+import type { Ref, ShallowRef } from "vue";
+import type { VListItem, VList } from "vlist";
 import { type VListConfig } from "vlist/config";
+import { useVListEvent } from "vlist/vue";
+export { useVListEvent };
 export type { VListItem, VListEvents, VList, CreateVListConfig, ItemConfig, ItemTemplate, EventHandler, Unsubscribe, } from "vlist";
 export type { VListConfig, VListFactory } from "vlist/config";
 /**
@@ -18,4 +25,3 @@ export interface UseVListReturn<T extends VListItem = VListItem> {
     instance: ShallowRef<VList<T> | null>;
 }
 export declare function useVList<T extends VListItem = VListItem>(configInput: UseVListConfig<T> | Ref<UseVListConfig<T>>): UseVListReturn<T>;
-export declare function useVListEvent<T extends VListItem, K extends keyof VListEvents<T>>(instanceRef: Ref<VList<T> | null> | ShallowRef<VList<T> | null>, event: K, handler: EventHandler<VListEvents<T>[K]>): void;

package/dist/index.js

@@ -1 +1 @@
-import{ref as D,shallowRef as K,onMounted as N,onBeforeUnmount as E,watch as G,isRef as O,unref as P}from"vue";import{createVListFromConfig as Q}from"vlist/config";function W(z){let A=D(null),j=K(null);if(N(()=>{let q=A.value;if(!q)return;let x=P(z);j.value=Q({...x,container:q})}),E(()=>{j.value?.destroy(),j.value=null}),O(z))G(()=>z.value.items,(q)=>{if(j.value&&q)j.value.setItems(q)});return{containerRef:A,instance:j}}function X(z,A,j){let q=D(j),x;G(()=>z.value,(H)=>{x?.(),x=H?.on(A,(J)=>q.value(J))},{immediate:!0}),E(()=>{x?.(),x=void 0})}export{X as useVListEvent,W as useVList};
+import{createVListFromConfig as k}from"vlist/config";import{useVList as q,useVListEvent as B}from"vlist/vue";var x=k;function D(j){return q(j,[],x)}export{B as useVListEvent,D as useVList};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vlist-vue",
-  "version": "3.0.1",
+  "version": "3.1.0-next.3",
   "description": "Vue composable for vlist - lightweight virtual scrolling",
   "author": {
     "name": "Floor IO",
@@ -32,7 +32,7 @@
     "./package.json": "./package.json"
   },
   "peerDependencies": {
-    "vlist": "^3.0.0",
+    "vlist": "^3.1.0-next.3",
     "vue": ">=3.0.0"
   },
   "files": [
@@ -52,7 +52,7 @@
     "@types/bun": "^1.0.0",
     "bun": "^1.0.0",
     "typescript": "^5.0.0",
-    "vlist": "^3.0.0",
+    "vlist": "3.1.0-next.3",
     "vue": "^3.5.28"
   }
 }