Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Svelte Simple Datatables Guide #2443

Merged
merged 8 commits into from
Feb 9, 2024
Merged

Svelte Simple Datatables Guide #2443

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
5759922
SSD guide
kmalloy24 Jan 23, 2024
92d790c
Merge remote-tracking branch 'origin/dev' into docs/ssd-integration
kmalloy24 Feb 2, 2024
958c5c5
img test
kmalloy24 Feb 2, 2024
ebbcb11
img test2
kmalloy24 Feb 2, 2024
8597993
rem vincjo
kmalloy24 Feb 2, 2024
ed9caec
slower gif
kmalloy24 Feb 3, 2024
679f81d
SSD integration guide adjustments
endigo9740 Feb 9, 2024
0ccedba
SSD install command to standar dep instead of devDep
endigo9740 Feb 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion sites/skeleton.dev/src/lib/links.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,10 @@ export const menuNavLinks: Record<string, Array<{ title: string; list: List }>>
},
{
title: 'Integrations',
list: [{ href: '/docs/tauri', label: 'Tauri', keywords: 'Tauri, desktop, setup, install' }] // , badge: 'New'
list: [
{ href: '/docs/tauri', label: 'Tauri', keywords: 'Tauri, desktop, setup, install' },
{ href: '/docs/ssd', label: 'Svelte Simple Datatables', keywords: 'datatables, tables, datagrid, simple', badge: 'New' }
]
}
],
'/elements': [
Expand Down
258 changes: 258 additions & 0 deletions sites/skeleton.dev/src/routes/(inner)/docs/ssd/+page.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,258 @@
<script lang="ts">
import LayoutPage from '$lib/layouts/LayoutPage/LayoutPage.svelte';

import { CodeBlock, RadioGroup, RadioItem } from '@skeletonlabs/skeleton';

//For radio toggle
let value: number = 0;

//Local Components
import Client from './ClientSSD.svelte';
import Server from './ServerSSD.svelte';
</script>

<LayoutPage>
<!-- Header -->
<header class="space-y-4">
<h1 class="h1">Svelte Simple Datatables</h1>
<p>
This guide will show you how to create a
<code class="code">&lt;Datatable /&gt;</code>
component with
<a class="anchor" href="https://vincjo.fr/datatables/home" target="_blank">Svelte Simple Datatables</a>
and style it with Skeleton's Tailwind classes.
</p>
</header>

<hr />

<!-- SSD Explanation -->
<section class="space-y-4">
<p>
<a class="anchor" href="https://vincjo.fr/datatables/home" target="_blank">Svelte Simple Datatables (SSD)</a>
is a headless library for creating datatable components with Svelte. It provides an API to dynamically
interact with iterable data on the client-side to filter, paginate, sort, and select data. It can handle
server-side data processing, supports Typescript, and has no dependencies.
</p>
</section>

<!-- Intro -->
<section class="space-y-4">
<h2 class="h2">Introduction</h2>

<aside class="alert variant-ghost-warning">
<i class="fa-solid fa-triangle-exclamation text-4xl" />
<div class="alert-message" data-toc-ignore>
<p>
Skeleton has a
<code class="code">&lt;Table /&gt;</code>
<a class="anchor" href="https://www.skeleton.dev/components/tables" target="_blank">component;</a>
however, this should be used only as a simple way to present data, and <strong>is not a data table.</strong>
</p>
</div>
</aside>

<p>
We will use SSD to create a
<code class="code">&lt;Datatable /&gt;</code>
from a native HTML
<code class="code">&lt;table&gt;</code>
which we can then style with Skeleton's
<a class="anchor" href="https://www.skeleton.dev/elements/tables" target="_blank">native HTML table styles.</a>
</p>

<img
class="rounded-lg"
src="https://raw.githubusercontent.com/skeletonlabs/skeleton-datatables-integration/main/static/themes.gif"
alt="themed datatables"
/>

<p>
We will then create accessory components to search, filter, sort, and paginate the
<code class="code">&lt;Datatable /&gt;.</code>
</p>

<img
src="https://raw.githubusercontent.com/skeletonlabs/skeleton-datatables-integration/main/static/components.png"
alt="accessory components diagram"
/>

<p>
You can start fresh with the starter template provided below or
continue on and follow the guide to create your own components from scratch.
</p>
</section>

<!-- Starter Template -->
<section class="space-y-4">
<h2 class="h2">Starter Template</h2>
<p>If you're looking for a quick start or reference project, please refer to our opinionated template on GitHub.</p>
<div class="card variant-glass p-4 py-10 text-center">
<a class="btn variant-filled" href="https:/skeletonlabs/skeleton-datatables-integration" target="_blank">
<i class="fa-brands fa-github" />
<span>View Starter Template</span>
<i class="fa-solid fa-up-right-from-square" />
</a>
</div>
</section>

<!-- Getting Started -->
<section class="space-y-4">
<h2 class="h2">Getting Started</h2>

<h3 class="h3">Install SSD</h3>

<p>
Add SSD to your Skeleton Sveltekit project by running the command below.
</p>

<CodeBlock
language="shell"
code={`
npm i -D @vincjo/datatables
`}
/>

<h3 class="h3">Project Structure</h3>

<p>
Create the following files in your project.
</p>
<CodeBlock
language="shell"
code={`
src
├── lib
| ├── data
| | └── data.ts / api.ts
| └── components
| ├── Pagination.svelte
| ├── Search.svelte
| ├── RowCount.svelte
| ├── RowsPerPage.svelte
| ├── ThFilter.svelte
| └── ThSort.svelte
└── routes
├── Datatable.svelte
└── +page.svelte
`}
/>

<dl class="list-dl">
<div>
<span class="badge-icon p-4 variant-soft-primary"><i class="fa-solid fa-code"/></span>
<span class="flex-auto">
<dt><code class="code">/lib/data</code></dt>
<dd>Create <code class="code">data.ts</code> if you are loading data from the client
or <code class="code">api.ts</code> if your data is coming from the server.
This will be explained further on, but for now just create the blank Typescript file.
</dd>
</span>
</div>
<div>
<span class="badge-icon p-4 variant-soft-primary"><i class="fa-solid fa-code"/></span>
<span class="flex-auto">
<dt><code class="code">/lib/components</code></dt>
<dd>All of the files in this directory will be used for accessory components.</dd>
</span>
</div>
<div>
<span class="badge-icon p-4 variant-soft-primary"><i class="fa-solid fa-code"/></span>
<span class="flex-auto">
<dt><code class="code">/routes/Datatable.svelte</code></dt>
<dd>
This file will contain the
<code class="code">&lt;Datatable /&gt;</code>
component, the associated logic, and render the accessory components.
</dd>
</span>
</div>
<div>
<span class="badge-icon p-4 variant-soft-primary"><i class="fa-solid fa-code"/></span>
<span class="flex-auto">
<dt><code class="code">/routes/+page.svelte</code></dt>
<dd>
This is where we'll render and access the
<code class="code">&lt;Datatable /&gt;</code>
component in this example.
</dd>
</span>
</div>
</dl>
</section>

<!-- Creating the Components -->
<section class="space-y-4">
<h2 class="h2">Creating the Components</h2>

<p>
Your components will need to be configured slightly differently
depending on whether the data is coming from the server or the client.
You can toggle between the two guides below.
</p>

<RadioGroup active="variant-filled-primary" hover="hover:variant-soft-primary">
<RadioItem bind:group={value} name="justify" value={0}>Client</RadioItem>
<RadioItem bind:group={value} name="justify" value={1}>Server</RadioItem>
</RadioGroup>

<hr />

{#if value === 0}
<Client />
{:else if value === 1}
<Server />
{/if}
</section>

<hr />

<!-- Responsive Design -->
<section class="space-y-4">
<h2 class="h2">Responsive Design</h2>

<p>
We can use standard responsive web design techniques to make the components display properly on all devices.
The <code class="code">&lt;Datatable /&gt;</code>
and accessory components in this example are wrapped up in a single
<code class="code">&lt;div&gt;</code>.
Tailwind classes are then applied as necessary to different elements.
</p>

<p>
The <code class="code">&lt;Pagination /&gt;</code>
component provides an example of how we can apply different UI elements for different screen sizes.
</p>
</section>

<!-- Componentization -->
<section class="space-y-4">

<h2 class="h2">Componentization</h2>

<aside class="alert variant-ghost-warning">
<i class="fa-solid fa-triangle-exclamation text-4xl" />
<div class="alert-message" data-toc-ignore>
<p>
The Skeleton team does not plan to maintain or provide first party support for a SSD component.
</p>
</div>
</aside>

<p>
To reuse the <code class="code">&lt;Datatable /&gt;</code> component
throughout your app, you can,
</p>

<ol class="list space-y-2">
<li>
<span class="badge-icon p-4 variant-soft-primary">1</span>
<span class="flex-auto">Duplicate the file and update the DataHandler Methods from SSD, or,</span>
</li>
<li>
<span class="badge-icon p-4 variant-soft-primary">2</span>
<span class="flex-auto">Export the appropriate props and build your own reusable component.</span>
</li>
</ol>
</section>
</LayoutPage>
Loading