From f15e4edf98549e3ef381cb61bf7b4160f205f44d Mon Sep 17 00:00:00 2001 From: Volodymyr Kublytskyi Date: Tue, 21 Nov 2023 11:11:00 -0600 Subject: [PATCH] Minor fixes for buttons docs. --- .../api/action-bar/index.md | 27 ++++++++++++++++--- .../api/header-menu/index.md | 13 ++++----- 2 files changed, 29 insertions(+), 11 deletions(-) diff --git a/src/pages/services/aem-cf-console-admin/api/action-bar/index.md b/src/pages/services/aem-cf-console-admin/api/action-bar/index.md index b5ed6403..238223b1 100644 --- a/src/pages/services/aem-cf-console-admin/api/action-bar/index.md +++ b/src/pages/services/aem-cf-console-admin/api/action-bar/index.md @@ -91,6 +91,8 @@ const guestConnection = await register({ }); ``` +The callback is invoked when user clicks on the button and receives list of content fragments selected in the list. + ## Custom button with sub menu ```js @@ -117,9 +119,28 @@ const guestConnection = await register({ The callback is invoked when user clicks on the button and receives list of content fragments selected in the list. - +## Delete button + +```js +import { register } from "@adobe/uix-guest"; -The `getButton` method is deprecated. When defining a single button, use `getButtons` and provide a single-item array. +// ... + +const guestConnection = await register({ + id: "my.company.extension-with-header-menu-button", + methods: { + actionBar: { + deleteButtons() { + return [ + { + id: "my.company.export-button" + }, + ]; + }, + }, + }, +}); +``` ## API Reference @@ -146,4 +167,4 @@ The `getButton` method is deprecated. When defining a single button, use `getBut | Field | Type | Required | Description | |----------|-----------------------------------------------------------------------------| ------ |------------------------------------------------------------------------------| -| id | `string` | ✔️ | "id" is a "data-id" attribute of the button. (Use browser developer console) | +| id | `string` | ✔️ | "id" is a "data-id" attribute of the button (please use browser developer console to find actual value). | diff --git a/src/pages/services/aem-cf-console-admin/api/header-menu/index.md b/src/pages/services/aem-cf-console-admin/api/header-menu/index.md index bf50380b..c7732345 100644 --- a/src/pages/services/aem-cf-console-admin/api/header-menu/index.md +++ b/src/pages/services/aem-cf-console-admin/api/header-menu/index.md @@ -49,6 +49,8 @@ const guestConnection = await register({ }); ``` +The `onClick` callback is invoked when a user clicks on the button. It does not receive any arguments. + ## Custom button with sub menu ```js @@ -92,6 +94,8 @@ const guestConnection = await register({ }); ``` +The `onClick` callback is invoked when a user clicks on the button. It does not receive any arguments. + ## Delete button ```js @@ -115,13 +119,6 @@ const guestConnection = await register({ }); ``` - -The `onClick` callback is invoked when a user clicks on the button. It does not receive any arguments. - - - -The `getButton` method is deprecated. When defining a single button, use `getButtons` and provide a single-item array. - ## API Reference ### Button API @@ -148,4 +145,4 @@ The `getButton` method is deprecated. When defining a single button, use `getBut | Field | Type | Required | Description | |----------|-----------------------------------------------------------------------------| ------ |------------------------------------------------------------------------------| -| id | `string` | ✔️ | "id" is a "data-id" attribute of the button. (Use browser developer console) | +| id | `string` | ✔️ | "id" is a "data-id" attribute of the button (please use browser developer console to find actual value). |