@witchcraft/ui 0.3.14 → 0.3.15

package/dist/runtime/components/LibTable/LibTable.vue.d.ts

@@ -1,3 +1,4 @@
+import { type VirtualizerOptions } from "@tanstack/vue-virtual";
 import { type TableHTMLAttributes } from "vue";
 import type { ResizableOptions, TableColConfig } from "../../types/index.js";
 import type { TailwindClassProp } from "../shared/props.js";
@@ -5,7 +6,6 @@ type T = any;
 type RealProps = {
     resizable?: Partial<ResizableOptions>;
     values?: T[];
-    itemKey?: keyof T | ((item: T) => string);
     /** Let's the table know the shape of the data since values might be empty. */
     cols?: (keyof T)[];
     rounded?: boolean;
@@ -13,6 +13,56 @@ type RealProps = {
     cellBorder?: boolean;
     header?: boolean;
     colConfig?: TableColConfig<T>;
+    /**
+     * See tanstack/vue-virtual {@link https://tanstack.com/virtual/latest/docs/api/virtualizer}
+     *
+     * The defaults are:
+     *
+     * - enabled: false
+     * - method: "fixed"
+     * - overscan: (50 if fixed, 10 if dynamic)
+     * - estimateSize: () => { return 33 }
+     *
+     * This also has an additional option, `method`, which can be set to `fixed` or `dynamic` (experimental).
+     *
+     * Notes:
+     *
+     * - Because of how virtualization works, initial layout (before .resizable-cols-setup class is applied) will only have access to the headers and not the rows. This can cause cols to look very small, especially if using resizable.fitWidth false.
+     *
+     * ### Fixed
+     *
+     * `fixed` is the default and will set the height of ALL items to the height of the first item onMounted (tanstack does not do this and if your estimateSize if off, the scrolling is weird).
+     *
+     * Since the table now truncates rows by default, they will always be the same height unless you change the inner styling. In fixed mode, `forceRecalculateFixedVirtualizer` is exposed if you need to force re-calculation.
+     *
+     * If using slots, be sure to at least pass the `class` slot prop to the td element. `style` with width is also supplied but is not required if you're displaying the table as a table.
+     *
+     * ### Dynamic (experimental)
+     *
+     * In `dynamic` mode we use tanstack's measureElement method. This is more expensive, but it will work with any heights.
+     *
+     * Dynamic mode also requires the table displays itself using grid and flex post setup as otherwise dynamic mode doesn't work.
+     *
+     * You don't need to do anything unless using slots. If using slots, pass the given `ref` slot prop to ref (internally this is tanstack's measureElement) and the class and style slot props at the very least:
+     * ```vue
+     * <template #[`${colName}`]="slotProps">
+     * 	<td
+     * 		:ref="slotProps.ref"
+     * 		:class="slotProps.class"
+     * 		:style="slotProps.style"
+     * 	>
+     * 		{{ slotProps.value }}
+     * 	</td>
+     * </template>
+     * ```
+     */
+    virtualizerOptions?: Partial<VirtualizerOptions<any, any>> & {
+        method?: "fixed" | "dynamic";
+    };
+    /** Whether to enable sticky header styles. This requires `border:false`. This moves the border to the wrapper and styles a straight border between the scroll bar and the rounded border. */
+    stickyHeader?: boolean;
+    /** Which key to use for the rows (only if not using virtualization). */
+    itemKey?: keyof T | ((item: T) => string);
 };
 interface Props extends 
 /** @vue-ignore */
@@ -20,18 +70,25 @@ Partial<Omit<TableHTMLAttributes, "class" | "readonly" | "disabled"> & TailwindC
 }
 declare const _default: <T>(__VLS_props: NonNullable<Awaited<typeof __VLS_setup>>["props"], __VLS_ctx?: __VLS_PrettifyLocal<Pick<NonNullable<Awaited<typeof __VLS_setup>>, "attrs" | "emit" | "slots">>, __VLS_expose?: NonNullable<Awaited<typeof __VLS_setup>>["expose"], __VLS_setup?: Promise<{
     props: __VLS_PrettifyLocal<Pick<Partial<{}> & Omit<{} & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, never>, never> & Props & {}> & import("vue").PublicProps;
-    expose(exposed: import("vue").ShallowUnwrapRef<{}>): void;
+    expose(exposed: import("vue").ShallowUnwrapRef<{
+        forceRecalculateFixedVirtualizer: () => void;
+    }>): void;
     attrs: any;
     slots: {
         [x: string]: ((props: {
             colKey: any;
             config: any;
-            style: string;
-            class: string;
+            style: {
+                width: any;
+            };
+            class: any;
         }) => any) | undefined;
     } & {
         [x: string]: ((props: {
-            class: string;
+            class: any;
+            style: {
+                width: any;
+            };
             item: any;
             value: any;
         }) => any) | undefined;

package/dist/runtime/directives/vResizableCols.js

@@ -25,8 +25,8 @@ export const vResizableCols = {
   },
   updated(el, { value: opts = {} }) {
     const options = override({ ...defaultOpts }, opts);
-    const info = el && getElInfo(el);
-    const hasGrips = el && elMap.get(el).grips;
+    const info = el && options.enabled && getElInfo(el);
+    const hasGrips = el && options.enabled && elMap.get(el)?.grips;
     const colsNotEqual = info && info.colCount !== options.colCount;
     if (hasGrips && !options.enabled || colsNotEqual) {
       teardownColumns(el);
@@ -88,7 +88,7 @@ function createPointerDownHandler(el) {
       e.preventDefault();
       document.addEventListener("pointerup", $el.pointerUpHandler);
       const { col, colNext } = getCols(el);
-      if (col === null || colNext === null) {
+      if (col === null || colNext === null && $el.fitWidth) {
         el.classList.add("resizable-cols-error");
       } else {
         document.addEventListener("pointermove", $el.pointerMoveHandler);
@@ -181,7 +181,7 @@ function getElInfo(el) {
 function getColEls(el) {
   const $el = elMap.get(el);
   if (!$el) unreachable("El went missing.");
-  return [...el.querySelectorAll(`:scope ${$el.selector ? $el.selector : "tr > td"}`)];
+  return [...el.querySelectorAll(`:scope ${$el.selector ? $el.selector : "tr > th, tr > td"}`)];
 }
 function setupColumns(el, opts) {
   const gripWidth = getTestGripSize(el);
@@ -196,7 +196,8 @@ function setupColumns(el, opts) {
     margin: opts.margin === "dynamic" ? gripWidth : opts.margin,
     colCount: opts.colCount,
     widths: opts.widths,
-    selector: opts.selector
+    selector: opts.selector,
+    onTeardown: opts.onTeardown
   };
   elMap.set(el, $el);
   const els = getColEls(el);
@@ -213,6 +214,7 @@ function setupColumns(el, opts) {
   }
   positionGrips(el);
   el.classList.add("resizable-cols-setup");
+  opts.onSetup?.(el);
 }
 function positionGrips(el) {
   let xPos = 0;
@@ -257,4 +259,5 @@ function teardownColumns(el) {
   elMap.delete(el);
   el.classList.remove("resizable-cols-setup");
   removeGrips(el);
+  $el.onTeardown?.(el);
 }

package/dist/runtime/types/index.d.ts

@@ -2,9 +2,7 @@ import type { ErrorW } from "@alanscodelog/utils";
 import type { Ref } from "vue";
 export type ResizableOptions = {
     /**
-     * Defaults to true.
-     *
-     * ### true
+     * ### true (default)
      * The directive will shrink/expand the columns when the table is resized and will use percentage widths on the table cells. This disables resizing of the last column (from the right handle).
      *
      * Additionally because of the way `table-layout:fixed` works, a min-width cannot be set on the elements via css, so instead, if the table shrinks past `opts.margin * col #`, `min-width` is set on the table until it's resized larger.
@@ -16,6 +14,8 @@ export type ResizableOptions = {
      * The table can be resized past it's normal width and uses pixel widths on the table cells. You might want to set `overscroll-x: scroll` on a parent wrapping element.
      *
      * This will set the table width to `min-content`, else it doesn't work. Note that it does this after the initial reading/setting of sizes so you can, for example, layout the table with `width: 100%`.
+     *
+     * @default true
      */
     fitWidth: boolean;
     /**
@@ -42,6 +42,10 @@ export type ResizableOptions = {
     widths: Ref<string[]>;
     /** The selector to use for the cells. "tr > td" by default. */
     selector: string;
+    /** Is called just after the `resizable-cols-setup` class is added. Can be useful for controlling the styling of wrappers or doing additional things post-setup. The default table element uses it to set the class on the wrapper also. */
+    onSetup?: (el: Element) => void;
+    /** Is called on teardown (after the `resizable-cols-setup` class is removed). */
+    onTeardown?: (el: Element) => void;
 };
 export type TableColConfig<T = {}> = Record<keyof T, {
     name?: string;

package/dist/runtime/utils/twMerge.d.ts

@@ -5,6 +5,7 @@ export declare const twMergeExtend: {
             "focus-outline": {
                 "focus-outline": string[];
             }[];
+            "no-truncate": string[];
         };
     };
 };

package/dist/runtime/utils/twMerge.js

@@ -2,7 +2,8 @@ import { extendTailwindMerge } from "tailwind-merge";
 const _twMergeExtend = {
   extend: {
     classGroups: {
-      "focus-outline": [{ "focus-outline": ["", "no-offset", "none"] }]
+      "focus-outline": [{ "focus-outline": ["", "no-offset", "none"] }],
+      "no-truncate": ["truncate", "no-truncate"]
     }
   }
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@witchcraft/ui",
-  "version": "0.3.14",
+  "version": "0.3.15",
   "description": "Vue component library.",
   "type": "module",
   "main": "./dist/runtime/main.lib.js",
@@ -89,6 +89,7 @@
     "@chromatic-com/storybook": "^3.2.7",
     "@commitlint/cli": "^19.8.1",
     "@internationalized/date": "^3.9.0",
+    "@faker-js/faker": "^10.0.0",
     "@nuxt/eslint-config": "^1.9.0",
     "@nuxt/module-builder": "^1.0.2",
     "@nuxtjs/i18n": "^9.5.6",
@@ -106,6 +107,7 @@
     "@storybook/test-runner": "^0.22.1",
     "@storybook/vue3": "^8.6.14",
     "@storybook/vue3-vite": "^8.6.14",
+    "@tanstack/vue-virtual": "^3.13.0",
     "@tailwindcss/cli": "^4.1.12",
     "@tailwindcss/postcss": "^4.1.12",
     "@types/node": "^24.3.0",

package/src/runtime/assets/utils.css

@@ -224,3 +224,8 @@
 	@apply cursor-pointer hover:text-accent-500;
 }
 
+@utility no-truncate {
+	text-overflow: unset;
+	overflow: visible;
+	white-space: normal;
+}

package/src/runtime/components/LibTable/LibTable.stories.ts

@@ -1,30 +1,61 @@
 /* eslint-disable @typescript-eslint/naming-convention */
+import { faker } from "@faker-js/faker"
 import type { Meta, StoryObj } from "@storybook/vue3"
+import { reactive, ref } from "vue"
 
 import LibTable from "./LibTable.vue"
 
 // todo
 import * as components from "../index.js"
 
+// faker is slow, we can just choose from a few hundred pre-generated sentences
+const fakerSentences = Array.from({ length: 100 }).fill(0).map(_ => faker.lorem.sentence(faker.number.int({ min: 1, max: 50 })))
+
 const meta: Meta<typeof LibTable> = {
 	component: LibTable as any,
 	title: "Components/Table"
 }
 
 export default meta
-type Story = StoryObj<typeof LibTable> & { args: { slots?: string } }
+type Story = StoryObj<typeof LibTable> & { args: {
+	slots?: string
+	wrapperClass?: string
+} }
 export const Primary: Story = {
 	render: args => ({
 		components,
-		setup: () => ({ args }),
+		setup: () => {
+			const show = ref(true)
+			// careful, storybook passes refs as is causing issues
+			//
+			const argsReactive = reactive({
+				...args,
+				resizable: {
+					enabled: true,
+					...args.resizable
+				}
+			})
+
+			return {
+				args: argsReactive,
+				show
+			}
+		},
 		template: `
-				<div class="overflow-x-scroll scrollbar-hidden">
-					<lib-table
-						v-bind="args"
-					>
-						${(args as any).slots}
-					</lib-table>
+				<div class="p-2 flex flex-col gap-2 border rounded-md mb-10">
+					Controls:
+					<div class="flex gap-2 w-full">
+						<LibButton class="flex-1" @click="args.resizable.enabled = !args.resizable.enabled">Toggle Resizable (currently {{args.resizable.enabled}})</LibButton>
+					</div>
+					<LibButton @click="args.stickyHeader = !args.stickyHeader">Toggle Sticky Header (currently {{args.stickyHeader}})</LibButton>
+					<LibButton @click="show = !show">Toggle Table</LibButton>
 				</div>
+				<lib-table
+					v-if="show"
+					v-bind="args"
+				>
+					${(args as any).slots}
+				</lib-table>
 		`
 	}),
 	args: {
@@ -34,8 +65,7 @@ export const Primary: Story = {
 			{ prop1: "Item2 Prop 1", prop2: "Item2 Prop 2", prop3: "Item2 Prop 3" },
 			{ prop1: "Item3 Prop 1", prop2: "Item3 Prop 2", prop3: "Item3 Prop 3" }
 		],
-		colConfig: { prop1: { name: "Header 1" }, prop2: { name: "Header 2" } },
-		itemKey: "prop1"
+		colConfig: { prop1: { name: "Header 1" }, prop2: { name: "Header 2" } }
 	}
 }
 
@@ -46,6 +76,7 @@ export const NoCellBorders: Story = {
 		cellBorder: false
 	}
 }
+
 export const NoBorders: Story = {
 	...Primary,
 	args: {
@@ -106,24 +137,27 @@ export const InitialSize: Story = {
 			enabled: true
 		},
 		class: `
+			[&:not(.resizable-cols-setup)]:w-full
 			[&:not(.resizable-cols-setup)]:block
 			[&:not(.resizable-cols-setup)_thead]:block
 			[&:not(.resizable-cols-setup)_thead_tr]:w-full
 			[&:not(.resizable-cols-setup)_thead_tr]:flex
 			[&:not(.resizable-cols-setup)_thead_tr]:flex-nowrap
-			[&:not(.resizable-cols-setup)_thead_td:not(.override-initial)]:flex-1
+			[&:not(.resizable-cols-setup)_thead_th:not(.override-initial)]:flex-1
 		`,
 		slots: `
 			<template #header-prop3="colProps">
-			<td
-				:class="\`\${colProps.class} w-[min-content] whitespace-nowrap override-initial\`"
-			>
-				{{ colProps.config.name }}
-			</td>
-		</template>
+				<th
+					:class="\`\${colProps.class} [table:not(.resizable-cols-setup)_&]:w-[min-content] whitespace-nowrap override-initial\`"
+					:style="colProps.style"
+				>
+					{{ colProps.config.name }}
+				</th>
+			</template>
 		`
 	}
 }
+
 export const FitWidthFalse: Story = {
 	...Primary,
 	args: {
@@ -134,6 +168,103 @@ export const FitWidthFalse: Story = {
 	}
 }
 
+
+export const StickyHeader: Story = {
+	...Primary,
+	args: {
+		...Primary.args,
+		resizable: {
+			enabled: true
+		},
+		stickyHeader: true,
+		// moving the border to the wrapper is to hide the little bits of border sticking out
+		// added back the right straight border otherwise the scrollbar looks ass
+		// this is ever so slightly visible if there is no scrollbar
+		wrapperClass: `
+			max-h-[50dvh]
+		`,
+		values: Array.from({ length: 200 }).fill(0).map((_, i) => ({
+			prop1: `Item${i + 1} Prop 1`,
+			prop2: `Item${i + 1} Prop 2`,
+			prop3: `Item${i + 1} Prop 3`
+		}))
+	}
+}
+
+
+export const VirtualizedFixedHeight: Story = {
+	...Primary,
+	args: {
+		...Primary.args,
+		resizable: {
+			enabled: true
+		},
+		virtualizerOptions: {
+			enabled: true
+		},
+		stickyHeader: true,
+		wrapperClass: `
+			max-h-[50dvh]
+		`,
+		values: Array.from({ length: 10000 }).fill(0).map((_, i) => ({
+			prop1: `Item${i + 1} Prop 1`,
+			prop2: `Item${i + 1} Prop 2`,
+			prop3: `Item${i + 1} Prop 3`
+		}))
+	}
+}
+
+
+// this is not the smoothest ever, but then the tan stack example isn't either
+// i think the issue is when the scrollbar gets to it's min height
+export const VirtualizedDynamicHeightExperimental: Story = {
+	...VirtualizedFixedHeight,
+	args: {
+		...VirtualizedFixedHeight.args,
+		virtualizerOptions: {
+			enabled: true,
+			method: "dynamic",
+			overscan: 5 // overscan is more expensive in dynamic mode
+		},
+		class: `
+			[&_td]:no-truncate!
+			[&_th]:no-truncate!
+		`,
+		values: Array.from({ length: 10000 }).fill(0).map((_, i) => ({
+			prop1: `Item${i + 1} Prop 1: ${faker.helpers.arrayElement(fakerSentences)}`,
+			prop2: `Item${i + 1} Prop 2: ${faker.helpers.arrayElement(fakerSentences)}`,
+			prop3: `Item${i + 1} Prop 3: ${faker.helpers.arrayElement(fakerSentences)}`
+		}))
+	}
+}
+
+
+export const VirtualizedFitWidthFalse: Story = {
+	...VirtualizedFixedHeight,
+	args: {
+		...VirtualizedFixedHeight.args,
+		resizable: {
+			fitWidth: false
+		},
+
+		class: `
+			[&_th]:no-truncate!
+			[&_th]:whitespace-nowrap!
+			[&:not(.resizable-cols-setup)]:w-max
+			[&:not(.resizable-cols-setup)_th]:w-max
+		`,
+		wrapperClass: `
+			max-h-[50dvh]
+		`,
+		values: Array.from({ length: 10000 }).fill(0).map((_, i) => ({
+			prop1: `Item${i + 1} Prop 1`,
+			prop2: `Item${i + 1} Prop 2`,
+			prop3: `Item${i + 1} Prop 3`
+		}))
+
+	}
+}
+
 export const ThreeColSomeColsNotResizable: Story = {
 	render: args => ({
 		components,