rn-syntax-highlighter
v2.3.0
Published
a react native component for syntax highlighting
Downloads
85
Maintainers
Readme
React Native Syntax Highlighter (fork)
Syntax highlighting component for React Native
using react-syntax-highlighter
With Highlight.js vdom
With Prism vdom
Install
npm install rn-syntax-highlighter --save
Use
props
Accepts all of the same props as react-syntax-highlighter
with three additional props.
fontFamily
- the font family to use for syntax text.fontSize
- the fontSize for syntax text.highligter
- defaults to rendering with vdom created from highlightjs, but can pass inprism
as alternate option. You can see more about dealing with the prism highlighter in the docs for react-syntax-highlighter but one of the main uses would be better support for jsx
Example
import SyntaxHighlighter from 'rn-syntax-highlighter';
/*by default component uses hljs so access hljs styles, import from /prism for prism styles */
import { docco } from 'react-syntax-highlighter/dist/esm/styles/hljs';
const Component = () => {
const codeString = '(num) => num + 1';
return <SyntaxHighlighter
language='javascript'
style={docco}
highlighter={"prism" || "hljs"}
>
{codeString}
</SyntaxHighlighter>;
}
Unsupported Props
Some of the react-syntax-highlighter props are not currently supported by the mobile version, you can see which listed below:
- useInlineStyles
- showLineNumbers
- startingLineNumber
- lineNumberContainerStyle
- lineNumberStyle
Styles Available -- hljs
- agate
- androidstudio
- arduinoLight
- arta
- ascetic
- atelierCaveDark
- atelierCaveLight
- atelierDuneDark
- atelierDuneLight
- atelierEstuaryDark
- atelierEstuaryLight
- atelierForestDark
- atelierForestLight
- atelierHeathDark
- atelierHeathLight
- atelierLakesideDark
- atelierLakesideLight
- atelierPlateauDark
- atelierPlateauLight
- atelierSavannaDark
- atelierSavannaLight
- atelierSeasideDark
- atelierSeasideLight
- atelierSulphurpoolDark
- atelierSulphurpoolLight
- atomOneDark
- atomOneLight
- brownPaper
- codepenEmbed
- colorBrewer
- darcula
- dark
- darkula
- defaultStyle
- docco
- dracula
- far
- foundation
- githubGist
- github
- googlecode
- grayscale
- gruvboxDark
- gruvboxLight
- hopscotch
- hybrid
- idea
- irBlack
- kimbieDark
- kimbieLight
- magula
- monoBlue
- monokaiSublime
- monokai
- obsidian
- ocean
- paraisoDark
- paraisoLight
- pojoaque
- purebasic
- qtcreatorDark
- qtcreatorLight
- railscasts
- rainbow
- routeros
- schoolBook
- solarizedDark
- solarizedLight
- sunburst
- tomorrowNightBlue
- tomorrowNightBright
- tomorrowNightEighties
- tomorrowNight
- tomorrow
- vs
- vs2015
- xcode
- xt256
- zenburn
Styles Available -- prism
- coy
- dark
- funky
- okaidia
- solarizedlight
- tomorrow
- twilight
- prism
- atomDark
- base16AteliersulphurpoolLight
- cb
- darcula
- duotoneDark
- duotoneEarth
- duotoneForest
- duotoneLight
- duotoneSea
- duotoneSpace
- ghcolors
- hopscotch
- pojoaque
- vs
- xonokai
LICENSE
Copyright (c) 2019 Conor Hastings Released under MIT license