-
Notifications
You must be signed in to change notification settings - Fork 152
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.
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
Adds instructions for using custom langauges with Next.js #202
Open
kochie
wants to merge
4
commits into
FormidableLabs:master
Choose a base branch
from
kochie:master
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -40,8 +40,9 @@ _(If you just want to use your Prism CSS-file themes, that's also no problem)_ | |
|
||
|
||
- [Installation](#installation) | ||
- [Usage](#usage) | ||
- [Custom Language Support](#custom-language-support) | ||
- [Usage](#usage) | ||
- [Custom Language Support](#custom-language-support) | ||
- [Next.js](#nextjs) | ||
- [Basic Props](#basic-props) | ||
- [children](#children) | ||
- [language](#language) | ||
|
@@ -135,6 +136,64 @@ await import("prismjs/components/prism-applescript") | |
/** or **/ | ||
require("prismjs/components/prism-applescript") | ||
``` | ||
#### Next.js | ||
|
||
To enable custom languages that can be loaded with client components use the following pattern | ||
|
||
```tsx | ||
'use client' | ||
|
||
import React, { use } from 'react' | ||
import { Highlight, themes } from 'prism-react-renderer' | ||
|
||
const ExtraLanguages = Promise.all([ | ||
// eslint-disable-next-line @typescript-eslint/ban-ts-comment | ||
// @ts-ignore | ||
import('prismjs/components/prism-python'), | ||
// eslint-disable-next-line @typescript-eslint/ban-ts-comment | ||
// @ts-ignore | ||
import('prismjs/components/prism-julia'), | ||
]) | ||
|
||
const CodeBlock({code, language}) { | ||
use(ExtraLanguages) | ||
|
||
return <Highlight | ||
code={code} | ||
language={langauge} | ||
> | ||
{({ | ||
className, | ||
style, | ||
tokens, | ||
getLineProps, | ||
getTokenProps, | ||
}): ReactElement => () | ||
// Your Codeblock code | ||
} | ||
``` | ||
|
||
Wrap in a `Suspense` layer for best results | ||
|
||
```tsx | ||
import { Prism } from 'prism-react-renderer' | ||
import CodeBlock, { CodeBlockProps } from './codeblock' | ||
import { PropsWithChildren, Suspense } from 'react' | ||
|
||
;(typeof global !== 'undefined' ? global : window).Prism = Prism | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I like the idea of using suspense, but placing Prism in the globals might be counter to what we are trying to do in this library, which is avoid polluting the global namespace. |
||
|
||
export default async function LoadWrapper( | ||
props: PropsWithChildren<CodeBlockProps> | ||
) { | ||
return ( | ||
<> | ||
<Suspense fallback={<div>Loading languages</div>}> | ||
<CodeBlock {...props} /> | ||
</Suspense> | ||
</> | ||
) | ||
} | ||
``` | ||
|
||
|
||
## Basic Props | ||
|
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is
use
a generally available function yet, or still in canary?