From 9391a33c41d91a728320366e7d7950b997328eb7 Mon Sep 17 00:00:00 2001 From: TheCatLady <52870424+TheCatLady@users.noreply.github.com> Date: Thu, 29 Jun 2023 03:13:48 -0700 Subject: [PATCH] fix(content-docs): sidebar generator should return customProps for doc items (#9107) --- .../__tests__/__snapshots__/generator.test.ts.snap | 3 +++ .../src/sidebars/__tests__/generator.test.ts | 1 + .../src/sidebars/generator.ts | 7 ++++++- 3 files changed, 10 insertions(+), 1 deletion(-) diff --git a/packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/__snapshots__/generator.test.ts.snap b/packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/__snapshots__/generator.test.ts.snap index e042c36658..29dd570e23 100644 --- a/packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/__snapshots__/generator.test.ts.snap +++ b/packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/__snapshots__/generator.test.ts.snap @@ -86,6 +86,9 @@ exports[`DefaultSidebarItemsGenerator generates simple flat sidebar 1`] = ` "type": "doc", }, { + "customProps": { + "custom": "prop", + }, "id": "doc1", "label": "doc1 sidebar label", "type": "doc", diff --git a/packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/generator.test.ts b/packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/generator.test.ts index 43e40938df..f8fb292874 100644 --- a/packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/generator.test.ts +++ b/packages/docusaurus-plugin-content-docs/src/sidebars/__tests__/generator.test.ts @@ -64,6 +64,7 @@ describe('DefaultSidebarItemsGenerator', () => { sidebarPosition: 2, frontMatter: { sidebar_label: 'doc1 sidebar label', + sidebar_custom_props: {custom: 'prop'}, }, title: '', unversionedId: 'doc1', diff --git a/packages/docusaurus-plugin-content-docs/src/sidebars/generator.ts b/packages/docusaurus-plugin-content-docs/src/sidebars/generator.ts index 7dc6ece7be..5a6b325449 100644 --- a/packages/docusaurus-plugin-content-docs/src/sidebars/generator.ts +++ b/packages/docusaurus-plugin-content-docs/src/sidebars/generator.ts @@ -138,7 +138,11 @@ Available doc IDs: ): WithPosition { const { sidebarPosition: position, - frontMatter: {sidebar_label: label, sidebar_class_name: className}, + frontMatter: { + sidebar_label: label, + sidebar_class_name: className, + sidebar_custom_props: customProps, + }, } = getDoc(id); return { type: 'doc', @@ -149,6 +153,7 @@ Available doc IDs: // sidebar ...(label !== undefined && {label}), ...(className !== undefined && {className}), + ...(customProps !== undefined && {customProps}), }; } function createCategoryItem(