@keenmate/svelte-treeview 1.0.0-beta.2 → 1.0.0-beta.3

package/README.md

@@ -1,38 +1,38 @@
-# Svelte Treeview
-
-The most elaborate treeview for svelte on earth (or even in our galaxy).
-
-## Features
-
-- load new nodes whne expanding
-- automatically expanding to given depth
-- customization of all object properties
-- checkboxes enabled on whole tree or based on property
-- recursive seletion mode, where leafes can be selected
-- build-in support for search
-
-## Instalation
-
-install the package `@keenmate/svelte-treeview` using your favourite package manager.
-
-Font awesome is required for expand/collapse icons.
-
-## Minimal usage
-
-
-```svelte
-<script lang="ts">
-	import { TreeView } from '$lib/index.js';
-
-	let tree = [
-		{ nodePath: 'animals', title: 'Animals', hasChildren: true },
-    //...
-		{ nodePath: 'animals.insects.butterflies', title: 'Butterflies' }
-	];
-</script>
-
-<TreeView {tree} treeId="my-tree" let:node>
-	{node.title}
-</TreeView>
-
-```
+# Svelte Treeview
+
+The most elaborate treeview for svelte on earth (or even in our galaxy).
+
+## Features
+
+- load new nodes whne expanding
+- customization of all object properties
+- checkboxes enabled on whole tree or based on property
+- recursive seletion mode, where leafes can be selected
+- build-in support for search
+- drag and drop functionality controlable per node
+- context menu
+
+## Instalation
+
+install the package `@keenmate/svelte-treeview` using your favourite package manager.
+
+**Font awesome is required for expand/collapse icons.**
+
+## Minimal usage
+
+```svelte
+<script lang="ts">
+ import { TreeView } from '$lib/index.js';
+
+ let tree = [
+  { nodePath: 'animals', title: 'Animals', hasChildren: true },
+    //...
+  { nodePath: 'animals.insects.butterflies', title: 'Butterflies' }
+ ];
+</script>
+
+<TreeView {tree} treeId="my-tree" let:node>
+ {node.title}
+</TreeView>
+
+```

package/dist/Branch.svelte

@@ -14,13 +14,11 @@ export let readonly;
 export let expandTo;
 export let classes;
 export let helper;
-export let draggedPath;
-export let highlightedNode;
 export let childDepth;
 export let branchRootNode;
-export let canNest;
-export let validTarget;
-export let insPos;
+export let draggedNode;
+export let highlightedNode;
+export let insertionType;
 const getNodeId = (node) => `${treeId}-${node.path}`;
 function setExpansion(node, changeTo) {
     dispatch('internal-expand', { node: node, changeTo });
@@ -42,10 +40,10 @@ function handleDragStart(e, node) {
     dispatch('internal-handleDragStart', { node: node, e: e });
 }
 function handleDragDrop(e, node, el) {
-    dispatch('internal-handleDragStart', { node: node, event: e, element: el });
+    dispatch('internal-handleDragDrop', { node: node, event: e, element: el });
 }
-function handleDragOver(e, node, el) {
-    dispatch('internal-handleDragOver', { node: node, event: e, element: el });
+function handleDragOver(e, node, el, nest) {
+    dispatch('internal-handleDragOver', { node: node, event: e, element: el, nest });
 }
 function handleDragEnter(e, node, el) {
     dispatch('internal-handleDragEnter', { node: node, event: e, element: el });
@@ -56,154 +54,139 @@ function handleDragEnd(e, node) {
 function handleDragLeave(e, node, el) {
     dispatch('internal-handleDragLeave', { node: node, event: e, element: el });
 }
-/**
- *check if this node is one being hovered over (highlited) and is valid target
- */
-function highlighThisNode(node, highlitedNode, validTarget) {
-    return validTarget && highlitedNode.path == node.path;
-}
-/**
- * returns true, it should highlight nesting on this node
- * @param node node
- * @param highlitedNode highlited node
- * @param validTarget valid target
- * @param canNest can nest
- */
-function highlightNesting(node, highlitedNode, validTarget, canNest) {
-    if (!highlitedNode)
-        return false;
-    return (canNest && highlighThisNode(node, highlitedNode, validTarget) && node.nestDisabled !== true);
-}
-/**
- * returns true, it should highlight nesting on this node
- * @param node node
- * @param highlitedNode highlited node
- * @param validTarget valid target
- * @param canNest can nest
- */
-function highlightInsert(node, highlitedNode, validTarget, canNest) {
-    if (!highlitedNode)
-        return false;
-    return (!canNest && highlighThisNode(node, highlitedNode, validTarget) && node.nestDisabled !== true);
+function getHighlighMode(node, highlightedNode, insertionType) {
+    // return InsertionType.insertAbove;
+    if (highlightedNode?.path !== node.path)
+        return InsertionType.none;
+    return insertionType;
 }
 // TODO maybe this can be removed?
 let liElements = {};
-</script>
-
-<ul
-	class:show-lines={childDepth === 0 && verticalLines}
-	class:child-menu={childDepth > 0}
-	class={childDepth === 0 ? classes.treeClass : ''}
->
-	{#each helper.getDirectChildren(tree, branchRootNode?.path ?? null) as node (getNodeId(node))}
-		{@const nesthighlighed = highlightNesting(node, highlightedNode, validTarget, canNest)}
-		{@const insertHighlighted = highlightInsert(node, highlightedNode, validTarget, canNest)}
-		{@const expanded = isExpanded(node, childDepth, expandTo)}
-		{@const hasChildren = node.hasChildren}
-		{@const draggable = !readonly && dragAndDrop && node.isDraggable}
-		{@const isCurrentlyDragged =
-			draggedPath == node.path || (draggedPath && node.path?.startsWith(draggedPath))}
-
-		<li
-			class:is-child={helper.nodePathIsChild(node.path)}
-			class:has-children={hasChildren}
-			on:contextmenu|stopPropagation={(e) => {
-				dispatch('open-ctxmenu', { e: e, node: Node });
-			}}
-			on:drop|stopPropagation={(e) => handleDragDrop(e, node, liElements[getNodeId(node)])}
-			on:dragover|stopPropagation={(e) => handleDragOver(e, node, liElements[getNodeId(node)])}
-			on:dragenter|stopPropagation={(e) => handleDragEnter(e, node, liElements[getNodeId(node)])}
-			on:dragleave|stopPropagation={(e) => handleDragLeave(e, node, liElements[getNodeId(node)])}
-			bind:this={liElements[getNodeId(node)]}
-		>
-			{#if insPos == InsertionType.above && insertHighlighted}
-				<div class="insert-line-wrapper">
-					<div class="insert-line {classes.inserLineClass}" />
-				</div>
-			{/if}
-
-			<!-- svelte-ignore a11y-no-static-element-interactions -->
-			<div
-				class="tree-item
-				{nesthighlighed ? classes.expandClass : ''}
-				{classes.nodeClass} {isCurrentlyDragged ? classes.currentlyDraggedClass : ''}"
-				class:div-has-children={hasChildren}
-				class:hover={insertHighlighted || nesthighlighed}
-				{draggable}
-				on:dragstart={(e) => handleDragStart(e, node)}
-				on:dragend={(e) => handleDragEnd(e, node)}
-			>
-				{#if hasChildren}
-					<button
-						class="expansion-button"
-						on:click={() => setExpansion(node, !expanded)}
-						type="button"
-					>
-						<i class="fa-fw {expanded ? classes.expandIcon : classes.collapseIcon}" />
-					</button>
-				{:else}
-					<span class="fa-fw" />
-				{/if}
-
-				<Checkbox
-					{checkboxes}
-					{recursive}
-					{node}
-					{onlyLeafCheckboxes}
-					{hideDisabledCheckboxes}
-					{readonly}
-					on:select={({ detail: { node } }) => selectionChanged(node)}
-				/>
-				<span class:pointer-cursor={draggable}>
-					<slot node={node.originalNode} />
-				</span>
-			</div>
-
-			{#if nesthighlighed}
-				<div class="insert-line-wrapper">
-					<div
-						class="insert-line insert-line-child {classes.inserLineClass} {classes.inserLineNestClass}"
-					/>
-				</div>
-			{/if}
-			{#if expanded && hasChildren}
-				<svelte:self
-					branchRootNode={node}
-					childDepth={childDepth + 1}
-					{treeId}
-					{checkboxes}
-					{tree}
-					{recursive}
-					{helper}
-					{classes}
-					{readonly}
-					{onlyLeafCheckboxes}
-					{hideDisabledCheckboxes}
-					{expandTo}
-					{draggedPath}
-					{dragAndDrop}
-					{verticalLines}
-					{canNest}
-					{insPos}
-					{validTarget}
-					{highlightedNode}
-					on:open-ctxmenu
-					on:internal-expand
-					on:internal-selectionChanged
-					let:node={nodeNested}
-				>
-					<slot node={nodeNested} />
-				</svelte:self>
-			{/if}
-			{#if !expanded && hasChildren}
-				<ul class:child-menu={childDepth > 0} />
-			{/if}
-			<!-- Show line if insering -->
-			{#if insPos === InsertionType.below && insertHighlighted}
-				<div class="insert-line-wrapper">
-					<div class="insert-line {classes.inserLineClass}" />
-				</div>
-			{/if}
-		</li>
-	{/each}
-</ul>
+</script>
+
+<ul
+	class:show-lines={childDepth === 0 && verticalLines}
+	class:child-menu={childDepth > 0}
+	class={childDepth === 0 ? classes.treeClass : ''}
+>
+	{#each helper.getDirectChildren(tree, branchRootNode?.path ?? null) as node (getNodeId(node))}
+		{@const expanded = isExpanded(node, childDepth, expandTo)}
+		{@const draggable = !readonly && dragAndDrop && !node.dragDisabled}
+		{@const isCurrentlyDragged = draggedNode && node.path.startsWith(draggedNode?.path)}
+		{@const effectiveHighlight = getHighlighMode(node, highlightedNode, insertionType)}
+		<li
+			class:is-child={helper.nodePathIsChild(node.path)}
+			class:has-children={node.hasChildren}
+			on:contextmenu|stopPropagation={(e) => {
+				dispatch('open-ctxmenu', { e: e, node: Node });
+			}}
+			on:drop|stopPropagation={(e) => handleDragDrop(e, node, liElements[getNodeId(node)])}
+			on:dragover|stopPropagation={(e) =>
+				handleDragOver(e, node, liElements[getNodeId(node)], false)}
+			on:dragenter|stopPropagation={(e) => handleDragEnter(e, node, liElements[getNodeId(node)])}
+			on:dragleave|stopPropagation={(e) => handleDragLeave(e, node, liElements[getNodeId(node)])}
+			bind:this={liElements[getNodeId(node)]}
+		>
+			{#if effectiveHighlight == InsertionType.insertAbove}
+				<div class="insert-line-wrapper">
+					<div class="insert-line {classes.inserLineClass}" />
+				</div>
+			{/if}
+
+			<!-- svelte-ignore a11y-no-static-element-interactions -->
+			<div
+				class="tree-item
+				{effectiveHighlight === InsertionType.nest ? classes.expandClass : ''}
+				{classes.nodeClass} {isCurrentlyDragged ? classes.currentlyDraggedClass : ''}"
+				class:div-has-children={node.hasChildren}
+				class:hover={effectiveHighlight !== InsertionType.none}
+				{draggable}
+				on:dragstart={(e) => handleDragStart(e, node)}
+				on:dragend={(e) => handleDragEnd(e, node)}
+			>
+				{#if node.hasChildren}
+					<button
+						class="expansion-button"
+						on:click={() => setExpansion(node, !expanded)}
+						type="button"
+					>
+						<i class="fa-fw {expanded ? classes.collapseIcon : classes.expandIcon}" />
+					</button>
+				{:else}
+					<span class="fa-fw" />
+				{/if}
+
+				<Checkbox
+					{checkboxes}
+					{recursive}
+					{node}
+					{onlyLeafCheckboxes}
+					{hideDisabledCheckboxes}
+					{readonly}
+					on:select={({ detail: { node } }) => selectionChanged(node)}
+				/>
+				<span class:pointer-cursor={draggable}>
+					<slot node={node.originalNode} />
+				</span>
+
+				{#if dragAndDrop && node.nestAllowed}
+					<span
+						on:dragover|stopPropagation={(e) =>
+							handleDragOver(e, node, liElements[getNodeId(node)], true)}
+					>
+						<i class="fa-fw {classes.nestIcon}" />
+
+						{#if effectiveHighlight === InsertionType.nest}
+							<slot name="nest-highlight" />
+						{/if}
+					</span>
+				{/if}
+			</div>
+			{#if expanded && node.hasChildren}
+				<svelte:self
+					branchRootNode={node}
+					childDepth={childDepth + 1}
+					{treeId}
+					{checkboxes}
+					{tree}
+					{recursive}
+					{helper}
+					{classes}
+					{readonly}
+					{onlyLeafCheckboxes}
+					{hideDisabledCheckboxes}
+					{expandTo}
+					{dragAndDrop}
+					{verticalLines}
+					{draggedNode}
+					{highlightedNode}
+					{insertionType}
+					on:open-ctxmenu
+					on:internal-expand
+					on:internal-selectionChanged
+					on:internal-handleDragStart
+					on:internal-handleDragDrop
+					on:internal-handleDragOver
+					on:internal-handleDragEnter
+					on:internal-handleDragEnd
+					on:internal-handleDragLeave
+					let:node={nodeNested}
+				>
+					<slot node={nodeNested} />
+					<svelte:fragment slot="nest-highlight">
+						<slot name="nest-highlight" />
+					</svelte:fragment>
+				</svelte:self>
+			{/if}
+			{#if !expanded && node.hasChildren}
+				<ul class:child-menu={childDepth > 0} />
+			{/if}
+			<!-- Show line if insering -->
+			{#if effectiveHighlight === InsertionType.insertBelow}
+				<div class="insert-line-wrapper">
+					<div class="insert-line {classes.inserLineClass}" />
+				</div>
+			{/if}
+		</li>
+	{/each}
+</ul>

package/dist/Branch.svelte.d.ts

@@ -1,6 +1,6 @@
 import { SvelteComponent } from "svelte";
-import { SelectionModes, InsertionType, type Node } from './types.js';
-import type { CustomizableClasses, TreeHelper } from './index.js';
+import { SelectionModes, InsertionType, type Node, type CustomizableClasses } from './types.js';
+import type { TreeHelper } from './helpers/tree-helper.js';
 declare const __propDef: {
     props: {
         tree: Node[];
@@ -15,19 +15,18 @@ declare const __propDef: {
         expandTo: number;
         classes: CustomizableClasses;
         helper: TreeHelper;
-        draggedPath: string | null;
-        highlightedNode: Node | null;
         childDepth: number;
         branchRootNode: Node | null;
-        canNest: boolean;
-        validTarget: boolean;
-        insPos: InsertionType;
+        draggedNode: Node | null;
+        highlightedNode: Node | null;
+        insertionType: InsertionType;
     };
     events: {
         'open-ctxmenu': CustomEvent<any>;
         'internal-expand': CustomEvent<any>;
         'internal-selectionChanged': CustomEvent<any>;
         'internal-handleDragStart': CustomEvent<any>;
+        'internal-handleDragDrop': CustomEvent<any>;
         'internal-handleDragOver': CustomEvent<any>;
         'internal-handleDragEnter': CustomEvent<any>;
         'internal-handleDragEnd': CustomEvent<any>;
@@ -39,6 +38,7 @@ declare const __propDef: {
         default: {
             node: any;
         };
+        'nest-highlight': {};
     };
 };
 export type BranchProps = typeof __propDef.props;

package/dist/Checkbox.svelte

@@ -13,33 +13,33 @@ function onSelect(e, node) {
     dispatch('select', { node });
     return false;
 }
-</script>
-
-{#if checkboxes == SelectionModes.perNode || checkboxes == SelectionModes.all}
-	{#if isSelectable(node, checkboxes)}
-		{#if !recursive || (recursive && !node.hasChildren) || !onlyLeafCheckboxes}
-			<input
-				type="checkbox"
-				on:click={(e) => onSelect(e, node)}
-				on:keypress={(e) => e.key === 'Enter' && onSelect(e, node)}
-				checked={node.visualState === VisualState.selected}
-				indeterminate={node.visualState === VisualState.indeterminate}
-				disabled={readonly}
-			/>
-		{:else}
-			<input
-				type="checkbox"
-				on:click={null}
-				disabled={true}
-				class:invisible={hideDisabledCheckboxes}
-			/>
-		{/if}
-	{:else}
-		<input
-			type="checkbox"
-			on:click|preventDefault|stopPropagation
-			disabled={true}
-			class:invisible={hideDisabledCheckboxes}
-		/>
-	{/if}
-{/if}
+</script>
+
+{#if checkboxes == SelectionModes.perNode || checkboxes == SelectionModes.all}
+	{#if isSelectable(node, checkboxes)}
+		{#if !recursive || (recursive && !node.hasChildren) || !onlyLeafCheckboxes}
+			<input
+				type="checkbox"
+				on:click={(e) => onSelect(e, node)}
+				on:keypress={(e) => e.key === 'Enter' && onSelect(e, node)}
+				checked={node.visualState === VisualState.selected}
+				indeterminate={node.visualState === VisualState.indeterminate}
+				disabled={readonly}
+			/>
+		{:else}
+			<input
+				type="checkbox"
+				on:click={null}
+				disabled={true}
+				class:invisible={hideDisabledCheckboxes}
+			/>
+		{/if}
+	{:else}
+		<input
+			type="checkbox"
+			on:click|preventDefault|stopPropagation
+			disabled={true}
+			class:invisible={hideDisabledCheckboxes}
+		/>
+	{/if}
+{/if}