Skip to main content
Release version: βversion

Sidebar layout

Sidebar layout lets you customize the structure of the sidebar menu shown on the left side of the admin panel.
You can hide menu items, change their display names and icons, reorder them, add folders and links, and switch which layout applies to each administrator.

Accessing the screen​

Click [Environment] -> [Sidebar layout].

Image from Gyazo

The sidebar layout list screen is displayed.

Item descriptions​

Image from Gyazo

ItemDescription
CheckboxSelects rows for bulk operations.
Usage settingShows whether the layout is set to "Use" or "Do not use".
IDID of the sidebar layout.
NameName of the sidebar layout. Click it to open the sidebar layout editor screen.
OrderPriority of the layout. Larger values take precedence.

The list is sorted by order, from largest to smallest.

Actions​

ButtonDescription
AddOpens the sidebar layout editor screen (new).
Bulk [Use] / [Do not use]Changes the usage setting of the checked rows at once.

How the applied layout is determined​

When an administrator opens the admin panel, exactly one layout is chosen as follows.

  1. Layouts whose usage setting is "Use" and whose access limit matches the administrator are candidates.
  2. Among the candidates, the layout with the largest order is applied.
  3. If the order is the same, the layout with the smaller ID takes precedence.

Layouts are never merged. If no layout matches, the default sidebar is displayed.

Editing a sidebar layout​

Accessing the screen​

On the sidebar layout list screen, click the name of the sidebar layout you want to edit.
To add a new sidebar layout, click the [Add] button.

Image from Gyazo

Field descriptions​

Image from Gyazo

FieldDescription
Name (required)Enter the name of the sidebar layout. This is an administrative name and is not shown in the sidebar.
OrderEnter the priority of the layout as a number. When several layouts match, the one with the larger value is applied.
Access limitSets which administrators the layout applies to.
・None: All administrators are targeted.
・Member group: Administrators belonging to the selected groups are targeted. Multiple selection is possible. Select at least one.
・Member search conditions: Administrators matching the selected custom member filters are targeted. Multiple selection is possible. Select at least one.
Usage settingSelect "Use" to apply this layout to matching administrators. When "Do not use" is selected, the layout is not applied.
Sidebar layout editorEdits the sidebar menu structure. See Sidebar layout editor.

Actions​

ButtonDescription
AddShown when creating a new layout. Saves the entered content.
UpdateShown when editing an existing layout. Saves the entered content.
DeleteShown when editing an existing layout. Deletes the layout.
[More] -> [Changelog]Shown when editing an existing layout. Displays the update history of the layout.

The sidebar layout editor shows the tree of menu items on the left and the settings of the selected item on the right.

Image from Gyazo

Editor items​

ItemDescription
LanguageSelects the language whose display names you are editing. Different display names can be set per language.
[Add] buttonOpens a dialog to add a folder or link. See Adding folders and links.
Menu item treeShows the current sidebar structure. Items set to hidden have a "Hidden" badge.
[Edit] buttonSelects the item and shows its settings on the right.
[Move up] / [Move down] buttonsMoves the item one position at a time.
Expand / collapse childrenToggles the display of child items.

Settings of the selected item​

ItemDescription
NameEnter the display name in the selected language.
IconSelect the icon of the item.
ParentSelect the folder (parent item) in which the item is placed.
HiddenWhen checked, the item is not shown in the sidebar.
[Apply changes] buttonApplies the settings edited on the right to the tree.

Items can also be reordered and moved to another parent by drag and drop.

caution

Changes made in the editor are not saved until you click the [Add] or [Update] button.

Click the [Add] button to open the add dialog.

Image from Gyazo

ItemDescription
TypeSelect "Folder" or "Link". A folder groups child items; a link navigates to the specified URL.
ParentSelect the parent item under which the new item is added.
NameEnter the display name in the selected language.
IconShown when the type is "Folder". Select the icon of the folder.
URLShown when the type is "Link". Enter the destination URL.

The link URL must be one of the following.

  • Admin panel page: an existing admin panel URL in the form /management/module/action/.
  • External site: a URL starting with http:// or https://.

Editing restrictions​

  • Hiding an item does not change access permissions to that page. Access permissions are configured in Group.
  • Child items that are generated automatically from settings, such as content structures, can only be renamed or hidden. To place them in another folder, hide the original item and add a link with the same URL.
  • Sections (the large headings of the sidebar) cannot be hidden or moved.
  • The [Sidebar layout] item and its parent items cannot be hidden.
  • Up to 1000 changes can be saved per layout.

Required permissions​

Operating sidebar layouts requires the "Site" permission in the group permission settings.

OperationRequired permission
Viewing the list and editor screensSite: view
AddingSite: add
Updating and changing the usage settingSite: update
DeletingSite: delete

Support

If you have any other questions, please contact us or check out Our Slack Community.