npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

react-mark-ii

v2.2.0

Published

Ultra small and fast text formatter for React

Downloads

9

Readme

Features

  • Very small (parser is just 50 lines of code!)
  • Super fast!
  • Dependency free
  • Configurable

Live demo

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 string
  • raw: (default false) if true, inner marks will be ignored (useful for code marks)
  • multiline: (default false) if true marks can be used across multiple lines
  • alwaysOpen: (default false) by default, marks must be set after a break character (space or punctuation) and joined to an alphanumeric string). With alwaysOpen set to true 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

Logo font