https://github.com/axyz/react-callout

Lightweight and stateless callout component for React.js
https://github.com/axyz/react-callout

Last synced: 3 days ago
JSON representation

Lightweight and stateless callout component for React.js

• Host: GitHub
• URL: https://github.com/axyz/react-callout
• Owner: axyz
• License: mit
• Created: 2016-03-10T11:35:42.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2016-04-22T13:56:19.000Z (over 8 years ago)
• Last Synced: 2024-10-30T07:22:11.873Z (20 days ago)
• Language: JavaScript
• Size: 12.7 KB
• Stars: 2
• Watchers: 7
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
react-callout

===========

Lightweight and stateless callout component for React.js

It uses only css for positioning.

Usage

-----

Add `react-callout` as a dependency

`$ npm install --save react-callout`

then simply use the provided component

Note that the component is stateless, so updating the `isVisible` property should

be handled in the model of your app (e.g. using redux or similar flux

implementations)

The component is also unstyled (except for the layout).

```javascript

import React from 'react';

import ReactDOM from 'react-dom';

import Callout from 'react-callout';

const content = (

    


        CALLOUT CONTENT

    

);


ReactDOM.render(

    


        


            ... // element owning the callout

        

    
,

    document.getElementById('callout-example')

);


```

Development

-----------

Clone the repository then

`$ npm install`

use

`$ make dist`

to build

and

`make dev`

to start a dev server on `localhost:8080`

to run tests just use

`$ npm test`

Warnings

--------

This component should not not be considered ready for production (until it will reach 1.0.0),

however testing and contributions are really welcome.