Selection
Tree Select
Choose an item from a hierarchical collection.
Import
import { NeuTreeSelectComponent } from '@neural-ui/native/tree-select';Examples
Import ExampleComponent into its parent and place <app-example /> inside your application’s root neu-theme. The preview supplies the device frame and safe areas; use the root setup from Installation in your app.
Give your work a home
Open a hierarchical selector, expand its branches and select a department. The workspace card reflects the selected leaf’s name.
View and copy the complete example
import { Component, signal, computed } from '@angular/core';
import { NeuCardComponent } from '@neural-ui/native/card';
import { NeuTreeSelectComponent } from '@neural-ui/native/tree-select';
import { View, Text, ScrollView } from '@ng-native/components';
import type { NeuTreeNode } from '@neural-ui/native';
@Component({
selector: 'app-example',
imports: [NeuCardComponent, NeuTreeSelectComponent, View, Text, ScrollView],
template: `
<scroll-view class="product-scroll" keyboardShouldPersistTaps="handled" [showsVerticalScrollIndicator]="true"><view class="product-stack"><view class="product-section"><text class="product-title" accessibilityRole="header">Give your work a home</text><text class="product-caption">Choose a department without losing the structure</text></view>
<view class="product-surface"><neu-tree-select label="Department" [nodes]="nodes" [(value)]="selected" [leafOnly]="true" placeholder="Choose a department" />
<text class="product-caption">Expand Product to see its teams.</text></view>
<neu-card title="Department workspace" [description]="departmentLabel()" variant="outlined"><text class="product-caption">New projects will use this department in this local example.</text></neu-card></view></scroll-view>
`,
styles: `
.actions { gap: 12px; align-items: flex-start; } text { color: var(--neu-text, #172033); font-size: 16px; }
:host { flex: 1; flex-shrink: 1; min-height: 0; }
.product-scroll { flex: 1; flex-shrink: 1; height: 0px; min-height: 0; }
.product-stack { gap: 24px; padding-bottom: 20px; }
.product-section { gap: 12px; }
.product-row { flex-direction: row; align-items: center; gap: 12px; }
.product-copy { flex: 1; min-width: 0; gap: 4px; }
.product-title { color: var(--neu-text, #172033); font-size: 24px; line-height: 30px; font-weight: 600; }
.product-heading { color: var(--neu-text, #172033); font-size: 17px; line-height: 23px; font-weight: 600; }
.product-caption { color: var(--neu-muted, #596477); font-size: 14px; line-height: 20px; }
.product-actions { flex-direction: row; flex-wrap: wrap; align-items: center; gap: 8px; }
.product-surface { gap: 16px; padding: 16px; border-radius: 16px; background-color: var(--neu-surface, #ffffff); border-width: 1px; border-color: var(--neu-border, #a5afbf); }
`,
})
export class ExampleComponent {
readonly nodes: readonly NeuTreeNode[] = [
{ id: 'product', label: 'Product', children: [
{ id: 'design', label: 'Design' },
{ id: 'engineering', label: 'Engineering' },
] },
{ id: 'operations', label: 'Operations' },
];
readonly selected = signal('design');
readonly departmentLabel = computed(() => this.nodes.flatMap(node => node.children?.length ? node.children : [node]).find(node => node.id === this.selected())?.label || '');
}Read-only department
Show a department that cannot be changed in this screen.
View and copy the complete example
import { Component } from '@angular/core';
import { NeuTreeSelectComponent } from '@neural-ui/native/tree-select';
import { View, ScrollView } from '@ng-native/components';
import type { NeuTreeNode } from '@neural-ui/native';
@Component({
selector: 'app-example',
imports: [NeuTreeSelectComponent, View, ScrollView],
template: `
<scroll-view class="usage-scroll" keyboardShouldPersistTaps="handled"><view class="usage-stack">
<neu-tree-select label="Locked department" [nodes]="nodes" value="design" [readonly]="true" />
</view></scroll-view>
`,
styles: `
.actions { gap: 12px; align-items: flex-start; } text { color: var(--neu-text, #172033); font-size: 16px; }
.usage-scroll { flex: 1; }
.usage-stack { gap: 20px; padding-bottom: 20px; }
.usage-section { gap: 12px; }
.usage-heading { color: var(--neu-text, #172033); font-size: 16px; font-weight: 600; }
.usage-caption { color: var(--neu-muted, #64748b); font-size: 14px; }
.usage-row { flex-direction: row; flex-wrap: wrap; gap: 12px; align-items: center; }
.usage-actions { flex-direction: row; flex-wrap: wrap; gap: 8px; align-items: center; }
`,
})
export class ExampleComponent {
readonly nodes: readonly NeuTreeNode[] = [
{ id: 'product', label: 'Product', children: [
{ id: 'design', label: 'Design' },
{ id: 'engineering', label: 'Engineering' },
] },
{ id: 'operations', label: 'Operations' },
];
}Interactive playground
Change the settings and try the result.
Device captures shown in English.


API reference
Inputs
| Name | Type | Default | Binding | Description |
|---|---|---|---|---|
| nodes | readonly NeuTreeNode[] | [] | Input | Hierarchical nodes with optional children. Keep IDs unique across the whole tree. |
| leafOnly | boolean | true | Input | Restricts selectable values to leaf nodes; parent nodes still organize the hierarchy. |
| placeholder | string | 'Choose item' | Input | Example or prompt displayed while the value is empty; keep a separate label. |
| closeLabel | string | 'Dismiss options' | Input | Text or accessible name used for close. It does not perform the action by itself. |
| expandLabel | string | 'Expand' | Input | Text or accessible name used for expand. It does not perform the action by itself. |
| emptyLabel | string | 'No items' | Input | Text or accessible name used for empty state. It does not perform the action by itself. |
| label | string | Required | Input | Human-readable name for the control, action or group. |
| disabled | boolean | false | Input | Disables user interaction. Values can still be supplied by the application. |
| readonly | boolean | false | Input | Prevents user editing or selection while retaining the current value. |
| invalid | boolean | false | Input | Marks the control invalid. Your form or application supplies the validation rule. |
| touched | boolean | false | Input | Field interaction state, supplied manually or through Signal Forms. |
| hint | string | '' | Input | Field guidance shown when no error message is being displayed. |
| required | boolean | false | Input | Required-field presentation. Define the actual validation rule in your application form. |
| requiredLabel | string | 'Required' | Input | Localized requirement announced with the field hint when required is true. Defaults to Required; it does not validate the value. |
| error | string | '' | Input | Application-provided error message; combine it with the control’s invalid state. |
Models
| Name | Type | Default | Binding | Description |
|---|---|---|---|---|
| value | string | '' | Model · two-way | Current edited value or selected ID(s), using the declared type. Bind a writable signal with [(value)]. |
Outputs
| Name | Payload | When it emits |
|---|---|---|
| valueChange | string | Emits the updated value value. [(value)] binds this output together with its model input. |
| touch | void | Reports user interaction to the surrounding form or application. |
Model state
Bind the signal with [(modelName)] without calling it. Use modelName() to read its value.
import { signal } from '@angular/core';
// Fields inside your component class
readonly value = signal<string>('');Types and data interfaces
Use the imports in your application. The definitions below are provided for reference.
NeuOption
import type { NeuOption } from '@neural-ui/native';
// Public definition for reference only. Import this type; do not redeclare it.
export interface NeuOption {
readonly id: string;
readonly label: string;
readonly description?: string;
readonly disabled?: boolean;
}| Field | Type | Requirement | Meaning |
|---|---|---|---|
| id | string | Required | Stable, unique identifier used for tracking and selection. |
| label | string | Required | Human-readable item name. |
| description | string | Optional | Optional supporting text; rendering depends on the control. |
| disabled | boolean | Optional | Prevents activating or selecting this item. |
NeuTreeNode
import type { NeuTreeNode } from '@neural-ui/native';
import type { NeuOption } from '@neural-ui/native';
// Public definition for reference only. Import this type; do not redeclare it.
export interface NeuTreeNode extends NeuOption {
readonly children?: readonly NeuTreeNode[];
}| Field | Type | Requirement | Meaning |
|---|---|---|---|
| children | readonly NeuTreeNode[] | Optional | Recursive child nodes; omit for a leaf. |
| id | string | Required | Stable, unique identifier used for tracking and selection. |
| label | string | Required | Human-readable item name. |
| description | string | Optional | Optional supporting text; rendering depends on the control. |
| disabled | boolean | Optional | Prevents activating or selecting this item. |