- Notifications
You must be signed in to change notification settings - Fork0
License
NotificationsYou must be signed in to change notification settings
idling-mind/dash_kbar
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
cmd + k interface for dash applications
pip install dash_kbar
dash_kbar.DashKbar(id="input",actions=[ {"name":"Action 1","id":"action1"}, {"name":"Action 2","id":"action2"}, ],style={"itemTextColor":"grey", },)
Look intousage.py for a functioning example usage.
The following properties are accepted byDashKbar.
| Property | Description | Type | Default |
|---|---|---|---|
id | The ID used to identify this component in Dash callbacks | str | None |
actions | List of actions to display in the kbar | list[dict[str, str]] | [] |
style | Style of the kbar | dict[str, str] | {} |
selected | ID of the selected item. You can use this prop in callbacks. | str | None |
debug | Show the id of the selected item in the browser console | bool | False |
Actions should be a list of dictionaries with the following keys.
| Key | Description | Type | Required |
|---|---|---|---|
name | Name of the action | str | Yes |
id | ID of the action | str | Yes |
subtitle | Subtitle of the action | str | No |
keywords | Keywords of the action | list[str] | No |
section | Section of the action | str | No |
icon | Icon of the action | str | No |
parent | If this is a child item, give the id of the parent | str | No |
priority | Priority of the action. Higher priority actions will be shown first. Should be one of 1 (high), 0 (normal, default) or -1 (low) | int | No |
actionable | Boolean denoting whether selecting this action will change theselected property. Set this toFalse for parent actions where selecting the parent should show the child actions. | bool | No |
shortcut | Shortcut of the action | list[str] | No |
Style should be a dictionary with one or more of the following keys.
| Key | Description | Default |
|---|---|---|
maxWidth | Maximum width of the kbar | 600px |
width | Width of the kbar | 100% |
background | Background color of the kbar | white |
searchBackground | Background color of the search input box | transparent |
searchTextColor | Text color of the search input box | grey |
fontFamily | Font family of the kbar | sans-serif |
itemTextColor | Text color of the items | grey |
itemSubtitleTextColor | Text color of the item subtitles | grey |
sectionTitleTextColor | Text color of the section titles | grey |
selectedBackground | Background color of the selected item | rgba(34, 139, 230, 0.1) |
selectedTextColor | Text color of the selected item | grey |
selectedLeftBorderColor | Left border color of the selected item | rgba(34, 139, 230, 1) |
boxShadow | Box shadow of the kbar | 0 0 20px rgba(0, 0, 0, 0.1) |
borderRadius | Border radius of the kbar | 8px |
searchBoxFontSize | Font size of the search input box | 16px |
resultFontSize | Font size of the items | 14px |
subtitleFontSize | Font size of the item subtitles | 12px |
sectionTitleFontSize | Font size of the section titles | 10px |
shortcutBackground | Background color of the shortcut | rgba(0 0 0 / .1) |
About
No description, website, or topics provided.
Resources
License
Stars
Watchers
Forks
Packages0
No packages published