BetaPublic beta — Read the release notes
Solidiom
Get Started
Documentation

Command Palette

Modal search and action launcher.

Package
@solidiom/command-palette
Version
0.0.1-next.0
Status
stable

Generated from the package's public source.

API

CommandPaletteEmptyPropsinterface

@solidiom/command-palette — Headless modal command palette primitive. Parts: Root, Input, List, Group, Item, Empty.

Props

class?
string

children: Element

View source

CommandPaletteGroupPropsinterface

@solidiom/command-palette — Headless modal command palette primitive. Parts: Root, Input, List, Group, Item, Empty.

Props

class?
string
heading?
string — Group heading label.

children: Element

View source

CommandPaletteInputPropsinterface

@solidiom/command-palette — Headless modal command palette primitive. Parts: Root, Input, List, Group, Item, Empty.

Props

class?
string
onFilter?
(value: string) => void — Called on each input change to trigger filtering.
placeholder?
string — Placeholder text.
ref?
(el: HTMLInputElement) => void
style?
string | CSSProperties

View source

CommandPaletteItemPropsinterface

@solidiom/command-palette — Headless modal command palette primitive. Parts: Root, Input, List, Group, Item, Empty.

Props

class?
string
disabled?
boolean — Disabled state.
onSelect?
() => void — Called when the command is executed (Enter or click).
textValue?
string — Text value for filtering. Defaults to value.
value
string — Unique value/identifier for this command.

children: Element

View source

CommandPaletteListPropsinterface

@solidiom/command-palette — Headless modal command palette primitive. Parts: Root, Input, List, Group, Item, Empty.

Props

class?
string
ref?
(el: HTMLDivElement) => void
style?
string | CSSProperties

children: Element

View source

CommandPaletteRootPropsinterface

@solidiom/command-palette — Headless modal command palette primitive. Parts: Root, Input, List, Group, Item, Empty.

Props

class?
string
defaultInputValue?
string
defaultOpen?
boolean
inputValue?
Accessor<string> — Controlled input value.
onInputValueChange?
(value: string) => void
onOpenChange?
(open: boolean, details: ChangeDetails<DisclosureReason>) => void
open?
Accessor<boolean> — Controlled open state.
style?
string | CSSProperties

children: Element

View source

Emptycomponent

@solidiom/command-palette — Headless modal command palette primitive. Parts: Root, Input, List, Group, Item, Empty.

                        Empty(props: CommandPaletteEmptyProps): Element

Props

class?
string

children: Element

View source

Groupcomponent

@solidiom/command-palette — Headless modal command palette primitive. Parts: Root, Input, List, Group, Item, Empty.

                        Group(props: CommandPaletteGroupProps): Element

Props

class?
string
heading?
string — Group heading label.

children: Element

View source

Inputcomponent

@solidiom/command-palette — Headless modal command palette primitive. Parts: Root, Input, List, Group, Item, Empty.

                        Input(props: CommandPaletteInputProps): Element

Props

class?
string
onFilter?
(value: string) => void — Called on each input change to trigger filtering.
placeholder?
string — Placeholder text.
ref?
(el: HTMLInputElement) => void
style?
string | CSSProperties

View source

Itemcomponent

@solidiom/command-palette — Headless modal command palette primitive. Parts: Root, Input, List, Group, Item, Empty.

                        Item(props: CommandPaletteItemProps): Element

Props

class?
string
disabled?
boolean — Disabled state.
onSelect?
() => void — Called when the command is executed (Enter or click).
textValue?
string — Text value for filtering. Defaults to value.
value
string — Unique value/identifier for this command.

children: Element

View source

Listcomponent

@solidiom/command-palette — Headless modal command palette primitive. Parts: Root, Input, List, Group, Item, Empty.

                        List(props: CommandPaletteListProps): Element

Props

class?
string
ref?
(el: HTMLDivElement) => void
style?
string | CSSProperties

children: Element

View source

Rootcomponent

@solidiom/command-palette — Headless modal command palette primitive. Parts: Root, Input, List, Group, Item, Empty.

                        Root(props: CommandPaletteRootProps): Element

Props

class?
string
defaultInputValue?
string
defaultOpen?
boolean
inputValue?
Accessor<string> — Controlled input value.
onInputValueChange?
(value: string) => void
onOpenChange?
(open: boolean, details: ChangeDetails<DisclosureReason>) => void
open?
Accessor<boolean> — Controlled open state.
style?
string | CSSProperties

children: Element

View source