Files
superset2/docs/developer_portal/guides/command-palette.md

62 lines
1.9 KiB
Markdown

---
title: Command Palette Integration
sidebar_position: 2
---
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
# Command Palette Integration
🚧 **Coming Soon** 🚧
Learn how to integrate your plugin with Superset's command palette to provide quick access to plugin functionality.
## Topics to be covered:
- Understanding the command palette architecture
- Registering custom commands
- Command categories and organization
- Keyboard shortcuts and hotkeys
- Dynamic command generation
- Command context and availability
- Icon and description customization
- Command execution and callbacks
- Search and filtering integration
- Command palette theming
## Command Types
- **Navigation commands** - Quick navigation to plugin views
- **Action commands** - Execute plugin-specific actions
- **Creation commands** - Create new charts, dashboards, or data sources
- **Configuration commands** - Quick access to settings
- **Help commands** - Documentation and support links
## Implementation Patterns
- Command registration lifecycle
- Async command execution
- Context-aware command availability
- Command result handling
---
*This documentation is under active development. Check back soon for updates!*