react-interpunct
v1.0.4
Published
React component to visibly display whitespace characters
Downloads
29
Readme
react-interpunct
React component to visibly display whitespace characters
Install
npm install --save react-interpunct
Usage
import React, { Component } from 'react'
import Interpunct from 'react-interpunct'
class Example extends Component {
render () {
return (
<Interpunct>Your text with spaces here </Interpunct>
)
}
}
Outputs
Your·text·with··spaces·here··
Props
| Property | Type | Default | Description |
|:--------------------|:-------------------|:--------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| children
| string | undefined | Text to be rendered with Interpunct |
| matchLength
| integer | 1 | Minimum number of consecutive whitespace characters to match before replacing |
| replacementString
| string | · (middle dot) | String used to replace whitespace characters |
| respectLength
| bool | true
| When true
the string given for replacementString
will be repeated to the length of the matched whitespace. When false
replacementString
will replace the entire match |
| enable
| bool | true
| If set to false
then children
will be returned without manipulation |
License
MIT © FoxxMD