{"id":20820857,"url":"https://github.com/daelonsuzuka/nicegui-command-palette","last_synced_at":"2026-01-24T16:03:47.606Z","repository":{"id":257809284,"uuid":"867481256","full_name":"DaelonSuzuka/nicegui-command-palette","owner":"DaelonSuzuka","description":"A VSCode/Sublime style Command Palette for NiceGUI applications","archived":false,"fork":false,"pushed_at":"2025-05-18T03:34:49.000Z","size":2056,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-11-01T00:19:41.191Z","etag":null,"topics":["command-palette","component","nicegui"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DaelonSuzuka.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-10-04T06:37:08.000Z","updated_at":"2025-05-18T03:34:52.000Z","dependencies_parsed_at":null,"dependency_job_id":"3c84f2f7-ebeb-4f2a-b9d3-c01f72cec566","html_url":"https://github.com/DaelonSuzuka/nicegui-command-palette","commit_stats":null,"previous_names":["daelonsuzuka/nicegui-command-palette"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/DaelonSuzuka/nicegui-command-palette","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DaelonSuzuka%2Fnicegui-command-palette","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DaelonSuzuka%2Fnicegui-command-palette/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DaelonSuzuka%2Fnicegui-command-palette/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DaelonSuzuka%2Fnicegui-command-palette/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DaelonSuzuka","download_url":"https://codeload.github.com/DaelonSuzuka/nicegui-command-palette/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DaelonSuzuka%2Fnicegui-command-palette/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28730751,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-24T10:24:43.181Z","status":"ssl_error","status_checked_at":"2026-01-24T10:24:36.112Z","response_time":89,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["command-palette","component","nicegui"],"created_at":"2024-11-17T22:10:31.604Z","updated_at":"2026-01-24T16:03:47.564Z","avatar_url":"https://github.com/DaelonSuzuka.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# nicegui-command-palette\n\nThis plugin adds a command palette for NiceGUI applications.\n\n## Installation\n\n```sh\npip install nicegui-command-palette\n```\n\n## Usage\n\nRegister commands to the `CommandPalette` as a list of either strings or `Command` objects.\n\nA `Command` can have a callback attached, which could be cleaner than checking the `CommandPalette`'s result.\n\nOpen the `CommandPalette` by `await`ing it. The returned value is the name of the command selected by the user, or `None` if they dismissed the palette without selecting anything.\n\n```py\nfrom command_palette import CommandPalette, Command\n\ndef some_action():\n    ui.notify('User picked the third option!')\n\ncommands = [\n    'one',\n    Command('two', 'Second'),\n    Command('three', 'Third', cb=some_action),\n]\n\nif result := await CommandPalette(commands):\n    # result is the name of the user's selection, or None\n    ui.notify(f'Selected: {result}')\n```\n\nFull example:\n```py\nfrom nicegui import ui\nfrom nicegui.events import KeyEventArguments\nfrom command_palette import CommandPalette, Command\n\nasync def handle_key(e: KeyEventArguments):\n    # open the command palette when the user presses ctrl+shift+p\n    if e.action.keydown and e.modifiers.ctrl and e.modifiers.shift and e.key == 'P':\n        commands = [\n            'one',\n            Command('two', 'Second'),\n            Command('three', 'Third', cb=some_action),\n        ]\n        if result := await CommandPalette(commands):\n            ui.notify(result)\n\nui.keyboard(on_key=handle_key)\n\nui.run()\n```\n\n# Screenshots\n![screenshot](screenshots/palette_open.png)\n![usage](screenshots/usage.gif)\n\n# Todo\n\n- highlighting substring matches like in VSCode\n- additional functions like specific prompts?\n- improve matching algorithm\n- figure out how to use the user fixture with dialogs","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdaelonsuzuka%2Fnicegui-command-palette","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdaelonsuzuka%2Fnicegui-command-palette","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdaelonsuzuka%2Fnicegui-command-palette/lists"}