Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

react-slugify

2.0.1 • Public • Published

react-slugify

Build Status Dependencies

Slugify a React node

Usage

slugify(node[, options])

  • node String, Number, Fragment, Array of nodes
  • options Object (optional)
    • delimiter String (default is '-')
    • prefix String (default is '')

Examples

import slugify from 'react-slugify';
 
slugify('something I want to test');
// -> "something-i-want-to-test"
 
slugify(<span>Yes it works like that too</span>);
// -> "yes-it-works-like-that-too"
 
slugify(
  <>
    <span>and</span>
    <span>with</span>
    <span>fragments or arrays</span>
  </>
);
// -> "and-with-fragments-or-arrays"
 
slugify(
  <h3>Crème brulée receipe</h3>,
  { delimiter: '_' }
);
// -> creme_brulee_receipe
 
slugify(
  <h3>Crème brulée receipe</h3>,
  { prefix: 'user-content' }
);
// -> user-content-creme-brulee-receipe
 
 
slugify(
  <h3>Crème brulée receipe</h3>,
  { delimiter: '_', prefix: 'user-content' }
);
// -> user-content_creme_brulee_receipe

Install

npm i react-slugify

DownloadsWeekly Downloads

1,296

Version

2.0.1

License

MIT

Unpacked Size

8.09 kB

Total Files

6

Last publish

Collaborators

  • avatar