@serkonda7/solid-components 0.0.2 → 0.0.4

package/README.md

@@ -1,7 +1,7 @@
 # @serkonda7/solid-components
 [![CI][ci-badge]][ci-status]
 [![npm version][npm-badge]][npm-link]
-[![npm updated][npm-date-badge]][npm-link]
+[![npm updated and downloads][npm-date-dl-badge]][npm-link]
 
 Reusable components for [SolidJS](https://www.solidjs.com/).
 
@@ -14,31 +14,21 @@ bun install @serkonda7/solid-components solid-js
 
 ## 🚀 Usage
 ```tsx
-import { /* Component */ } from 'solid-components'
+import { DataTable } from '@serkonda7/solid-components'
 import '@serkonda7/solid-components/styles.css'
-```
-
-These components are available:
-- `DataTable` - generic table with optional sorting, row selection, actions, loading, and empty states.
-
-
-## Components
-### DataTable
-The table does not fetch data or perform navigation.
-Consumers provide the rows, cell rendering, and callbacks:
 
-```tsx
 <DataTable
   rows={items}
   getRowId={(item) => item.id}
-  columns={[{ key: 'name', label: 'Name', sortable: true }]}
-  sortKey={sortKey}
-  sortDirection={sortDirection}
-  onSort={setSortKey}
-  getCell={(item, column) => column.key === 'name' ? item.name : null}
+  columns={[{ key: 'name', label: 'Name' }]}
 />
 ```
 
+These components are available:
+- `DataTable` - generic table with optional sorting, row selection, actions, loading, empty states, and column customizer.
+
+For the full API, examples, and agent notes, see [docs.md](docs.md).
+
 
 ## 📜 License
 This repo is licensed under the [MIT License](LICENSE.txt).
@@ -47,5 +37,5 @@ This repo is licensed under the [MIT License](LICENSE.txt).
 [ci-badge]: https://github.com/serkonda7/solid-components/actions/workflows/ci.yml/badge.svg
 [ci-status]: https://github.com/serkonda7/solid-components/actions/workflows/ci.yml
 [npm-badge]: https://nodei.co/npm/@serkonda7/solid-components.png?style=shields&data=v&color=blue
-[npm-date-badge]: https://nodei.co/npm/@serkonda7/solid-components.png?style=shields&data=u&color=blue
+[npm-date-dl-badge]: https://nodei.co/npm/@serkonda7/solid-components.png?style=shields&data=u,d&color=blue
 [npm-link]: https://www.npmjs.com/package/@serkonda7/solid-components

package/dist/data-table.d.ts

@@ -1,12 +1,21 @@
 import type { Accessor, JSX } from 'solid-js';
 export type DataTableSortDirection = 'asc' | 'desc';
+export interface DataTableSort {
+    key: string;
+    direction: DataTableSortDirection;
+}
 export interface DataTableColumn<TRow> {
     key: string;
     label: string;
     sortable?: boolean;
+    sortValue?: (row: TRow) => unknown;
     class?: string;
     ariaLabel?: string;
     getValue?: (row: TRow) => JSX.Element;
+    /** Whether the column is visible by default when the column customizer is used. Defaults to `true`. */
+    defaultVisible?: boolean;
+    /** Whether the column can be hidden via the column customizer. Defaults to `true`. Non-toggleable columns are always shown. */
+    toggleable?: boolean;
 }
 export interface DataTableProps<TRow> {
     rows: TRow[] | Accessor<TRow[]>;
@@ -19,7 +28,18 @@ export interface DataTableProps<TRow> {
     selectionLabel?: string;
     sortKey?: string | Accessor<string | undefined>;
     sortDirection?: DataTableSortDirection | Accessor<DataTableSortDirection>;
+    defaultSort?: DataTableSort;
     onSort?: (key: string) => void;
+    onSortClear?: () => void;
+    onSortChange?: (sort: DataTableSort | undefined) => void;
+    visibleColumns?: string[] | Accessor<string[]>;
+    defaultVisibleColumns?: string[];
+    onVisibleColumnsChange?: (visibleKeys: string[]) => void;
+    showColumnCustomizer?: boolean | Accessor<boolean>;
+    columnCustomizerLabel?: string;
+    columnCustomizerTitle?: string;
+    columnCustomizerShowAllLabel?: string;
+    columnCustomizerResetLabel?: string;
     loading?: boolean | Accessor<boolean>;
     empty?: boolean | Accessor<boolean>;
     loadingContent?: JSX.Element;

package/dist/index.d.ts

@@ -4,4 +4,4 @@
  * Add components here as they are implemented so consumers can import them
  * from the package root.
  */
-export { DataTable, type DataTableColumn, type DataTableProps, type DataTableSortDirection, } from './data-table';
+export { DataTable, type DataTableColumn, type DataTableProps, type DataTableSort, type DataTableSortDirection, } from './data-table';

package/dist/index.js

@@ -1,49 +1,134 @@
 import { className as e, createComponent as t, delegateEvents as n, effect as r, insert as i, memo as a, setAttribute as o, template as s, use as c } from "solid-js/web";
-import { For as l, Show as u, createEffect as d, createMemo as f } from "solid-js";
+import { For as l, Show as u, createEffect as d, createMemo as f, createSignal as p, createUniqueId as m, onCleanup as h } from "solid-js";
 //#region src/data-table.tsx
-var p = /*#__PURE__*/ s("<th class=data-table-checkbox><span class=data-table-visually-hidden>Select rows</span><input type=checkbox>"), m = /*#__PURE__*/ s("<th>Actions"), h = /*#__PURE__*/ s("<div><table class=data-table><thead><tr></tr></thead><tbody>"), g = /*#__PURE__*/ s("<button type=button class=data-table-sort>"), _ = /*#__PURE__*/ s("<th>"), v = /*#__PURE__*/ s("<td class=data-table-checkbox><input type=checkbox>"), y = /*#__PURE__*/ s("<td>"), b = /*#__PURE__*/ s("<tr>"), x = /*#__PURE__*/ s("<p class=data-table-status>Loading…"), S = /*#__PURE__*/ s("<p class=data-table-status>No results.");
-function C(e) {
+var g = /*#__PURE__*/ s("<div role=dialog class=data-table-customizer-panel><p class=data-table-customizer-title></p><ul class=data-table-customizer-list></ul><div class=data-table-customizer-actions><button type=button></button><button type=button>"), ee = /*#__PURE__*/ s("<div class=data-table-toolbar><div class=data-table-customizer><button type=button class=data-table-customizer-button aria-haspopup=dialog><span aria-hidden=true>⚙</span> "), _ = /*#__PURE__*/ s("<th class=data-table-checkbox><span class=data-table-visually-hidden>Select rows</span><input type=checkbox>"), te = /*#__PURE__*/ s("<th>Actions"), v = /*#__PURE__*/ s("<div><div class=data-table-scroll><table class=data-table><thead><tr></tr></thead><tbody>"), y = /*#__PURE__*/ s("<li><label class=data-table-customizer-option><input type=checkbox>"), b = /*#__PURE__*/ s("<button type=button class=data-table-sort>"), ne = /*#__PURE__*/ s("<button type=button class=data-table-sort-clear aria-label=\"Clear sorting\"title=\"Clear sorting\">×"), re = /*#__PURE__*/ s("<th>"), ie = /*#__PURE__*/ s("<td class=data-table-checkbox><input type=checkbox>"), x = /*#__PURE__*/ s("<td>"), ae = /*#__PURE__*/ s("<tr>"), S = /*#__PURE__*/ s("<p class=data-table-status>Loading…"), C = /*#__PURE__*/ s("<p class=data-table-status>No results.");
+function w(e) {
 	return typeof e == "function" ? e() : e;
 }
-function w(n) {
-	let s = f(() => C(n.rows)), w = () => C(n.loading ?? !1), T = () => C(n.selected ?? []), E = () => C(n.sortKey ?? void 0), D = () => C(n.sortDirection ?? "asc"), O = () => n.selected !== void 0 && n.onSelectionChange !== void 0, k = () => {
-		let e = T();
+function T(n) {
+	let s = f(() => w(n.rows)), T = () => w(n.loading ?? !1), E = () => w(n.selected ?? []), D = n.sortKey !== void 0 || n.sortDirection !== void 0, [O, k] = p(n.defaultSort), A = () => D ? w(n.sortKey ?? void 0) : O()?.key, j = () => D ? w(n.sortDirection ?? "asc") : O()?.direction ?? "asc", M = () => w(n.showColumnCustomizer ?? !1), N = () => n.selected !== void 0 && n.onSelectionChange !== void 0, P = () => {
+		let e = E();
 		return s().length > 0 && s().every((t) => e.includes(n.getRowId(t)));
-	}, A;
+	}, F = f(() => n.defaultVisibleColumns ?? n.columns.filter((e) => e.defaultVisible !== !1).map((e) => e.key)), [I, L] = p(void 0), R = () => n.visibleColumns === void 0 ? I() ?? F() : w(n.visibleColumns), z = f(() => new Set(R())), B = f(() => n.columns.filter((e) => e.toggleable === !1 || z().has(e.key))), V = f(() => n.columns.filter((e) => e.toggleable !== !1)), H = f(() => V().map((e) => e.key));
+	function U(e, t) {
+		return t.sortValue ? t.sortValue(e) : e[t.key];
+	}
+	function W(e, t) {
+		return e === t ? 0 : e == null ? -1 : t == null ? 1 : typeof e == "number" && typeof t == "number" ? e - t : String(e).localeCompare(String(t), void 0, { numeric: !0 });
+	}
+	let G = f(() => {
+		let e = s(), t = A();
+		if (D || !t) return e;
+		let r = n.columns.find((e) => e.key === t);
+		if (!r) return e;
+		let i = j() === "asc" ? 1 : -1;
+		return [...e].sort((e, t) => i * W(U(e, r), U(t, r)));
+	});
+	function K(e) {
+		let t = {
+			key: e,
+			direction: A() === e && j() === "asc" ? "desc" : "asc"
+		};
+		D || k(t), n.onSort?.(e), n.onSortChange?.(t);
+	}
+	function q() {
+		D || k(void 0), n.onSortClear?.(), n.onSortChange?.(void 0);
+	}
+	function oe(e) {
+		let t = new Map(n.columns.map((e, t) => [e.key, t]));
+		return [...e].sort((e, n) => (t.get(e) ?? 0) - (t.get(n) ?? 0));
+	}
+	function J(e) {
+		let t = oe(e);
+		n.visibleColumns === void 0 && L(t), n.onVisibleColumnsChange?.(t);
+	}
+	function se(e, t) {
+		let n = new Set(R());
+		t ? n.add(e) : n.delete(e), J(H().filter((e) => n.has(e)));
+	}
+	function ce() {
+		J(H());
+	}
+	function le() {
+		J(F());
+	}
+	let Y = `${m()}-panel`, [X, Z] = p(!1), Q;
 	d(() => {
-		A && (A.indeterminate = T().length > 0 && !k());
+		if (!X() || !M()) return;
+		function e(e) {
+			Q && !Q.contains(e.target) && Z(!1);
+		}
+		function t(e) {
+			e.key === "Escape" && Z(!1);
+		}
+		document.addEventListener("pointerdown", e), document.addEventListener("keydown", t), h(() => {
+			document.removeEventListener("pointerdown", e), document.removeEventListener("keydown", t);
+		});
 	});
-	function j(e) {
+	let $;
+	d(() => {
+		$ && ($.indeterminate = E().length > 0 && !P());
+	});
+	function ue(e) {
 		n.onSelectionChange?.(e ? s().map(n.getRowId) : []);
 	}
-	function M(e, t) {
-		let r = n.getRowId(e), i = T(), a = t ? [...i, r] : i.filter((e) => e !== r);
+	function de(e, t) {
+		let r = n.getRowId(e), i = E(), a = t ? [...i, r] : i.filter((e) => e !== r);
 		n.onSelectionChange?.(a);
 	}
-	function N(e) {
-		return T().includes(n.getRowId(e));
+	function fe(e) {
+		return E().includes(n.getRowId(e));
+	}
+	function pe(e) {
+		return e.toggleable === !1 || z().has(e.key);
 	}
-	function P(e, t) {
+	function me(e, t) {
 		return n.getCell?.(e, t) ?? t.getValue?.(e) ?? null;
 	}
 	return (() => {
-		var d = h(), f = d.firstChild.firstChild, T = f.firstChild, F = f.nextSibling;
-		return i(T, t(u, {
+		var d = v(), f = d.firstChild, p = f.firstChild.firstChild, m = p.firstChild, h = p.nextSibling;
+		return i(d, t(u, {
+			get when() {
+				return M();
+			},
+			get children() {
+				var e = ee(), a = e.firstChild, s = a.firstChild;
+				s.firstChild.nextSibling;
+				var d = Q;
+				return typeof d == "function" ? c(d, a) : Q = a, s.$$click = () => Z((e) => !e), o(s, "aria-controls", Y), i(s, () => n.columnCustomizerLabel ?? "Columns", null), i(a, t(u, {
+					get when() {
+						return X();
+					},
+					get children() {
+						var e = g(), a = e.firstChild, s = a.nextSibling, c = s.nextSibling.firstChild, u = c.nextSibling;
+						return o(e, "id", Y), i(a, () => n.columnCustomizerTitle ?? "Shown columns"), i(s, t(l, {
+							get each() {
+								return n.columns;
+							},
+							children: (e) => (() => {
+								var t = y(), n = t.firstChild, a = n.firstChild;
+								return a.addEventListener("change", (t) => se(e.key, t.currentTarget.checked)), i(n, () => e.ariaLabel ?? e.label, null), r(() => a.disabled = e.toggleable === !1), r(() => a.checked = pe(e)), t;
+							})()
+						})), c.$$click = ce, i(c, () => n.columnCustomizerShowAllLabel ?? "Show all"), u.$$click = le, i(u, () => n.columnCustomizerResetLabel ?? "Reset"), r(() => o(e, "aria-label", n.columnCustomizerTitle ?? "Customize columns")), e;
+					}
+				}), null), r(() => o(s, "aria-expanded", X())), e;
+			}
+		}), f), i(m, t(u, {
 			get when() {
-				return O();
+				return N();
 			},
 			get children() {
-				var e = p(), t = e.firstChild.nextSibling;
-				t.addEventListener("change", (e) => j(e.currentTarget.checked));
-				var i = A;
-				return typeof i == "function" ? c(i, t) : A = t, r(() => o(t, "aria-label", n.selectionLabel ?? "Select all rows")), r(() => t.checked = k()), e;
+				var e = _(), t = e.firstChild.nextSibling;
+				t.addEventListener("change", (e) => ue(e.currentTarget.checked));
+				var i = $;
+				return typeof i == "function" ? c(i, t) : $ = t, r(() => o(t, "aria-label", n.selectionLabel ?? "Select all rows")), r(() => t.checked = P()), e;
 			}
-		}), null), i(T, t(l, {
+		}), null), i(m, t(l, {
 			get each() {
-				return n.columns;
+				return B();
 			},
 			children: (s) => (() => {
-				var c = _();
+				var c = re();
 				return i(c, t(u, {
 					get when() {
 						return a(() => !!s.sortable)() && n.onSort;
@@ -52,76 +137,86 @@ function w(n) {
 						return s.label;
 					},
 					get children() {
-						var e = g();
-						return e.$$click = () => n.onSort?.(s.key), i(e, () => s.label, null), i(e, (() => {
-							var e = a(() => E() === s.key);
-							return () => e() ? D() === "asc" ? " ▲" : " ▼" : "";
-						})(), null), e;
+						return [(() => {
+							var e = b();
+							return e.$$click = () => K(s.key), i(e, () => s.label, null), i(e, (() => {
+								var e = a(() => A() === s.key);
+								return () => e() ? j() === "asc" ? " ▲" : " ▼" : "";
+							})(), null), e;
+						})(), t(u, {
+							get when() {
+								return a(() => A() === s.key)() && (!D || n.onSortClear || n.onSortChange);
+							},
+							get children() {
+								var e = ne();
+								return e.$$click = q, e;
+							}
+						})];
 					}
 				})), r((t) => {
-					var n = s.class, r = s.sortable ? E() === s.key ? D() === "asc" ? "ascending" : "descending" : "none" : void 0;
+					var n = s.class, r = s.sortable ? A() === s.key ? j() === "asc" ? "ascending" : "descending" : "none" : void 0;
 					return n !== t.e && e(c, t.e = n), r !== t.t && o(c, "aria-sort", t.t = r), t;
 				}, {
 					e: void 0,
 					t: void 0
 				}), c;
 			})()
-		}), null), i(T, t(u, {
+		}), null), i(m, t(u, {
 			get when() {
 				return n.rowActions;
 			},
 			get children() {
-				return m();
+				return te();
 			}
-		}), null), i(F, t(l, {
+		}), null), i(h, t(l, {
 			get each() {
-				return s();
+				return G();
 			},
 			children: (a) => (() => {
-				var s = b();
+				var s = ae();
 				return i(s, t(u, {
 					get when() {
-						return O();
+						return N();
 					},
 					get children() {
-						var e = v(), t = e.firstChild;
-						return t.addEventListener("change", (e) => M(a, e.currentTarget.checked)), r(() => o(t, "aria-label", `Select row ${n.getRowId(a)}`)), r(() => t.checked = N(a)), e;
+						var e = ie(), t = e.firstChild;
+						return t.addEventListener("change", (e) => de(a, e.currentTarget.checked)), r(() => o(t, "aria-label", `Select row ${n.getRowId(a)}`)), r(() => t.checked = fe(a)), e;
 					}
 				}), null), i(s, t(l, {
 					get each() {
-						return n.columns;
+						return B();
 					},
 					children: (t) => (() => {
-						var n = y();
-						return i(n, () => P(a, t)), r(() => e(n, t.class)), n;
+						var n = x();
+						return i(n, () => me(a, t)), r(() => e(n, t.class)), n;
 					})()
 				}), null), i(s, t(u, {
 					get when() {
 						return n.rowActions;
 					},
 					get children() {
-						var e = y();
+						var e = x();
 						return i(e, () => n.rowActions?.(a)), e;
 					}
 				}), null), s;
 			})()
 		})), i(d, t(u, {
 			get when() {
-				return w();
+				return T();
 			},
 			get children() {
-				return n.loadingContent ?? x();
+				return n.loadingContent ?? S();
 			}
 		}), null), i(d, t(u, {
 			get when() {
-				return a(() => !w())() && (n.empty === void 0 ? s().length === 0 : C(n.empty));
+				return a(() => !T())() && (n.empty === void 0 ? s().length === 0 : w(n.empty));
 			},
 			get children() {
-				return n.emptyContent ?? S();
+				return n.emptyContent ?? C();
 			}
 		}), null), r(() => e(d, `data-table-wrap${n.class ? ` ${n.class}` : ""}`)), d;
 	})();
 }
 n(["click"]);
 //#endregion
-export { w as DataTable };
+export { T as DataTable };

package/dist/styles.css

@@ -1,7 +1,95 @@
 .data-table-wrap {
+	/* `color-scheme` is intentionally inherited so `light-dark()` below follows
+	the consumer's theme (e.g. the dark example). */
+}
+
+.data-table-scroll {
 	overflow-x: auto;
 }
 
+.data-table-toolbar {
+	display: flex;
+	justify-content: flex-end;
+	margin-bottom: 0.5rem;
+}
+
+.data-table-customizer {
+	position: relative;
+}
+
+.data-table-customizer-button {
+	display: inline-flex;
+	align-items: center;
+	gap: 0.375rem;
+	padding: 0.375rem 0.625rem;
+	border: 1px solid
+		var(--data-table-border, var(--border, light-dark(#d0d0d0, #3a3e45)));
+	border-radius: 0.375rem;
+	background: var(
+		--data-table-customizer-bg,
+		var(--surface, light-dark(#ffffff, #1d2024))
+	);
+	color: inherit;
+	font: inherit;
+	cursor: pointer;
+	white-space: nowrap;
+}
+
+.data-table-customizer-button:hover {
+	background: var(
+		--data-table-customizer-hover-bg,
+		var(--surface-hover, light-dark(#f5f5f5, #292d33))
+	);
+}
+
+.data-table-customizer-panel {
+	position: absolute;
+	top: calc(100% + 0.375rem);
+	right: 0;
+	z-index: 20;
+	min-width: 12rem;
+	padding: 0.75rem;
+	border: 1px solid
+		var(--data-table-border, var(--border, light-dark(#d0d0d0, #30343a)));
+	border-radius: 0.5rem;
+	background: var(
+		--data-table-panel-bg,
+		var(--surface, light-dark(#ffffff, #1d2024))
+	);
+	box-shadow: 0 8px 24px rgb(0 0 0 / 12%);
+}
+
+.data-table-customizer-title {
+	margin: 0 0 0.5rem;
+	font-weight: 600;
+}
+
+.data-table-customizer-list {
+	margin: 0;
+	padding: 0;
+	list-style: none;
+	display: grid;
+	gap: 0.375rem;
+}
+
+.data-table-customizer-option {
+	display: flex;
+	align-items: center;
+	gap: 0.5rem;
+	cursor: pointer;
+}
+
+.data-table-customizer-option:has(input:disabled) {
+	opacity: 0.6;
+	cursor: not-allowed;
+}
+
+.data-table-customizer-actions {
+	display: flex;
+	gap: 0.5rem;
+	margin-top: 0.75rem;
+}
+
 .data-table {
 	width: 100%;
 	max-width: 100%;
@@ -30,6 +118,22 @@
 	text-decoration: underline;
 }
 
+.data-table-sort-clear {
+	margin-left: 0.25rem;
+	padding: 0;
+	border: none;
+	background: transparent;
+	color: inherit;
+	font: inherit;
+	line-height: 1;
+	cursor: pointer;
+}
+
+.data-table-sort-clear:hover {
+	color: var(--data-table-sort-clear-hover, currentColor);
+	opacity: 0.7;
+}
+
 .data-table-status {
 	color: var(--text-secondary, #616161);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serkonda7/solid-components",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "Reusable components for SolidJS",
   "license": "MIT",
   "author": "serkonda7",