Skip to content

Update addSettingsLink documentation to show array support #3277

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
pwizla wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Update addSettingsLink documentation to show array support #3277

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docusaurus/docs/cms/plugins-development/admin-navigation-settings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,7 @@ The `createSettingSection()` function accepts the following parameters:

### Adding links to existing settings sections

To add a single link to an existing settings section, use `addSettingsLink()` in the `bootstrap()` lifecycle function. To add multiple links at once, use `addSettingsLinks()`.
To add links to an existing settings section, use `addSettingsLink()` in the `bootstrap()` lifecycle function. The method accepts either a single link or an array of links.

<Tabs groupId="js-ts">
<TabItem value="js" label="JavaScript" default>
Expand Down Expand Up @@ -288,7 +288,7 @@ export default {

// Add multiple links at once to the global settings section
// highlight-start
app.addSettingsLinks('global', [
app.addSettingsLink('global', [
{
intlLabel: {
id: 'my-plugin.settings.general',
Expand Down Expand Up @@ -344,7 +344,7 @@ export default {

// Add multiple links at once to the global settings section
// highlight-start
app.addSettingsLinks('global', [
app.addSettingsLink('global', [
{
intlLabel: {
id: 'my-plugin.settings.general',
Expand Down Expand Up @@ -372,7 +372,7 @@ export default {
</TabItem>
</Tabs>

`addSettingsLink` and `addSettingsLinks` both take a `sectionId` string as the first argument (e.g., `'global'` or `'permissions'`). The second argument is a single link object for `addSettingsLink` or an array of link objects for `addSettingsLinks`, using the same properties as the `links` array in [`createSettingSection()` (see table above)](#creating-a-new-settings-section).
`addSettingsLink` takes a `sectionId` string as the first argument (e.g., `'global'` or `'permissions'`). The second argument is either a single link object or an array of link objects, using the same properties as the `links` array in [`createSettingSection()` (see table above)](#creating-a-new-settings-section).

### Available settings sections

Expand Down
Loading