ui/build/tree-select/tree-select-state.svelte

Classes

RequiredTreeChildNode

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:105

Required child node (selecting it requires all siblings to be selected).

Same field surface as TreeChildNode; the type carries the requirement so selection rules can distinguish the two node kinds while sharing one implementation.

Extends

• TreeChildNode<TMetadata>

Type Parameters

Type Parameter
TMetadata

Constructors

Constructor

new RequiredTreeChildNode<TMetadata>(params): RequiredTreeChildNode<TMetadata>;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:95

Parameters

Parameter	Type
params	TreeNodeParams<TMetadata>

Returns

RequiredTreeChildNode<TMetadata>

Inherited from

TreeChildNode.constructor

Properties

action?

readonly optional action?: NodeActionCallback<TMetadata>;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:93

Inherited from

TreeChildNode.action

depth

readonly depth: number;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:89

Inherited from

TreeChildNode.depth

displayDepth

readonly displayDepth: number;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:90

Inherited from

TreeChildNode.displayDepth

icon

readonly icon: string;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:88

Inherited from

TreeChildNode.icon

id

readonly id: string;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:85

Inherited from

TreeChildNode.id

metadata

readonly metadata: TMetadata;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:91

Inherited from

TreeChildNode.metadata

parentNode

readonly parentNode:
  | TreeParentNode<TMetadata>
  | undefined;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:92

Inherited from

TreeChildNode.parentNode

searchText?

readonly optional searchText?: string;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:87

Inherited from

TreeChildNode.searchText

title

readonly title: string;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:86

Inherited from

TreeChildNode.title

treeState

readonly treeState: TreeState<TMetadata>;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:94

Inherited from

TreeChildNode.treeState

Accessors

disabled

Get Signature

get disabled(): boolean;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:97

Returns

boolean

Inherited from

TreeChildNode.disabled

isSelected

Get Signature

get isSelected(): boolean;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:96

Returns

boolean

Inherited from

TreeChildNode.isSelected

---

TreeChildNode

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:84

Regular child node (leaf node)

Extended by

• RequiredTreeChildNode

Type Parameters

Type Parameter
TMetadata

Constructors

Constructor

new TreeChildNode<TMetadata>(params): TreeChildNode<TMetadata>;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:95

Parameters

Parameter	Type
params	TreeNodeParams<TMetadata>

Returns

TreeChildNode<TMetadata>

Properties

action?

readonly optional action?: NodeActionCallback<TMetadata>;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:93

depth

readonly depth: number;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:89

displayDepth

readonly displayDepth: number;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:90

icon

readonly icon: string;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:88

id

readonly id: string;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:85

metadata

readonly metadata: TMetadata;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:91

parentNode

readonly parentNode:
  | TreeParentNode<TMetadata>
  | undefined;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:92

searchText?

readonly optional searchText?: string;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:87

title

readonly title: string;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:86

treeState

readonly treeState: TreeState<TMetadata>;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:94

Accessors

disabled

Get Signature

get disabled(): boolean;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:97

Returns

boolean

isSelected

Get Signature

get isSelected(): boolean;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:96

Returns

boolean

---

TreeParentNode

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:110

Parent node (has children)

Type Parameters

Type Parameter
TMetadata

Constructors

Constructor

new TreeParentNode<TMetadata>(params): TreeParentNode<TMetadata>;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:123

Parameters

Parameter	Type
params	TreeNodeParams<TMetadata> & object

Returns

TreeParentNode<TMetadata>

Properties

action?

readonly optional action?: NodeActionCallback<TMetadata>;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:120

children

readonly children: TreeNodes<TMetadata>[];

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:122

depth

readonly depth: number;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:116

displayDepth

readonly displayDepth: number;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:117

icon

readonly icon: string;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:115

id

readonly id: string;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:112

metadata

readonly metadata: TMetadata;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:118

parentNode

readonly parentNode:
  | TreeParentNode<TMetadata>
  | undefined;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:119

searchText?

readonly optional searchText?: string;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:114

title

readonly title: string;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:113

treeState

readonly treeState: TreeState<TMetadata>;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:121

Accessors

disabled

Get Signature

get disabled(): boolean;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:127

Returns

boolean

isExpanded

Get Signature

get isExpanded(): boolean;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:126

Returns

boolean

isIndeterminate

Get Signature

get isIndeterminate(): boolean;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:128

Returns

boolean

isSelected

Get Signature

get isSelected(): boolean;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:129

Returns

boolean

---

TreeState

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:131

Type Parameters

Type Parameter
TMetadata

Constructors

Constructor

new TreeState<TMetadata>(params): TreeState<TMetadata>;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:149

Parameters

Parameter	Type
params	TreeSelectStateProps<TMetadata>

Returns

TreeState<TMetadata>

Properties

activeNodeId

activeNodeId: string | null;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:141

activeRootIndex

activeRootIndex: number;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:138

activeRootNode

activeRootNode: TreeParentNode<TMetadata>;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:143

disabledNodeIds

disabledNodeIds: SvelteSet<string>;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:140

expandedNodeIds

expandedNodeIds: SvelteSet<string>;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:136

filterValue

filterValue: string;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:137

matchInfo

matchInfo: Map<string, {
  end: number;
  start: number;
}>;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:145

multiple

readonly multiple: boolean;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:134

onChange?

readonly optional onChange?: (state) => void;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:135

Parameters

Parameter	Type
state	{ disabled: readonly string[]; selected: readonly string[]; }
state.disabled	readonly string[]
state.selected	readonly string[]

Returns

void

rootNodes

readonly rootNodes: TreeParentNode<TMetadata>[];

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:133

selectedNodeIds

selectedNodeIds: SvelteSet<string>;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:139

visibleNodes

visibleNodes: TreeNodes<TMetadata>[];

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:144

Methods

clearAllSelections()

clearAllSelections(): void;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:156

Returns

void

findNode()

findNode(nodeId):
  | TreeNodes<TMetadata>
  | null;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:150

Parameters

Parameter	Type
nodeId	string

Returns

| TreeNodes<TMetadata> | null

notifyChange()

notifyChange(): void;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:157

Returns

void

setActiveNode()

setActiveNode(nodeId): void;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:154

Parameters

Parameter	Type
nodeId	string | null

Returns

void

setActiveRootIndex()

setActiveRootIndex(index): void;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:155

Parameters

Parameter	Type
index	number

Returns

void

toggleDisable()

toggleDisable(nodeId): void;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:152

Parameters

Parameter	Type
nodeId	string

Returns

void

toggleExpand()

toggleExpand(nodeId): void;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:151

Parameters

Parameter	Type
nodeId	string

Returns

void

toggleSelection()

toggleSelection(nodeId): void;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:153

Parameters

Parameter	Type
nodeId	string

Returns

void

Interfaces

BaseTreeItem

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:21

Base item structure used for initializing the tree

Type Parameters

Type Parameter
TMetadata

Properties

action?

optional action?: NodeActionCallback<TMetadata>;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:37

Optional action to render next to the node

children?

optional children?: BaseTreeItem<TMetadata>[];

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:31

Child items under this node

icon

icon: string;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:29

Icon identifier for the node

id

id: string;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:23

Unique identifier for the node

metadata

metadata: TMetadata;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:35

Custom metadata associated with this item

required?

optional required?: boolean;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:33

Whether this item is required (when in multiple selection mode)

searchText?

optional searchText?: string;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:27

Additional aliases and metadata included when filtering the tree

title

title: string;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:25

Display text for the node

---

TreeSelectProps

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:42

Props interface for the TreeSelect component

Type Parameters

Type Parameter
TMetadata

Properties

containerClass?

optional containerClass?: string;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:58

Additional CSS class for the container

disabled?

optional disabled?: boolean;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:50

Disable all interactions and focus

multiple?

optional multiple?: boolean;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:60

Whether to allow multiple selection

onChange?

optional onChange?: (state) => void;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:48

Callback when selection changes

Parameters

Parameter	Type
state	{ disabled: readonly string[]; selected: readonly string[]; }
state.disabled	readonly string[]
state.selected	readonly string[]

Returns

void

readonly?

optional readonly?: boolean;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:52

Prevent selection changes but allow navigation/expand

rootItems

rootItems: readonly BaseTreeItem<TMetadata>[];

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:44

Root items to display in the tree

searchPlaceholder?

optional searchPlaceholder?: string;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:56

Placeholder shown in the search input

showSearch?

optional showSearch?: boolean;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:54

Whether to show the search input

value?

optional value?: object;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:46

Selection state (bindable)

disabled

readonly disabled: readonly string[];

selected

readonly selected: readonly string[];

Type Aliases

NodeActionCallback

type NodeActionCallback<TMetadata> = (node) =>
  | ConfirmationProps<Component<Record<string, unknown>>>
  | ConfirmationProps<unknown>
  | string;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:17

Callback type for node actions

Type Parameters

Type Parameter
TMetadata

Parameters

Parameter	Type
node	TreeNodes<TMetadata>

Returns

| ConfirmationProps<Component<Record<string, unknown>>> | ConfirmationProps<unknown> | string

---

SelectionState

type SelectionState = typeof SelectionStateSchema.Type;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:12

---

TreeNodes

type TreeNodes<TMetadata> =
  | TreeChildNode<TMetadata>
  | TreeParentNode<TMetadata>
| RequiredTreeChildNode<TMetadata>;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:13

Type Parameters

Type Parameter
TMetadata

---

TreeSelectStateProps

type TreeSelectStateProps<TMetadata> = TreeSelectProps<TMetadata>;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:65

Props interface for TreeState initialization

Type Parameters

Type Parameter
TMetadata

Variables

SelectionStateSchema

const SelectionStateSchema: Schema.Struct<{
  disabled: Schema.$Array<Schema.String>;
  selected: Schema.$Array<Schema.String>;
}>;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:8

Selection state interface defining which nodes are selected or disabled

Functions

isParentNode()

function isParentNode<TMetadata>(node): node is TreeParentNode<TMetadata>;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:66

Type Parameters

Type Parameter
TMetadata

Parameters

Parameter	Type
node	TreeNodes<TMetadata>

Returns

node is TreeParentNode<TMetadata>

---

isRequiredChildNode()

function isRequiredChildNode<TMetadata>(node): node is RequiredTreeChildNode<TMetadata>;

Defined in: apps/website/.api-docs-entry/ui/build/tree-select/tree-select-state.svelte.d.ts:67

Type Parameters

Type Parameter
TMetadata

Parameters

Parameter	Type
node	TreeNodes<TMetadata>

Returns

node is RequiredTreeChildNode<TMetadata>