Last updated

userMenu

The user menu is a navigation menu that displays in the far right side of the navbar. Users can click the user avatar and a dropdown menu displays with the avatar, the user's email address, links to pages you can configure, and a log out option.

Screenshot of the user menu with the dropdown displayed

You must also have sso and either rbac or requiresLogin configured for the userMenu to display.

Options

OptionTypeDescription
hidebooleanSpecifies if the User menu should be hidden. Only required if you do not add any other options to the configuration. Default: false.
hideLoginButtonbooleanSpecifies if the login button that displays in the far right side of the navbar should be hidden. Default: false.
itemsItemList of links in the User menu dropdown.

Item object

OptionTypeDescription
pagestringCONDITIONALLY REQUIRED. Path to the file which represents the page to link to. Mutually exclusive with the href option. If you use the page option, and do not include the label option, the text for the link on the sidebar will match the level 1 heading of the page.
hrefstringCONDITIONALLY REQUIRED. URL to link to. Mutually exclusive with the page option. If you use the href option, and do not include the label option, the text for the link on the sidebar will match the href option's value.
labelstringLink text displayed for the item.
labelTranslationKeystringLink text key for the item used for localization.
externalbooleanOpen link in new browser tab. Default is false.

Examples

userMenu:
  hide: false
  hideLoginButton: true
  items:
    - href: /my-settings/
      label: Settings
  • View options for adding more links to the navbar in the navbar configuration reference.
  • Configure sso and either rbac or requiresLogin to display the user menu in your navbar.

Resources

  • Learn more about how to configure RBAC in the how-to documentation.
  • Follow steps for configuring SSO in the how-to documentation.
  • Discover how RBAC works in Redocly products in the RBAC conceptual documentation.
 
Next page