From 23cd33f5cda667ba7b207ad7fb8f158c34d46ee3 Mon Sep 17 00:00:00 2001 From: ntsekouras Date: Fri, 8 Nov 2024 11:18:26 +0200 Subject: [PATCH] Update Commands docs with the existing contexts --- packages/commands/README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/packages/commands/README.md b/packages/commands/README.md index 946b101e9ef27d..b7382f98a8c848 100644 --- a/packages/commands/README.md +++ b/packages/commands/README.md @@ -26,11 +26,13 @@ For example, when a user types "contact", the Command Palette needs to filter th Static and dynamic commands can be contextual. This means that in a given context (for example, when navigating the Site Editor or editing a template), some specific commands are given more priority and are visible as soon as you open the Command Palette. Also, when typing the Command Palette, these contextual commands are shown above the rest of the commands. -At the moment, two contexts have been implemented: +At the moment, three contexts have been implemented: - `site-editor`: This is the context that is set when you are navigating in the site editor (sidebar visible). -- `site-editor-edit`: This is the context that is set when you are editing a document (template, template part or page) in the site editor. - As the usage of the Command Palette expands, more contexts will be added. +- `entity-edit`: This is the context that is set when you are editing a document (template, template part or page). +- `block-selection-edit`: This is the context that is set when a block is selected. + +As the usage of the Command Palette expands, more contexts will be added. Attaching a command or command loader to a given context is as simple as adding the `context` property (with the right context value from the available contexts above) to the `useCommand` or `useCommandLoader` calls.