MUI Tree Select

Index

Interfaces

Functions

Classes

FreeSoloNode

Type aliases

References

default

Functions

DefaultOption

DefaultOption(props: UpBranchDefaultOptionsProps | BaseDefaultOptionsProps | DownBranchDefaultOptionsProps): Element

Default Option Component.

Parameters
- props: UpBranchDefaultOptionsProps | BaseDefaultOptionsProps | DownBranchDefaultOptionsProps
Returns Element

PathIcon

PathIcon(props: SvgIconProps<"svg", {}>): Element

Parameters
- props: SvgIconProps<"svg", {}>
Returns Element

TreeSelect

TreeSelect<Node, Multiple, DisableClearable, FreeSolo>(props: TreeSelectProps<Node, Multiple, DisableClearable, FreeSolo>): Element

Type parameters
- Node
- Multiple: undefined | boolean = undefined
- DisableClearable: undefined | boolean = undefined
- FreeSolo: undefined | boolean = undefined
Parameters
- props: TreeSelectProps<Node, Multiple, DisableClearable, FreeSolo>
Returns Element

getDefaultOptionProps

getDefaultOptionProps(...args: [props: HTMLAttributes<HTMLLIElement> & { key: Key }, option: any, state: TreeSelectRenderOptionState<PathDirection>]): UpBranchDefaultOptionsProps | BaseDefaultOptionsProps | DownBranchDefaultOptionsProps

Returns props for DefaultOption from arguments of RenderOption

Parameters
- Rest ...args: [props: HTMLAttributes<HTMLLIElement> & { key: Key }, option: any, state: TreeSelectRenderOptionState<PathDirection>]
Returns UpBranchDefaultOptionsProps | BaseDefaultOptionsProps | DownBranchDefaultOptionsProps

Type aliases

PathDirection

PathDirection: "up" | "down"

Indicates the tree navigation direction. "up" in the direction of ancestors and "down"in the direction of descendants.

RenderOption

RenderOption<Node, FreeSolo>: (props: React.HTMLAttributes<HTMLLIElement> & { key: React.Key }, option: Node | TreeSelectFreeSoloValueMapping<Node, FreeSolo>, state: TreeSelectRenderOptionState) => React.ReactNode

Type parameters

Node
FreeSolo: boolean | undefined

Type declaration

- (props: React.HTMLAttributes<HTMLLIElement> & { key: React.Key }, option: Node | TreeSelectFreeSoloValueMapping<Node, FreeSolo>, state: TreeSelectRenderOptionState): React.ReactNode
- Parameters
  - props: React.HTMLAttributes<HTMLLIElement> & { key: React.Key }
  - option: Node | TreeSelectFreeSoloValueMapping<Node, FreeSolo>
  - state: TreeSelectRenderOptionState
  Returns React.ReactNode

SyncOrAsync

SyncOrAsync<T>: T | Promise<T>

Type parameters

TreeSelectFreeSoloValueMapping

TreeSelectFreeSoloValueMapping<Node, FreeSolo>: FreeSolo extends true ? FreeSoloNode<Node> : never

Type parameters

Node
FreeSolo

TreeSelectValue

TreeSelectValue<Node, Multiple, DisableClearable, FreeSolo>: AutocompleteValue<Node | TreeSelectFreeSoloValueMapping<Node, FreeSolo>, Multiple, DisableClearable, false>

Utility type that gives the tree select value type.

Type parameters

Node
Multiple: boolean | undefined
DisableClearable: boolean | undefined
FreeSolo: boolean | undefined

References

default

Renames and re-exports TreeSelect

Index

Interfaces

Functions

Classes

Type aliases

References

Functions

DefaultOption

Parameters

props: UpBranchDefaultOptionsProps | BaseDefaultOptionsProps | DownBranchDefaultOptionsProps

Returns Element

PathIcon

Parameters

props: SvgIconProps<"svg", {}>

Returns Element

TreeSelect

Type parameters

Node

Multiple: undefined | boolean = undefined

DisableClearable: undefined | boolean = undefined

FreeSolo: undefined | boolean = undefined

Parameters

props: TreeSelectProps<Node, Multiple, DisableClearable, FreeSolo>

Returns Element

getDefaultOptionProps

Parameters

Rest ...args: [props: HTMLAttributes<HTMLLIElement> & { key: Key }, option: any, state: TreeSelectRenderOptionState<PathDirection>]

Returns UpBranchDefaultOptionsProps | BaseDefaultOptionsProps | DownBranchDefaultOptionsProps

Type aliases

PathDirection

RenderOption

Type parameters

Node

FreeSolo: boolean | undefined

Type declaration

Parameters

props: React.HTMLAttributes<HTMLLIElement> & { key: React.Key }

option: Node | TreeSelectFreeSoloValueMapping<Node, FreeSolo>

state: TreeSelectRenderOptionState

Returns React.ReactNode

SyncOrAsync

Type parameters

T

TreeSelectFreeSoloValueMapping

Type parameters

Node

FreeSolo

TreeSelectValue

Type parameters

Node

Multiple: boolean | undefined

DisableClearable: boolean | undefined

FreeSolo: boolean | undefined

References

default