react-mark-ii
v2.2.0
Published
Ultra small and fast text formatter for React
Downloads
10
Maintainers
Readme
Features
- Very small (parser is just 50 lines of code!)
- Super fast!
- Dependency free
- Configurable
Live demo
Install
npm install --save react-mark-ii
Simple example
import Mark from 'react-mark-ii';
//...
const str = '*bold* _emphasis_ ~strike~ `code` ```code\nblock```';
//...
<Mark>{str}</Mark>
Render result:
<div>
<strong>bold</strong>
<em>emphasis</em>
<del>strike</del>
<code>code</code>
<pre>
code
block
</pre>
</div>
Custom options
With the options
prop you can define your own markup:
Available mark options:
renderer
: React component or tag name stringraw
: (defaultfalse
) iftrue
, inner marks will be ignored (useful for code marks)multiline
: (defaultfalse
) iftrue
marks can be used across multiple linesalwaysOpen
: (defaultfalse
) by default, marks must be set after a break character (space or punctuation) and joined to an alphanumeric string). WithalwaysOpen
set totrue
you can ignore these checks. This is useful, for example, for multiline code blocks which may contain spaces after the mark.
import Mark from 'react-mark-ii';
//...
const options = {
'**': {renderer: 'b'},
'_': {renderer: 'u'},
'~': {renderer: ({children}) => <span className="red">{children}</span>},
'`': {renderer: 'kbd', raw: true},
'```': {renderer: 'pre', raw: true, multiline: true, alwaysOpen: true},
};
const str = '**bold** _underline_ ~strike~ `code` ```code\nblock```';
//...
<Mark options={options}>{str}</Mark>
Render result:
<div>
<b>bold</b>
<u>underline</u>
<span class="red">strike</span>
<kbd>code</kbd>
<pre>
code
block
</pre>
</div>
Custom wrapper
By default your children will be wrapped with a div
. Use the wrap
prop to have a different wrapper. You can use a React component or a tag name string.
<Mark wrap="span">*text*</Mark>
Render result:
<span>
<strong>text</strong>
</span>
Other props
All other props are passed to the wrapper
<Mark className="my-class" style={{background: '#ddd'}}>*text*</Mark>
Render result:
<div class="my-class" style="background:#ddd;">
<strong>text</strong>
</div>
License
MIT