vlist-solidjs 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Floor IO
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,82 @@
+# vlist-solidjs
+
+SolidJS primitives for [vlist](https://github.com/floor/vlist) - a lightweight, high-performance virtual list.
+
+## Installation
+
+```bash
+npm install vlist-solidjs @floor/vlist
+```
+
+## Quick Start
+
+```tsx
+import { createVList } from 'vlist-solidjs';
+import { createSignal } from 'solid-js';
+
+function MyList() {
+  const [items] = createSignal(
+    Array.from({ length: 10000 }, (_, i) => ({
+      id: i,
+      name: `Item ${i}`
+    }))
+  );
+
+  const { setRef, instance } = createVList(() => ({
+    items: items(),
+    item: {
+      height: 48,
+      template: (item) => `<div>${item.name}</div>`
+    }
+  }));
+
+  return <div ref={setRef} />;
+}
+```
+
+## API
+
+### `createVList(config)`
+
+Creates a virtual list instance.
+
+**Parameters:**
+- `config` - An accessor returning the vlist configuration (without container)
+
+**Returns:**
+- `setRef` - Ref callback to attach to the container element
+- `instance` - Accessor to the vlist instance
+
+### `createVListEvent(instance, event, handler)`
+
+Subscribe to vlist events.
+
+**Parameters:**
+- `instance` - The vlist instance accessor
+- `event` - Event name
+- `handler` - Event handler function
+
+**Example:**
+```tsx
+import { createVListEvent } from 'vlist-solidjs';
+
+createVListEvent(instance, 'item:click', ({ item, index }) => {
+  console.log('Clicked:', item, 'at index:', index);
+});
+```
+
+## Features
+
+All vlist features are supported:
+
+- **Selection** - Single and multiple selection modes
+- **Grid layout** - Multi-column grid virtualization
+- **Sections** - Grouped lists with sticky headers
+- **Infinite scroll** - Async data loading
+- **Horizontal** - Horizontal scrolling support
+- **Scale** - Handle 1M+ items with compression
+- **Scrollbar** - Custom scrollbar with auto-hide
+
+## License
+
+MIT © Floor IO

package/dist/index.d.ts

@@ -0,0 +1,14 @@
+/**
+ * SolidJS primitives for vlist - lightweight virtual scrolling
+ */
+import type { Accessor } from "solid-js";
+import type { VListConfig, VListItem, VListEvents, EventHandler } from "@floor/vlist";
+import { type BuiltVList } from "@floor/vlist";
+export type UseVListConfig<T extends VListItem = VListItem> = Omit<VListConfig<T>, "container">;
+export interface CreateVListReturn<T extends VListItem = VListItem> {
+    setRef: (el: HTMLDivElement) => void;
+    instance: Accessor<BuiltVList<T> | null>;
+}
+export declare function createVList<T extends VListItem = VListItem>(config: Accessor<UseVListConfig<T>>): CreateVListReturn<T>;
+export declare function createVListEvent<T extends VListItem, K extends keyof VListEvents<T>>(instance: Accessor<BuiltVList<T> | null>, event: K, handler: EventHandler<VListEvents<T>[K]>): void;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1 @@
+import{onMount as a,onCleanup as d,createEffect as m,on as p}from"solid-js";import{vlist as L}from"@floor/vlist";import{withAsync as g,withGrid as V,withSections as h,withSelection as u,withScrollbar as T,withScale as v,withSnapshots as b,withPage as y}from"@floor/vlist";function C(o){let n=null,i=null,r=(e)=>{n=e},l=()=>i;return a(()=>{if(!n)return;let e=o(),t=L({...e,container:n});if(e.scroll?.element===window)t=t.use(y());if(e.adapter)t=t.use(g({adapter:e.adapter,...e.loading&&{loading:e.loading}}));if(e.layout==="grid"&&e.grid)t=t.use(V(e.grid));if(e.groups){let s=e.groups,f=typeof s.headerHeight==="function"?s.headerHeight("",0):s.headerHeight;t=t.use(h({getGroupForIndex:s.getGroupForIndex,headerHeight:f,headerTemplate:s.headerTemplate,...s.sticky!==void 0&&{sticky:s.sticky}}))}if((e.selection?.mode||"none")!=="none")t=t.use(u(e.selection));else t=t.use(u({mode:"none"}));t=t.use(v());let c=e.scroll?.scrollbar||e.scrollbar;if(c!=="none"){let s=typeof c==="object"?c:{};t=t.use(T(s))}t=t.use(b()),i=t.build()}),m(p(()=>o().items,(e)=>{if(i&&e)i.setItems(e)})),d(()=>{if(i)i.destroy(),i=null}),{setRef:r,instance:l}}function H(o,n,i){a(()=>{let r=o();if(!r)return;let l=r.on(n,i);d(()=>{l()})})}export{H as createVListEvent,C as createVList};

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "vlist-solidjs",
+  "version": "0.1.0",
+  "description": "SolidJS primitives for vlist - lightweight virtual scrolling",
+  "author": {
+    "name": "Floor IO",
+    "url": "https://floor.io"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/floor/vlist-solidjs.git"
+  },
+  "keywords": [
+    "vlist",
+    "virtual-list",
+    "solidjs",
+    "solid",
+    "primitives",
+    "virtual-scrolling",
+    "typescript"
+  ],
+  "license": "MIT",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "peerDependencies": {
+    "@floor/vlist": "^0.6.0",
+    "solid-js": ">=1.0.0"
+  },
+  "files": [
+    "dist/**/*.js",
+    "dist/**/*.d.ts",
+    "!dist/**/*.d.ts.map"
+  ],
+  "scripts": {
+    "build": "bun run build.ts",
+    "dev": "bun run build.ts --watch",
+    "typecheck": "tsc --noEmit",
+    "prepublishOnly": "bun run build"
+  },
+  "devDependencies": {
+    "@floor/vlist": "link:../vlist",
+    "@types/bun": "^1.0.0",
+    "bun": "^1.0.0",
+    "solid-js": "^1.9.3",
+    "typescript": "^5.0.0"
+  }
+}