Skip to content
Combobox Patterns

TransferList

client49.25 kB
@stellaria/nebula-webTransferListProps

Preview

Props

11
PropTypeDefault

className

string

—

data

required
readonly SelectOption[]

—

defaultValue

readonly string[]

—

disabled

boolean

—

height

number

—

labels

Partial<TransferListLabels>

—

onChange

((value: string[]) => void)

—

searchable

boolean

—

source

TransferListPane

—

target

TransferListPane

—

value

readonly string[]

—

Slot props

9

Each one spreads over an inner element, so you can restyle a region without forking the component.

PropTypeDefault

controlsProps

The button row between the two panels.

BoxSlotProps

—

emptyProps

The empty-panel notice.

TextSlotProps

—

itemProps

Every option. It spreads over all of them.

Omit<DetailedHTMLProps<ButtonHTMLAttributes<HTMLButtonElement>, HTMLButtonElement>, "ref">

—

listProps

The option list, which is the `listbox`.

BoxSlotProps

—

paneCountProps

The count. It goes in the header when there is a title, and in the footer when there is not.

TextSlotProps

—

paneHeadProps

Its header. Only rendered when the panel has a `title`.

BoxSlotProps

—

paneProps

The panel.

BoxSlotProps

—

paneTitleProps

The panel title.

TextSlotProps

—

searchProps

The search wrapper. Only with `searchable`.

BoxSlotProps

—

Also accepts

On top of its own props, this component forwards these groups.

Style props · 128