Skip to content

Commit

Permalink
feat: command menu docs (#7963)
Browse files Browse the repository at this point in the history
Also rebranded command bar to command menu, because that seems more
suitable.
Command bar is more like a horizontal/vertical list/bar of icons, like
sidebar. Command menu is more of a dropdown.


https://unleash-docs-git-command-docs-unleash-team.vercel.app/reference/command-menu

---------

Co-authored-by: melindafekete <[email protected]>
  • Loading branch information
sjaanus and melindafekete authored Aug 22, 2024
1 parent 1367996 commit cb8d689
Show file tree
Hide file tree
Showing 4 changed files with 48 additions and 1 deletion.
2 changes: 1 addition & 1 deletion frontend/src/component/commandBar/CommandBar.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ export const CommandBar = () => {
searchInputRef.current?.blur();
}
});
const placeholder = `Command bar (${hotkey})`;
const placeholder = `Command menu (${hotkey})`;

const findCommandBarLinksAndSelectedIndex = () => {
const allCommandBarLinks =
Expand Down
46 changes: 46 additions & 0 deletions website/docs/reference/command-menu.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
title: Command Menu
---

:::note Availability

**Version**: 6.2+.

:::

## Overview

The Command Menu provides a powerful interface for quick navigation and efficient workflow management within Unleash. It enables users to access recently visited pages, navigate through projects, and search for specific flags or features, all from a single command interface.

![Command Menu accessible from the top navbar.](/img/command-menu.png)

## Quick suggestions

When you open the Command Menu, it displays the last five pages you visited, whether they are features, projects, or other types of pages. This allows you to resume your recent work without having to manually navigate back to those pages.

## Page navigation

The Command Menu includes a list of all available pages, enabling quick navigation. This feature is particularly useful when you need to move swiftly between different sections of Unleash.

## Keyboard shortcuts

To facilitate a mouse-free workflow, the Command Menu can be accessed using a keyboard shortcut:

- **Windows/Linux**: `Ctrl + K`
- **macOS**: `Cmd + K`

This allows you to bring up the Command Menu instantly, ensuring that you can maintain your flow without interruption.

## Search functionality

The Command Menu's search feature allows you to quickly find flags, projects, and pages based on your input. The search returns the following:

- **Feature flags**: The first three feature flags that match your input. The search also includes descriptions, which are displayed when you hover over a feature flag in the dropdown list.
- **Projects**: The first three projects matching the search input.
- **Pages**: Any page that contains the input text.

This search functionality is designed to be comprehensive, allowing you to find what you need based on various criteria, including text within descriptions.

## Feature request capability

If your search query does not return any results, you can request new features using the **Suggest capability** button.
1 change: 1 addition & 0 deletions website/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -287,6 +287,7 @@ module.exports = {
'reference/archived-toggles',
'reference/banners',
'reference/change-requests',
'reference/command-menu',
'reference/custom-activation-strategies',
'reference/dependent-features',
'reference/environments',
Expand Down
Binary file added website/static/img/command-menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit cb8d689

Please sign in to comment.