react-polygon

0.2.0 • Public • Published

Standard - JavaScript Style Guide Build Status npm version

react-polygon

A react add-on for drawing polygons for any number of sides, as well as animation

Demo

https://peteroid.github.io/react-polygon/

Usage

npm install react-polygon --save
import Polygon from 'react-polygon'
 
// add this to your components
<Polygon />

Build your own

npm install
npm run webpack

Props

name : propType = defaultValue

Basic

  • n : number = 3
  • size : number = 50
  • fill : string = "#ad893e"
  • ratios : [number] = [1, 1, 1, 1, 1]

Animation

  • isAnimating : bool = true
  • duration : number = 1000

renderPoint

You can render extra elements on each point by passing a function to the props renderPoint. Here is an example for rendering a point on each vertice:

import React, { Component } from 'react'
import Polygon from 'react-polygon'
 
class MyPolygon extends Component {
  myRenderPoint (point) {
    return (
      <circle cx={point[0]} cy={point[1]} r={5} />
    )
  }
  
  render () {
    return (
      <Polygon renderPoint={this.myRenderPoint} />
    )
  }
}

Package Sidebar

Install

npm i react-polygon

Weekly Downloads

31

Version

0.2.0

License

MIT

Unpacked Size

949 kB

Total Files

11

Last publish

Collaborators

  • peteroid