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:42

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:32

Parameters

Parameter	Type
params	TreeNodeParams<TMetadata>

Returns

RequiredTreeChildNode<TMetadata>

Inherited from

TreeChildNode.constructor

Properties

action?

readonly optional action?: any;

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

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:26

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:27

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:25

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:22

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:28

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:29

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:24

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:23

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:31

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:34

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:33

Returns

boolean

Inherited from

TreeChildNode.isSelected

---

TreeChildNode

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

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:32

Parameters

Parameter	Type
params	TreeNodeParams<TMetadata>

Returns

TreeChildNode<TMetadata>

Properties

action?

readonly optional action?: any;

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

depth

readonly depth: number;

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

displayDepth

readonly displayDepth: number;

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

icon

readonly icon: string;

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

id

readonly id: string;

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

metadata

readonly metadata: TMetadata;

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

parentNode

readonly parentNode:
  | TreeParentNode<TMetadata>
  | undefined;

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

searchText?

readonly optional searchText?: string;

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

title

readonly title: string;

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

treeState

readonly treeState: TreeState<TMetadata>;

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

Accessors

disabled

Get Signature

get disabled(): boolean;

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

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:33

Returns

boolean

---

TreeParentNode

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

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:60

Parameters

Parameter	Type
params	TreeNodeParams<TMetadata> & object

Returns

TreeParentNode<TMetadata>

Properties

action?

readonly optional action?: any;

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

children

readonly children: TreeNodes<TMetadata>[];

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

depth

readonly depth: number;

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

displayDepth

readonly displayDepth: number;

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

icon

readonly icon: string;

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

id

readonly id: string;

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

metadata

readonly metadata: TMetadata;

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

parentNode

readonly parentNode:
  | TreeParentNode<TMetadata>
  | undefined;

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

searchText?

readonly optional searchText?: string;

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

title

readonly title: string;

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

treeState

readonly treeState: TreeState<TMetadata>;

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

Accessors

disabled

Get Signature

get disabled(): boolean;

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

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:63

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:65

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:66

Returns

boolean

---

TreeState

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

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:86

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:78

activeRootIndex

activeRootIndex: number;

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

activeRootNode

activeRootNode: TreeParentNode<TMetadata>;

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

disabledNodeIds

disabledNodeIds: SvelteSet<string>;

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

expandedNodeIds

expandedNodeIds: SvelteSet<string>;

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

filterValue

filterValue: string;

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

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:82

multiple

readonly multiple: boolean;

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

onChange?

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

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

Parameters

Parameter	Type
state	SelectionState

Returns

void

rootNodes

readonly rootNodes: TreeParentNode<TMetadata>[];

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

selectedNodeIds

selectedNodeIds: SvelteSet<string>;

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

visibleNodes

visibleNodes: TreeNodes<TMetadata>[];

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

Methods

clearAllSelections()

clearAllSelections(): void;

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

Returns

void

findNode()

findNode(nodeId): any;

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

Parameters

Parameter	Type
nodeId	string

Returns

any

notifyChange()

notifyChange(): void;

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

Returns

void

setActiveNode()

setActiveNode(nodeId): void;

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

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:92

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:89

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:88

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:90

Parameters

Parameter	Type
nodeId	string

Returns

void

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:3

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:4

Type Parameters

Type Parameter
TMetadata

Parameters

Parameter	Type
node	TreeNodes<TMetadata>

Returns

node is RequiredTreeChildNode<TMetadata>