Skip to content

Latest commit

 

History

History
64 lines (52 loc) · 2.86 KB

index.en.md

File metadata and controls

64 lines (52 loc) · 2.86 KB
type aliases title linkTitle date draft nav_weight nav_icon series categories tags images authors
docs
/en/docs/modules/header/menus/
Header Menus
Menus
2023-02-17 00:43:12 +0800
false
2
vendor name
bs
list
Docs
Modules
Header
Menus
Header Menus
HB

This article describes how to configure the header's menus.

{{< bs/alert info >}} The header's menus maximum depth is limited up to two levels. {{< /bs/alert >}}

Menus Set Identifier

The main is taken as the header's menus set identifier.

Header Menu Entry Params

Parameter Type Description
header string The header of dropdown menus, available on top level menu only.
divider boolean Show the divider if true.
description string The description for sub menus only, default to page description.
columns number The column count of sub menus, up to 2, default to 1 when the number of menus is less than 6, otherwise 2.
icon object The icon parameters.
icon.vendor string The icon's vendor, required.
icon.name string The icon's name, required.
icon.color string The icon's color.
icon.className string The icon's CSS class name.
target string The link target attribute.
rel string The link rel attribute.

See also [Menus Configuration]({{< ref "docs/configuration/menus" >}}) and [Icons Configuration]({{< ref "docs/configuration/icons" >}}).

Example

Header's Menus Example

{{< bs/config-toggle filename=menus >}} {{% code-snippet example.yaml %}} {{< /bs/config-toggle >}}

The example above use the Bootstrap icons, you can use other icons vendors, such as Font Awesome, Feather, Tabler, Simple icons and so on.