@namefully/react

React-based component for handling person names

Usage no npm install needed!

<script type="module">
  import namefullyReact from 'https://cdn.skypack.dev/@namefully/react';
</script>

README

@namefully/react

npm version CircleCI MIT License

Description

namefully's React version.

Try it live.

Installation

npm i @namefully/react

Peer Dependencies

  • React
  • namefully ^1.0.6

Usage

import * as React from 'react';
import * as ReactDOM from 'react-dom';

import { Namefully } from '@namefully/react';

const App = () => {
    return (
        <h1>
            Hello, <Namefully raw='John Smith'/>!
        </h1>
    )
};

ReactDOM.render(<App />, document.getElementById('example'));

Demo

To view a demo:

  • clone or download a copy of the repository.
  • install the dependencies npm install
  • finally, run npm start

The last command will bootstrap a demo by running a local web server. Use a browser and type the following web address localhost:3000 to load the content.

Read more

As this is a wrapper of the core utility, visit the main page to learn more about its key features, configurations, limitations, and API.

Author

Developed by Ralph Florent.

License

The underlying content of this project is licensed under MIT.