Move sidebar logic to theme #3133
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rogermparent
force-pushed
the
sidebar-to-plugin
branch
from
baf3fa9 to
8b92ebe
Compare
rogermparent
temporarily deployed
to
dvc-org-sidebar-to-plug-prlusp
rogermparent
temporarily deployed
to
dvc-org-sidebar-to-plug-prlusp
rogermparent
temporarily deployed
to
dvc-org-sidebar-to-plug-prlusp
rogermparent
temporarily deployed
to
dvc-org-sidebar-to-plug-prlusp
rogermparent
commented
Dec 29, 2021
Comment on lines
-125
to
+88
| function normalizeSidebar({ | ||
| function normalizeSidebar( | ||
| data, | ||
| parentPath, | ||
| parentResultRef, | ||
| startingPrevRef | ||
| }) { | ||
| { parentPath = '', parentResultRef, startingPrevRef } = {} | ||
| ) { |
There was a problem hiding this comment.
Small tweak to the signature to make this function more natural to use IMO, the rest of the args are only used in recursive calls so the function's practically unary.
| @@ -0,0 +1 @@ | |||
| module.exports = [] | |||
There was a problem hiding this comment.
Just here to be shadowed
Comment on lines
35
to
+44
| interface ISidebarMenuItemProps { | ||
| children?: Array<{ label: string; path: string; source: boolean | string }> | ||
| label: string | ||
| path: string | ||
| source: boolean | string | ||
| item: INormalizedSidebarItem | ||
| onClick: (isLeafItemClicked: boolean) => void | ||
| activePaths?: Array<string> | ||
| type?: string | ||
| style?: string | ||
| icon?: string | ||
| } | ||
|
|
||
| const SidebarMenuItem: React.FC<ISidebarMenuItemProps> = ({ | ||
| children, | ||
| label, | ||
| path, | ||
| item: { children, label, path, style, icon, type }, | ||
| activePaths, | ||
| onClick, | ||
| style, | ||
| icon, | ||
| type | ||
| onClick |
There was a problem hiding this comment.
Slight signature tweak which makes more sense to me now that we have a type def for sidebar items.
Comment on lines
+1
to
+4
| /* eslint-disable @typescript-eslint/no-var-requires */ | ||
| const normalizeSidebar = require('../../plugins/gatsby-theme-iterative-docs/normalize-sidebar') | ||
| const sidebar = require('../../content/docs/sidebar.json') | ||
| module.exports = normalizeSidebar(sidebar) |
There was a problem hiding this comment.
This shadowed sidebar file must be present at this specific path and default export a normalized sidebar. It also must be ES5 format to be used in gatsby-node contexts like remark plugins and server redirects- while non-webpack contexts don't recognize shadows, they can still require this file directly.
rogermparent
temporarily deployed
to
dvc-org-sidebar-to-plug-prlusp
rogermparent
force-pushed
the
sidebar-to-plugin
branch
from
0c83a11 to
a24e1d6
Compare
rogermparent
temporarily deployed
to
dvc-org-sidebar-to-plug-prlusp
rogermparent
temporarily deployed
to
dvc-org-sidebar-to-plug-prlusp
|
@rogermparent is it still a draft, should we merge this? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
#3143 was originally part of this, but moved to make reviewing each individual feature easier.
This PR moves all our sidebar logic to our new reusable Gatsby theme.
Since the sidebars and logic have to be imported in both Gatsby Webpack and plain node environments while still being reusable, the sidebar leans on Gatsby Themes but in such a way that it can work in regular node. To help make this possible, sidebar normalization and helpers have been split and the helpers must be called on an imported instance of the sidebar- this helps particularly with plain Node.