-
Notifications
You must be signed in to change notification settings - Fork 151
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
base: master
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
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) | ||
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. Is |
||
|
||
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. 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. Using suspense makes the component client-only though, it means built-in languages will be rendered server-side, but extra languages will need JS on the client to work. Personally I would like this library to work completely on the server, like Bright does. 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. Also, this should be called on the client side component along the server one. |
||
|
||
export default async function LoadWrapper( | ||
props: PropsWithChildren<CodeBlockProps> | ||
) { | ||
return ( | ||
<> | ||
<Suspense fallback={<div>Loading languages</div>}> | ||
<CodeBlock {...props} /> | ||
</Suspense> | ||
</> | ||
) | ||
} | ||
``` | ||
|
||
|
||
## Basic Props | ||
|
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.