diff options
| author | Armand Philippot <git@armandphilippot.com> | 2022-04-19 12:12:15 +0200 |
|---|---|---|
| committer | Armand Philippot <git@armandphilippot.com> | 2022-04-19 12:12:15 +0200 |
| commit | 362cf45bc520a68a1c1be20e1189ca2307577dde (patch) | |
| tree | d9a300e065001b9c95670cda8225fd55706d52a5 /src/components/molecules/layout/code.tsx | |
| parent | a4a406463d69f6901919d273e831dff22a838caf (diff) | |
chore: add a Code component
Diffstat (limited to 'src/components/molecules/layout/code.tsx')
| -rw-r--r-- | src/components/molecules/layout/code.tsx | 101 |
1 files changed, 101 insertions, 0 deletions
diff --git a/src/components/molecules/layout/code.tsx b/src/components/molecules/layout/code.tsx new file mode 100644 index 0000000..2959ae5 --- /dev/null +++ b/src/components/molecules/layout/code.tsx @@ -0,0 +1,101 @@ +import usePrismPlugins, { + type PrismPlugin, +} from '@utils/hooks/use-prism-plugins'; +import { FC } from 'react'; +import styles from './code.module.scss'; + +export type PrismLanguage = + | 'apacheconf' + | 'bash' + | 'css' + | 'diff' + | 'docker' + | 'editorconfig' + | 'ejs' + | 'git' + | 'graphql' + | 'html' + | 'ignore' + | 'ini' + | 'javascript' + | 'jsdoc' + | 'json' + | 'jsx' + | 'makefile' + | 'markup' + | 'php' + | 'phpdoc' + | 'regex' + | 'scss' + | 'shell-session' + | 'smarty' + | 'tcl' + | 'toml' + | 'tsx' + | 'twig' + | 'yaml'; + +export type OptionalPrismPlugin = Extract< + PrismPlugin, + | 'command-line' + | 'diff-highlight' + | 'inline-color' + | 'line-highlight' + | 'line-numbers' +>; + +export type CodeProps = { + /** + * The code to highlight. + */ + children: string; + /** + * Filter command line output. Default: false. + */ + filterOutput?: boolean; + /** + * The code language. + */ + language: PrismLanguage; + /** + * The optional Prism plugins. + */ + plugins?: OptionalPrismPlugin[]; + /** + * Filter command line output using the given string. Default: #output# + */ + outputPattern?: string; +}; + +/** + * Code component + * + * Render a code block with syntax highlighting. + */ +const Code: FC<CodeProps> = ({ + children, + filterOutput = false, + language, + plugins = [], + outputPattern = '#output#', +}) => { + const { pluginsAttribute, pluginsClassName } = usePrismPlugins(plugins); + + const outputAttribute = filterOutput + ? { 'data-filter-output': outputPattern } + : {}; + + return ( + <div className={styles.wrapper}> + <pre + className={`language-${language} ${pluginsClassName}`} + {...pluginsAttribute} + {...outputAttribute} + > + <code className={`language-${language}`}>{children}</code> + </pre> + </div> + ); +}; + +export default Code; |
