feat(treeview): make node slottable

Closes #1660
This commit is contained in:
Eric Liu 2023-11-11 13:43:02 -08:00
commit c6c756925b
3 changed files with 39 additions and 12 deletions

View file

@ -2,6 +2,7 @@
/** /**
* @typedef {string | number} TreeNodeId * @typedef {string | number} TreeNodeId
* @typedef {{ id: TreeNodeId; text: any; icon?: typeof import("svelte").SvelteComponent<any>; disabled?: boolean; children?: TreeNode[]; }} TreeNode * @typedef {{ id: TreeNodeId; text: any; icon?: typeof import("svelte").SvelteComponent<any>; disabled?: boolean; children?: TreeNode[]; }} TreeNode
* @slot {{ node: { id: TreeNodeId; text: string; expanded: boolean, leaf: boolean; disabled: boolean; selected: boolean; } }}
* @event {TreeNode & { expanded: boolean; leaf: boolean; }} select * @event {TreeNode & { expanded: boolean; leaf: boolean; }} select
* @event {TreeNode & { expanded: boolean; leaf: boolean; }} toggle * @event {TreeNode & { expanded: boolean; leaf: boolean; }} toggle
* @event {TreeNode & { expanded: boolean; leaf: boolean; }} focus * @event {TreeNode & { expanded: boolean; leaf: boolean; }} focus
@ -202,5 +203,9 @@
on:keydown on:keydown
on:keydown|stopPropagation="{handleKeyDown}" on:keydown|stopPropagation="{handleKeyDown}"
> >
<TreeViewNodeList root children="{children}" /> <TreeViewNodeList root children="{children}" let:node>
<slot node="{node}">
{node.text}
</slot>
</TreeViewNodeList>
</ul> </ul>

View file

@ -34,6 +34,7 @@
<script> <script>
/** /**
* @typedef {string | number} TreeNodeId * @typedef {string | number} TreeNodeId
* @slot {{ node: { id: TreeNodeId; text: string; expanded: false, leaf: boolean; disabled: boolean; selected: boolean; } }}
*/ */
export let leaf = false; export let leaf = false;
@ -68,7 +69,16 @@
prevActiveId = $activeNodeId; prevActiveId = $activeNodeId;
}); });
$: node = { id, text, expanded: false, leaf }; $: selected = $selectedNodeIds.includes(id);
$: node = {
id,
text,
// A node cannot be expanded.
expanded: false,
leaf,
disabled,
selected,
};
$: if (refLabel) { $: if (refLabel) {
refLabel.style.marginLeft = `-${offset()}rem`; refLabel.style.marginLeft = `-${offset()}rem`;
refLabel.style.paddingLeft = `${offset()}rem`; refLabel.style.paddingLeft = `${offset()}rem`;
@ -82,12 +92,12 @@
id="{id}" id="{id}"
tabindex="{disabled ? undefined : -1}" tabindex="{disabled ? undefined : -1}"
aria-current="{id === $activeNodeId || undefined}" aria-current="{id === $activeNodeId || undefined}"
aria-selected="{disabled ? undefined : $selectedNodeIds.includes(id)}" aria-selected="{disabled ? undefined : selected}"
aria-disabled="{disabled}" aria-disabled="{disabled}"
class:bx--tree-node="{true}" class:bx--tree-node="{true}"
class:bx--tree-leaf-node="{true}" class:bx--tree-leaf-node="{true}"
class:bx--tree-node--active="{id === $activeNodeId}" class:bx--tree-node--active="{id === $activeNodeId}"
class:bx--tree-node--selected="{$selectedNodeIds.includes(id)}" class:bx--tree-node--selected="{selected}"
class:bx--tree-node--disabled="{disabled}" class:bx--tree-node--disabled="{disabled}"
class:bx--tree-node--with-icon="{icon}" class:bx--tree-node--with-icon="{icon}"
on:click|stopPropagation="{() => { on:click|stopPropagation="{() => {
@ -116,6 +126,8 @@
> >
<div bind:this="{refLabel}" class:bx--tree-node__label="{true}"> <div bind:this="{refLabel}" class:bx--tree-node__label="{true}">
<svelte:component this="{icon}" class="bx--tree-node__icon" /> <svelte:component this="{icon}" class="bx--tree-node__icon" />
{text} <slot node="{node}">
{text}
</slot>
</div> </div>
</li> </li>

View file

@ -2,6 +2,7 @@
/** /**
* @typedef {string | number} TreeNodeId * @typedef {string | number} TreeNodeId
* @typedef {{ id: TreeNodeId; text: string; disabled?: boolean; expanded?: boolean; }} TreeNode * @typedef {{ id: TreeNodeId; text: string; disabled?: boolean; expanded?: boolean; }} TreeNode
* @slot {{ node: { id: TreeNodeId; text: string; expanded: boolean, leaf: boolean; disabled: boolean; selected: boolean; } }}
*/ */
/** @type {Array<TreeNode & { children?: TreeNode[] }>} */ /** @type {Array<TreeNode & { children?: TreeNode[] }>} */
@ -66,12 +67,17 @@
{#if root} {#if root}
{#each children as child (child.id)} {#each children as child (child.id)}
{#if Array.isArray(child.children)} {#if Array.isArray(child.children)}
<svelte:self {...child} /> <svelte:self {...child} let:node>
<slot node="{node}" />
</svelte:self>
{:else} {:else}
<TreeViewNode leaf {...child} /> <TreeViewNode leaf {...child} let:node>
<slot node="{node}" />
</TreeViewNode>
{/if} {/if}
{/each} {/each}
{:else} {:else}
{@const selected = $selectedNodeIds.includes(id)}
<!-- svelte-ignore a11y-no-noninteractive-element-to-interactive-role --> <!-- svelte-ignore a11y-no-noninteractive-element-to-interactive-role -->
<li <li
bind:this="{ref}" bind:this="{ref}"
@ -79,12 +85,12 @@
id="{id}" id="{id}"
tabindex="{disabled ? undefined : -1}" tabindex="{disabled ? undefined : -1}"
aria-current="{id === $activeNodeId || undefined}" aria-current="{id === $activeNodeId || undefined}"
aria-selected="{disabled ? undefined : $selectedNodeIds.includes(id)}" aria-selected="{disabled ? undefined : selected}"
aria-disabled="{disabled}" aria-disabled="{disabled}"
class:bx--tree-node="{true}" class:bx--tree-node="{true}"
class:bx--tree-parent-node="{true}" class:bx--tree-parent-node="{true}"
class:bx--tree-node--active="{id === $activeNodeId}" class:bx--tree-node--active="{id === $activeNodeId}"
class:bx--tree-node--selected="{$selectedNodeIds.includes(id)}" class:bx--tree-node--selected="{selected}"
class:bx--tree-node--disabled="{disabled}" class:bx--tree-node--disabled="{disabled}"
class:bx--tree-node--with-icon="{icon}" class:bx--tree-node--with-icon="{icon}"
aria-expanded="{expanded}" aria-expanded="{expanded}"
@ -151,16 +157,20 @@
</span> </span>
<span class:bx--tree-node__label__details="{true}"> <span class:bx--tree-node__label__details="{true}">
<svelte:component this="{icon}" class="bx--tree-node__icon" /> <svelte:component this="{icon}" class="bx--tree-node__icon" />
{text} <slot node="{{ ...node, selected, disabled }}" />
</span> </span>
</div> </div>
{#if expanded} {#if expanded}
<ul role="group" class:bx--tree-node__children="{true}"> <ul role="group" class:bx--tree-node__children="{true}">
{#each children as child (child.id)} {#each children as child (child.id)}
{#if Array.isArray(child.children)} {#if Array.isArray(child.children)}
<svelte:self {...child} /> <svelte:self {...child} let:node>
<slot node="{node}" />
</svelte:self>
{:else} {:else}
<TreeViewNode leaf {...child} /> <TreeViewNode leaf {...child} let:node>
<slot node="{node}">{node.text}</slot>
</TreeViewNode>
{/if} {/if}
{/each} {/each}
</ul> </ul>