JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 17522
  • Score
    100M100P100Q149591F
  • License MIT

React component which render text with anchored url(s)

Package Exports

  • react-anchorify-text

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (react-anchorify-text) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

React-anchorify-text Build Status npm version codebeat badge

Create anchor tag with urls in text.

Demo

View Demo

Installation

npm install --save react-anchorify-text

API

AnchorifyText

Props

AnchorifyText.propTypes = {
  text: React.PropTypes.string.isRequired,
  linkify: React.PropTypes.object,
  flags: React.PropTypes.string,
  nonUrlPartsRenderer: PropTypes.func,
};
  • text: String to parse url

  • linkify: An instance of linkify-it. default: new LinkifyIt().tlds(require('tlds'))

  • target: href target for anchor tag, default to "_blank".

  • nonUrlPartsRenderer: callback for non-url parts of the text.

  • regex: Regular expression as string to detect url .

  • flags: Regular expression's frag, default to "ig".

regex and flags props are removed from v2.0.0. Use linkify-it instance instead.

Children

If no children are passed to AnchorifyText, found urls will be rendered as <a> tag. If one child are passed to AnchorifyText, found urls are rendered as child tag with url as prop.

Usage example

const textWithUrl = "Hello Google(http://google.com) and GitHub => https://github.com/ and Apple(www.apple.com)";

<AnchorifyText text={textWithUrl}></AnchorifyText>

<AnchorifyText text={textWithUrl}>
  <MyCustomAnchor></MyCustomAnchor>
</AnchorifyText>

See example

yarn
yarn run start:example

Tests

yarn run test

Update dependencies

Use npm-check-updates