Domain-Specific
SearchableList
client80 kB
@stellaria/nebula-webSearchableListPropsPreview
Props
22| Prop | Type | Default |
|---|---|---|
className | string | — |
debounce | number | 300 |
defaultSearch | string | "" |
empty | ReactNode | — |
filter | ((item: T, search: string) => boolean) | — |
getKey required | (item: T, index: number) => string | — |
getPageItems | ((page: TPage) => readonly T[]) | — |
getSearchText | ((item: T) => string) | — |
infinite | Omit<InfiniteListProps<T, TPage>, "empty" | "getKey" | "renderItem" | "items" | "query" | "getPageItems"> | — |
items | readonly T[] | — |
label | string | — |
labels | Partial<SearchableListLabels> | — |
minLength | number | 0 |
mode | SearchableListMode | "client" |
noResults | ReactNode | — |
onSearchChange | ((search: string) => void) | — |
query | InfiniteQueryLike<TPage> | — |
renderItem required | (item: T, index: number) => ReactNode | — |
search | string | — |
size | Size | "md" |
toolbar | ReactNode | — |
withCount | boolean | false |
Slot props
2Each one spreads over an inner element, so you can restyle a region without forking the component.
| Prop | Type | Default |
|---|---|---|
countProps The result count. Only rendered with `withCount` and loaded data. | TextSlotProps | — |
toolbarProps The bar with the search field and whatever `toolbar` brings. | BoxSlotProps | — |
Also accepts
On top of its own props, this component forwards these groups.
Style props · 127