feat(core): allow to unset the title tag (#3714)

web-infra-dev · Oct 14, 2024 · 50ade94 · 50ade94
1 parent 3c1a145
commit 50ade94
Show file tree

Hide file tree

Showing 4 changed files with 37 additions and 11 deletions.
diff --git a/e2e/cases/html/title/index.test.ts b/e2e/cases/html/title/index.test.ts
@@ -18,7 +18,7 @@ test('should generate default title correctly', async () => {
   expect(html).toContain('<title>Rsbuild App</title>');
 });
 
-test('should allow setting empty title to override default title', async () => {
+test('should allow setting empty title to unset the default title', async () => {
   const rsbuild = await build({
     cwd: __dirname,
     rsbuildConfig: {
@@ -34,7 +34,7 @@ test('should allow setting empty title to override default title', async () => {
 
   const html =
     files[Object.keys(files).find((file) => file.endsWith('foo.html'))!];
-  expect(html).toContain('<title></title>');
+  expect(html).not.toContain('<title>');
 });
 
 test('should generate title correctly', async () => {

diff --git a/packages/core/src/rspack/RsbuildHtmlPlugin.ts b/packages/core/src/rspack/RsbuildHtmlPlugin.ts
@@ -213,13 +213,15 @@ const applyTagConfig = (
 };
 
 const addTitleTag = (headTags: HtmlTagObject[], title = '') => {
-  headTags.unshift({
-    tagName: 'title',
-    innerHTML: title,
-    attributes: {},
-    voidTag: false,
-    meta: {},
-  });
+  if (title !== '' && title !== undefined) {
+    headTags.unshift({
+      tagName: 'title',
+      innerHTML: title,
+      attributes: {},
+      voidTag: false,
+      meta: {},
+    });
+  }
 };
 
 export class RsbuildHtmlPlugin {

diff --git a/website/docs/en/config/html/title.mdx b/website/docs/en/config/html/title.mdx
@@ -55,3 +55,15 @@ export default {
   },
 };
 ```
+
+## Unset `<title>` Tag
+
+When `html.title` is set to an empty string, Rsbuild will not inject the `<title>` tag:
+
+```js
+export default {
+  html: {
+    title: '',
+  },
+};
+```
diff --git a/website/docs/zh/config/html/title.mdx b/website/docs/zh/config/html/title.mdx
@@ -9,7 +9,7 @@
 如果当前项目使用的 HTML 模板中已经包含了 `<title>` 标签，那么 `html.title` 将不会生效。
 :::
 
-### 字符串用法
+## 字符串用法
 
 当 `html.title` 可以直接设置为一个字符串：
 
@@ -27,7 +27,7 @@ export default {
 <title>Example</title>
 ```
 
-### 函数用法
+## 函数用法
 
 - **类型：**
 
@@ -55,3 +55,15 @@ export default {
   },
 };
 ```
+
+## 不注入 title 标签
+
+当 `html.title` 设置为空字符串时，Rsbuild 不会注入 `<title>` 标签：
+
+```js
+export default {
+  html: {
+    title: '',
+  },
+};
+```