NavBar

About 4 min

The Navbar contains:

Site title
Search Box
Navbar Links
Language dropdown
Repository Link
Outlook Popup

All of them are customizable, and you can also fully customize Navbar layout.

You can add links to the navbar via navbar options, it accepts an array.

String Format

The easiest way to configure the navbar is to fill in the paths of the page files to be displayed in turn, so that the text, icons and links of the item will be automatically generated from the corresponding files.

import { defineUserConfig } from "vuepress";
import { hopeTheme } from "vuepress-theme-hope";

export default defineUserConfig({
  theme: hopeTheme({
    navbar: ["/guide/README.md", "/config/README.md", "/faq.md"],
  }),
});

Tips

We recommend you to omit the .md extension, and paths ending with / are inferred as /README.md.

Object Format

If you are not satisfied with the page's icon or feel that the page title is too long, you can configure an object instead. Available configuration items are:

text:: item text
link: item link
icon: item icon (optional)
activeMatch: item active math (optional), support regexp strings

import { hopeTheme } from "vuepress-theme-hope";

export default {
  theme: hopeTheme({
    navbar: [
      {
        text: "Guide",
        link: "/guide/README.md",
        icon: "lightbulb",
        // only active in `/guide/`
        activeMatch: "^/guide/$",
      },
      { text: "Config", link: "/config/README.md", icon: "config" },
      {
        text: "FAQ",
        link: "/faq.md",
        icon: "circle-question",
        // active in path starting with `/faq`
        // so it will active in path like `/faq/xxx.html`
        activeMatch: "^/zh/faq/",
      },
    ],
  }),
};

Advanced usage of activeMatch

activeMatch gives you the ability to control whether the path is active, for example you may have the following dropdown:

/path/
/path/a/
/path/b/

But you may have multiple folders with files under /path/. To avoid multiple dropdown items been activated under route starting with /path/a/ or /path/b/, you can set activeMatch option for the first item with ^/path/(?:(?!a/|b/).*)?$.

To display more links, you can group similar links into a dropdown list.

You need to use object format and provide the additional children option to nest links:

import { hopeTheme } from "vuepress-theme-hope";

export default {
  theme: hopeTheme({
    navbar: [
      {
        text: "Basic",
        icon: "circle-info",
        children: ["/basic/markdown.md", "/basic/vuepress.md"],
      },
    ],
  }),
};

In most cases, the grouped items in the navbar belong to the same category and will be placed in the same subdirectory, and they have the same path prefix.

To simplify the configuration, you can add the prefix field to add a prefix to each sub-link in the group:

import { hopeTheme } from "vuepress-theme-hope";

export default {
  theme: hopeTheme({
    navbar: [
      {
        text: "Basic",
        icon: "circle-info",
        prefix: "/basic/",
        children: ["markdown.md", "vuepress.md"],
      },
    ],
  }),
};

You can also have subgroups inside a dropdown by having nested children:

import { hopeTheme } from "vuepress-theme-hope";

export default {
  theme: hopeTheme({
    navbar: [
      {
        text: "Project",
        icon: "circle-info",
        children: [
          {
            text: "Built in Plugins",
            children: [
              /* Some items */
            ],
          },
          {
            text: "Third party Plugins",
            children: [
              /* Some items */
            ],
          },
        ],
      },
    ],
  }),
};

To disable the navbar globally, set navbar: false in theme options:

import { hopeTheme } from "vuepress-theme-hope";

export default {
  theme: hopeTheme({
    navbar: false,
  }),
};

You can disable the navbar for a specific page via YAML front matter:

---
navbar: false
---

Site Logo

You can use logo options to set site logo displayed in navbar.

The logo is displayed on the navbar instead of the previous site name on mobile.

Note

Please fill in an absolute path and place the logo in .vuepress/public folder.

import { hopeTheme } from "vuepress-theme-hope";

export default {
  theme: hopeTheme({
    logo: "/logo.png",
  }),
};

Tips

You can set logoDark to display another logo in dark mode.

I18n Support

The theme's navbar supports I18n, so you can set navbar options mentioned above individually in each language:

import { hopeTheme } from "vuepress-theme-hope";

export default {
  theme: hopeTheme({
    locales: {
      "/": {
        logo: "/logo.svg",
        navbar: [
          /* English config under root */
        ],
      },
      "/zh/": {
        logo: "/zh-logo.svg",
        navbar: [
          /* Chinese config under zh folder */
        ],
      },
    },
  }),
};

Like the default theme, vuepress-theme-hope brings built-in support for search plugins. You can enable the following plugins according to your own needs. The corresponding search box will automatically appear in the navbar.

For details, please see Feature → Search.

Git Repository and Edit Links

A repo button will appear in navbar if you set repo in theme options.

You can control whether showing the repository button via repoDisplay in theme options.

import { hopeTheme } from "vuepress-theme-hope";

export default {
  theme: hopeTheme({
    // Assuming GitHub. Can also be a full url.
    repo: "vuepress-theme-hope/vuepress-theme-hope",
    // Customizing the header label
    // Defaults to "GitHub" / "GitLab" / "Gitee" / "Bitbucket" or "Source" depending on `repo`
    repoLabel: "GitHub",
    // Whether to display repo link, default is `true`
    repoDisplay: true,
  }),
};

The following three functions are provided:

Layout config

vuepress-theme-hope allows you to customize navbar layout. You can add components in start, center and end keys under navbarLayout options.

Navbar has the following built-in components that can be used:

Brand: Site Brand
Links: Navbar links
Language: Language Switcher
Search: Search Box
Outlook: Outlook Popup
Repo: Project Repo

And you can also use your own component names after you register them globally.

We use the following options by default:

import { hopeTheme } from "vuepress-theme-hope";

export default {
  theme: hopeTheme({
    navbarLayout: {
      start: ["Brand"],
      center: ["Links"],
      end: ["Language", "Repo", "Outlook", "Search"],
    },
  }),
};

Types and Helpers

vuepress-theme-hope exports the type of navbar as NavbarConfig, and provides a navbar helper function. They can provide validation and autocompletion of navbar configuration in TS and JS.

Tips

They mainly deal with scenarios when you split your VuePress configuration into multiple parts.

TS Helper

import { navbar } from "vuepress-theme-hope";

export default navbar([
  /* Your navbar configuration */
]);

TS Type

import type { NavbarConfig } from "vuepress-theme-hope";

const navbarConfig: NavbarConfig = [
  /* Your navbar configuration */
];

export default navbarConfig;

import { navbar } from "vuepress-theme-hope";

export default navbar([
  /* Your navbar configuration */
]);

Demo

Configuration of this documentation

import { navbar } from "vuepress-theme-hope";

export const enNavbarConfig = navbar([
  "/get-started/",
  "/guide/",
  "/config/",
  "/faq/",
  "/demo/",
  {
    text: "Others",
    icon: "circle-info",
    children: [
      {
        text: "Cookbook",
        prefix: "/cookbook/",
        children: ["markdown/", "vuepress/"],
      },
      {
        text: "Project",
        children: ["/changelog", "/related", "/contribution"],
      },
    ],
  },
]);