3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-06-03 11:22:30 +02:00
Code Issues Projects Releases Packages Wiki Activity

docs: improve sidebar items custom props docs (#8888)

Browse source
This commit is contained in:
Sébastien Lorber 2023-04-13 11:24:27 +01:00 • committed by GitHub
parent 35183d7d87
commit 14586895ae
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
13 changed files with 42 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

7
website/versioned_docs/version-2.0.1/guides/docs/sidebar/index.mdx
View file

@ -157,15 +157,18 @@ module.exports = {
## Passing custom props {#passing-custom-props}
To pass in custom props to a swizzled sidebar item, add the optional `customProps` object to any of the items:
To pass in custom props to a sidebar item, add the optional `customProps` object to any of the items. This is useful to apply site customizations by swizzling React components rendering sidebar items.
```js
{
type: 'doc',
id: 'doc1',
// highlight-start
customProps: {
/* props */
badges: ['new', 'green'],
featured: true,
},
// highlight-end
};
```