node package manager
Easy sharing. Manage teams and permissions with one click. Create a free org ยป

@mitchallen/react-email-input-field

@mitchallen/react-email-input-field

EmailInputField React component

Continuous Integration Coverage Status Downloads Version License

Installation

$ npm init
$ npm install @mitchallen/react-email-input-field --save

Usage

1: Add this line near the top of your file (like src/App.js):

import EmailInputField from '@mitchallen/react-email-input-field';

NOTE: EmailInputField must be Capitalized or component won't render.

2: Somewhere in the middle of the render method add this line:

<EmailInputField />

Simple Test

$ create-react-app react-email-input-field-test
$ cd react-email-input-field-test/
$ npm install @mitchallen/react-email-input-field --save
$ npm install --save material-ui

Modify src/App.js

import React, { Component } from 'react';
import logo from './logo.svg';
import './App.css';

// Must include MuiThemeProvider!
import MuiThemeProvider from 'material-ui/styles/MuiThemeProvider';
import EmailInputField from '@mitchallen/react-email-input-field';

class App extends Component {
  render() {
    return (
      // Must wrap w MuiThemeProvider 
      <MuiThemeProvider>
        <div className="App">
          <div className="App-header">
            <img src={logo} className="App-logo" alt="logo" />
            <h2>Welcome to React</h2>
          </div>
          <p className="App-intro">
            To get started, edit <code>src/App.js</code> and save to reload.
          </p>
          <EmailInputField />
        </div>
      </MuiThemeProvider>
    );
  }
}

export default App;

Run the app

$ npm start

Testing

Run the Tests

To test, go to the root folder and type (sans $):

$ npm test

Repo(s)


Contributing

In lieu of a formal style guide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code.


Version History

Version 0.1.5

  • updated .circleci/config.yml to install react peer dependency

Version 0.1.4

  • React really is now just a peer dependency (accidentally installed locally with --save for testing ...)

Version 0.1.3

  • Cleaned up react and prop-types dependencies
  • React is now a peer dependency and assumes parent project will install

Version 0.1.2

  • Updated documentation

Version 0.1.1

  • fixed test case

Version 0.1.0

  • initial release