Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

reactv16-mailto

srikanthbandaru122MIT0.4.4

A react component to create and display a mailto link.

react, react-component, email, mailto, markup

readme

React <Mailto> Build Status

A react component to create and display a mailto link.

Credits

Getting Started

  • Install with NPM - npm install --save reactv16-mailto

Usage

import React from 'react';
import Mailto from 'reactv16-mailto';

export const EmailComponent = () => (
    <Mailto email="xyz@abc.com" obfuscate={true} >
        Email me!
    </Mailto >
);

Options

Property Type Argument Default Description
email string <required> null email address of the intended recipient.
obfuscate boolean <optional> false show the email address in the status bar.
headers object <optional> null any standard mail header fields. The most commonly-used of these are "subject", "cc", and "body" (which is not a true header field, but allows you to specify a short content message for the new email).

Developing

reactv16-mailto is built using ES6. Run the following task to compile the src/ into dist/.

npm run build

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality.

License

Copyright (c) 2015 Srikanth Bandaru Licensed under the MIT license.