@ui-organized/svelte-table 0.0.0-stage → 6.0.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative
+          Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 arossi58
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,100 @@
-# Temporary Holding Version
+# @ui-organized/svelte-table
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The Svelte data table for the ui-organized design system, built on
+[`@ui-organized/table-core`](../table-core) — the same framework-free engine the
+React, Vue and Angular tables use. Same class names, same stylesheet, same token contract,
+no fork of the logic.
+
+## Stylesheets
+
+The table's stylesheet goes after the component library's, once, at your app
+entry. The snippets below import it inline for brevity; in an app, keep all of
+these together in this order:
+
+```ts
+import "@ui-organized/tokens/variables.css";
+import "@ui-organized/svelte/styles";
+import "@ui-organized/svelte-table/styles"; // after the component styles
+import "./styles/theme.css"; // your theme, last
+```
+
+## Three layers
+
+| Layer        | What it is                                                   |
+| ------------ | ------------------------------------------------------------ |
+| 1 — headless | `createDataTable(() => options)`                             |
+| 2 — parts    | `TableHeader`, `TableRow`, `TableToolbar`, `TableFilters`, … |
+| 3 — wrapper  | `<DataTable>` — the whole table from a props object          |
+
+## Using it
+
+```svelte
+<script lang="ts">
+  import { DataTable, type TableColumn } from "@ui-organized/svelte-table";
+  import "@ui-organized/svelte-table/styles";
+
+  interface Member { id: string; name: string; role: string }
+  let { members }: { members: Member[] } = $props();
+
+  const columns: TableColumn<Member>[] = [
+    { accessorKey: "name", header: "Name", meta: { primary: true, filter: true } },
+    { accessorKey: "role", header: "Role", meta: { filter: { type: "enum" } } },
+  ];
+</script>
+
+<DataTable
+  data={members}
+  {columns}
+  label="Members"
+  getRowId={(row) => row.id}
+  selection="multiple"
+/>
+```
+
+`createDataTable` takes its options as a **getter** — `createDataTable(() => props)`
+— so every option is read inside a `$derived` and a reactive source keeps the
+table in step.
+
+Everything it returns is a getter over a rune, so a component writes `table.rows`
+and the read is tracked. No `.value`, no wrapper type: the same property access
+React has, with Svelte's reactivity behind it.
+
+## What is Svelte's rather than React's
+
+**`createDeferred`** stands in for React's `useDeferredValue`. The table splits
+every expensive filter in two: the search string and the condition list update
+urgently, so an input never lags a keystroke, while the row-model pass they drive
+reads a deferred copy. Without the split, typing "ada" lands as "a". It is a
+deliberate transcription of `@ui-organized/vue-table`'s answer rather than a
+second design — two answers to one problem in one design system would be a defect
+in itself.
+
+**`trackStore`** binds core's framework-free stores with `$state` plus the
+store's own subscription, which is exactly what `table-core`'s `state.ts`
+predicted when it chose that store shape.
+
+## One workaround, and why
+
+`autoResetPageIndex` is turned off and replaced with an explicit effect. See the
+comment in `core/createDataTable.svelte.ts`: `@tanstack/svelte-table@9.2.4` backs
+its options store with `$state`, which deep-proxies, so `table.options.data` comes
+back as a fresh proxy of the same array on every sync. The core row model
+memoizes on that identity, rebuilds every time, and resets the page — which made
+paging do nothing at all. Vue's adapter uses `shallowRef` and does not proxy, so
+neither Vue nor React sees it. Remove both halves when the adapter stops
+proxying.
+
+## Scope
+
+**Not in v1:** grouping and aggregation, expandable sub-rows, URL or
+localStorage state persistence. Everything else the table does is listed under
+[`@ui-organized/table-core`'s scope](../table-core#scope) — the behaviour lives
+in the engine, so it is identical across all four adapters.
+
+## Peer dependencies
+
+`svelte >= 5.20`, `@ui-organized/svelte >= 0.1.0`.
+
+## License
+
+Apache-2.0

package/dist/DataTable/DataTable.svelte

@@ -0,0 +1,62 @@
+<!--
+  Layer 3: the whole table from a props object.
+
+  It composes exactly the parts a consumer would compose by hand — which is the
+  test of whether layer 2 is real. Anything this does that the parts cannot is a
+  gap in the parts, not a feature of the wrapper.
+-->
+<script lang="ts" generics="T extends RowData">
+  import type { RowData } from "@ui-organized/table-core";
+  import { createDataTable } from "../core/createDataTable.svelte.js";
+  import { setTable } from "../core/tableContext.js";
+  import type { UseDataTableOptions } from "../core/types.js";
+  import {
+    Table,
+    TableBody,
+    TableFooter,
+    TableHeader,
+    TableViewport,
+  } from "../components/Table/index.js";
+  import { TableCards } from "../components/TableCards/index.js";
+  import { TableDetailSheet } from "../components/TableDetailSheet/index.js";
+  import { TablePagination } from "../components/TablePagination/index.js";
+  import { TableSelectionFooter } from "../components/TableSelectionFooter/index.js";
+  import { TableSubBar } from "../components/TableSubBar/index.js";
+  import { TableToolbar } from "../components/TableToolbar/index.js";
+
+  /**
+   * `$props()` is reactive, so the whole object is handed to the composable as a
+   * **getter** and every option read inside a `$derived` follows it.
+   *
+   * Svelte needs no equivalent of Vue's `withDefaults(..., { sortable: undefined })`
+   * dance: `$props()` leaves an absent prop absent rather than casting a Boolean
+   * to `false`, so `?? true` in the composable means what it says. That bug cost
+   * the Vue port a table with no toolbar, no sorting, no search and no filters
+   * — silently, because the first frame looked correct.
+   */
+  let props: UseDataTableOptions<T> & { class?: string } = $props();
+
+  const table = createDataTable<T>(() => props);
+  setTable(table);
+</script>
+
+<Table class={props.class}>
+  <TableToolbar />
+  <TableSubBar />
+
+  {#if table.mode === "cards"}
+    <TableCards />
+    <!-- No viewport to ride in: the table view's footer lives inside
+         TableViewport, so only card mode places one here. -->
+    <TableSelectionFooter />
+  {:else}
+    <TableViewport>
+      <TableHeader />
+      <TableBody />
+      <TableFooter />
+    </TableViewport>
+  {/if}
+
+  {#if props.paginated}<TablePagination />{/if}
+  {#if props.detail}<TableDetailSheet />{/if}
+</Table>

package/dist/DataTable/DataTable.svelte.d.ts

@@ -0,0 +1,29 @@
+import type { RowData } from "@ui-organized/table-core";
+import type { UseDataTableOptions } from "../core/types.js";
+declare function $$render<T extends RowData>(): {
+    props: UseDataTableOptions<T> & {
+        class?: string;
+    };
+    exports: {};
+    bindings: "";
+    slots: {};
+    events: {};
+};
+declare class __sveltets_Render<T extends RowData> {
+    props(): ReturnType<typeof $$render<T>>['props'];
+    events(): ReturnType<typeof $$render<T>>['events'];
+    slots(): ReturnType<typeof $$render<T>>['slots'];
+    bindings(): "";
+    exports(): {};
+}
+interface $$IsomorphicComponent {
+    new <T extends RowData>(options: import('svelte').ComponentConstructorOptions<ReturnType<__sveltets_Render<T>['props']>>): import('svelte').SvelteComponent<ReturnType<__sveltets_Render<T>['props']>, ReturnType<__sveltets_Render<T>['events']>, ReturnType<__sveltets_Render<T>['slots']>> & {
+        $$bindings?: ReturnType<__sveltets_Render<T>['bindings']>;
+    } & ReturnType<__sveltets_Render<T>['exports']>;
+    <T extends RowData>(internal: unknown, props: ReturnType<__sveltets_Render<T>['props']> & {}): ReturnType<__sveltets_Render<T>['exports']>;
+    z_$$bindings?: ReturnType<__sveltets_Render<any>['bindings']>;
+}
+declare const DataTable: $$IsomorphicComponent;
+type DataTable<T extends RowData> = InstanceType<typeof DataTable<T>>;
+export default DataTable;
+//# sourceMappingURL=DataTable.svelte.d.ts.map

package/dist/DataTable/DataTable.svelte.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DataTable.svelte.d.ts","sourceRoot":"","sources":["../../src/lib/DataTable/DataTable.svelte.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,0BAA0B,CAAC;AAGxD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAc5D,iBAAS,QAAQ,CAAC,CAAC,SAAS,OAAO;;gBAY4B,MAAM;;;;;;EAwCoD;AACzH,cAAM,iBAAiB,CAAC,CAAC,SAAS,OAAO;IACrC,KAAK,IAAI,UAAU,CAAC,OAAO,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;IAChD,MAAM,IAAI,UAAU,CAAC,OAAO,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;IAClD,KAAK,IAAI,UAAU,CAAC,OAAO,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;IAChD,QAAQ;IACR,OAAO;CACV;AAED,UAAU,qBAAqB;IAC3B,KAAK,CAAC,SAAS,OAAO,EAAE,OAAO,EAAE,OAAO,QAAQ,EAAE,2BAA2B,CAAC,UAAU,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,QAAQ,EAAE,eAAe,CAAC,UAAU,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,EAAE,UAAU,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,UAAU,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG;QAAE,UAAU,CAAC,EAAE,UAAU,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAA;KAAE,GAAG,UAAU,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;IAC5Y,CAAC,CAAC,SAAS,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,KAAK,EAAE,UAAU,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,GAAG,UAAU,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;IAC3I,YAAY,CAAC,EAAE,UAAU,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC;CACjE;AACD,QAAA,MAAM,SAAS,EAAE,qBAAmC,CAAC;AACnC,KAAK,SAAS,CAAC,CAAC,SAAS,OAAO,IAAI,YAAY,CAAC,OAAO,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;AACxE,eAAe,SAAS,CAAC"}

package/dist/DataTable/DataTable.test.svelte.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=DataTable.test.svelte.d.ts.map

package/dist/DataTable/DataTable.test.svelte.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DataTable.test.svelte.d.ts","sourceRoot":"","sources":["../../src/lib/DataTable/DataTable.test.svelte.ts"],"names":[],"mappings":""}