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

feat(v2): add a way to exclude components from build-time prerendering #2323

Merged
merged 11 commits into from
Mar 29, 2020
Merged

feat(v2): add a way to exclude components from build-time prerendering #2323

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
c561a33
feat(v2): add a way to exclude components from SSR within JSX
lex111 Feb 25, 2020
c43b40b
Update docusaurus-core.md
yangshun Feb 26, 2020
b0a42d0
Update and rename ClientOnly.js to BrowserOnly.js
yangshun Feb 26, 2020
6794da6
improve docs
yangshun Feb 26, 2020
109d4aa
Improve naming
lex111 Feb 26, 2020
bdccc70
Simplify realization
lex111 Mar 26, 2020
717077f
Merge github.com:facebook/docusaurus into feat-exclude-ssr
lex111 Mar 28, 2020
12f3047
Merge branch 'feat-exclude-ssr' of github.com:facebook/docusaurus int…
lex111 Mar 28, 2020
a774ca1
Fix code style
lex111 Mar 28, 2020
5138078
Fix docs
lex111 Mar 29, 2020
63ee326
Update docusaurus-core.md
yangshun Mar 29, 2020
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
17 changes: 17 additions & 0 deletions packages/docusaurus/src/client/exports/BrowserOnly.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
/**
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/

import React from 'react';
import ExecutionEnvironment from '@docusaurus/ExecutionEnvironment';

function BrowserOnly({children}) {
return (
ExecutionEnvironment.canUseDOM && children != null && <>{children()}</>
);
}

export default BrowserOnly;
12 changes: 12 additions & 0 deletions website/docs/docusaurus-core.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,18 @@ function Home() {
}
```

### `<BrowserOnly/>`

This component excludes its `children` during the prerendering stage of the build process. This is useful for hiding code that is only meant to run in the browsers (e.g. where the `window`/`document` objects are being accessed).

```jsx {1,7}
lex111 marked this conversation as resolved.
Show resolved Hide resolved
import BrowserOnly from '@docusaurus/BrowserOnly';

<BrowserOnly>
{/* Something that should be excluded during build process prerendering. */}
Copy link
Contributor

Choose a reason for hiding this comment

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

We need to give an example to show that children should be a render function and not normal children.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah yes, done ✔️

</BrowserOnly>;
```

## Hooks

### `useDocusaurusContext`
Expand Down