Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(core,theme): useRouteContext + HtmlClassNameProvider #6933

Merged
merged 7 commits into from
Mar 18, 2022
Merged

feat(core,theme): useRouteContext + HtmlClassNameProvider #6933

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
ee9a213
add useRouteContext
slorber Mar 17, 2022
840237c
add HtmlClassNameProvider component + make it work for docs versions
slorber Mar 17, 2022
032516e
create html className for doc id
slorber Mar 17, 2022
fb5d766
refactors
Josh-Cena Mar 18, 2022
a52601e
remove generic
Josh-Cena Mar 18, 2022
ef38c6c
refactor...
Josh-Cena Mar 18, 2022
89978ea
fix build failure
Josh-Cena Mar 18, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/docusaurus-types/src/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -381,7 +381,7 @@ export interface RouteContext {
/**
* Plugin-specific context data.
*/
data: object | undefined;
data?: object | undefined;
}

/**
Expand Down
11 changes: 10 additions & 1 deletion packages/docusaurus/src/client/exports/ComponentCreator.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,16 @@ export default function ComponentCreator(
if (path === '*') {
return Loadable({
loading: Loading,
loader: () => import('@theme/NotFound'),
loader: async () => {
const NotFound = (await import('@theme/NotFound')).default;
return (props) => (
// Is there a better API for this?
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤪 good catch

There's also a native "Loading" screen but afaik it's never displayed so 🤷‍♂️

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, the "native" name isn't the best, but I don't think this will be targeted anyways...

<RouteContextProvider
value={{plugin: {name: 'native', id: 'default'}}}>
<NotFound {...(props as never)} />
</RouteContextProvider>
);
},
});
}

Expand Down
1 change: 1 addition & 0 deletions packages/docusaurus/src/client/routeContext.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ function mergeContexts({
return value;
}

// TODO deep merge this
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not sure we really want to deep merge

In case there are multiple layers I'd rather ensure that laters do not override each others, there's no good use-case to do so that I can think of
We can keep the comment for now and figure this out later anyway

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it would be immediately useful for content plugins, but maybe in userland? Deep merging sounds more natural about how these stores should behave

const data = {...parent.data, ...value?.data};

return {
Expand Down