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

Package detail

react-canvas-nest

flyerH512MIT1.1.1

React component for a nest backgroud

canvas, nest, canvas-nest, react-nest

readme

React-Canvas-Nest

NPM version GitHub license npm bundle size (minified + gzip)

English | 简体中文

React component for a nest backgroud.

Creativity is inspired by canvas-nest.js

screenshot

Install

# use yarn
yarn add react-canvas-nest

# or use npm
npm install react-canvas-nest

Usage

Note:

  • You can refer to this example.
  • Component size depends on parent node size.

Import Component

import ReactCanvasNest from 'react-canvas-nest';

Use Component

  • Default
    <ReactCanvasNest />
  • Custom
    <ReactCanvasNest className = 'canvasNest' config = {{ pointColor: ' 255, 255, 255 ' }} style = {{ zIndex: 99 }} />

API

className

Support className attribute

config

Property Description Default
count count of points 88
pointR radius of the point 1
pointColor | 114, 114, 114
pointOpacity transparency of points 1
dist maximum distance between two point 6000
lineColor | 0, 0, 0
lineWidth multiple of line width 1
follow mouse follow true
mouseDist distance between point and mouse 20000

style

Support style attribute, default style as follows:
Property Default
zIndex -1
opacity 1
display block
position absolute

License

React-Canvas-Nest is MIT licensed.