feat(data-table): support programmatic sorting (#1337)

* refactor(data-table): pass down sortable props instead of using context

* feat(data-table): support programmatic sorting

* test(data-table): assert new props

* docs(data-table): add "Programmatic sorting" example

* refactor(data-table): remove unused tableSortable store

* refactor(data-table): remove unused indices
This commit is contained in:
metonym 2022-06-05 13:37:50 -07:00 committed by GitHub
commit 72c24b83b2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
9 changed files with 241 additions and 48 deletions

View file

@ -1,6 +1,15 @@
<script>
/** Set to `true` to disable sorting on this specific cell */
export let disableSorting = false;
/** Set to `true` for the sortable variant */
export let sortable = false;
/**
* Specify the sort direction
* @type {"none" | "ascending" | "descending"}
*/
export let sortDirection = "none";
/** Set to `true` if the column sorting */
export let active = false;
/** Specify the `scope` attribute */
export let scope = "col";
@ -14,21 +23,17 @@
/** Set an id for the top-level element */
export let id = "ccs-" + Math.random().toString(36);
import { getContext } from "svelte";
import ArrowUp from "../icons/ArrowUp.svelte";
import ArrowsVertical from "../icons/ArrowsVertical.svelte";
const { sortHeader, tableSortable } = getContext("DataTable");
$: active = $sortHeader.id === id;
// TODO: translate with id
$: ariaLabel = translateWithId();
</script>
<!-- svelte-ignore a11y-mouse-events-have-key-events -->
{#if $tableSortable && !disableSorting}
{#if sortable}
<th
aria-sort="{active ? $sortHeader.sortDirection : 'none'}"
aria-sort="{active ? sortDirection : 'none'}"
scope="{scope}"
data-header="{id}"
{...$$restProps}
@ -40,7 +45,7 @@
class:bx--table-sort="{true}"
class:bx--table-sort--active="{active}"
class:bx--table-sort--ascending="{active &&
$sortHeader.sortDirection === 'descending'}"
sortDirection === 'descending'}"
on:click
>
<div class:bx--table-header-label="{true}">