title

  • Type: string | Function
  • Default: 'Rsbuild App'

Set the title tag of the HTML page.

TIP

If the HTML template used in the current project already includes the <title> tag, the html.title will not take effect.

String Usage

html.title can be directly set as a string:

export default {
  html: {
    title: 'Example',
  },
};

The title tag generated in HTML will be:

<title>Example</title>

Function Usage

  • Type:
type TitleFunction = ({ value: string; entryName: string }) => string | void;

When html.title is of type Function, the function receives an object as the argument, and the object's values include:

  • value: the default title configuration of Rsbuild.
  • entryName: the name of the current entry.

In the MPA (multi-page application) scenario, you can return different title strings based on the entry name, thus generating different title tags for each page:

export default {
  html: {
    title({ entryName }) {
      const titles = {
        foo: 'Foo Page',
        bar: 'Bar Page',
      };
      return titles[entryName] || 'Other Page';
    },
  },
};