The Wayback Machine - https://web.archive.org/web/20190315055542/https://github.com/hustcc/canvas-nest.js
Skip to content
Please note that GitHub no longer supports your web browser.

We recommend upgrading to the latest Google Chrome or Firefox.

♋️ Interactive Particle / Nest System With JavaScript and Canvas, no jQuery.
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
dist build Dec 6, 2018
lib build Dec 6, 2018
src add pointColor option Dec 1, 2018
.babelrc add babel-plugin-version Nov 17, 2018
.gitignore ignore log files Dec 2, 2018
LICENSE Initial commit Dec 7, 2015
README-zh.md add pointColor option Dec 1, 2018
README.md v2.0.4 Dec 6, 2018
index.d.ts 添加d.ts 声明 Dec 17, 2018
index.html
package.json v2.0.4 Dec 6, 2018
rollup.config.iife.js module & area render Jun 23, 2018
rollup.config.umd.js module & area render Jun 23, 2018
screenshot.png chore: tweak docs (#44) Aug 27, 2018

README.md

canvas-nest.js

A nest background of website draw on canvas. 中文 Readme 帮助文档.

npm npm npm gzip

screenshot

Feature

  • It does not depend on jQuery and original javascrpit is used.
  • Small size, only 2 Kb.
  • Easy to implement, simple configuration.
  • You do not have to be a web developer to use it.
  • Modularized with area rendering.

Install

# use npm
npm install --save canvas-nest.js

# or use yarn
yarn add canvas-nest.js

Usage

  • Script tag

Insert the code below between <body> and </body>.

<script src="dist/canvas-nest.js"></script>

Strongly suggest to insert before the tag </body>, as the following:

<html>
<head>
	...
</head>
<body>
	...
	...
	<script src="dist/canvas-nest.js"></script>
</body>
</html>

Then ok! Please do not add the code in the <head> </head>.

  • Modular usage (Area render)

After installation, you can import this as module.

There is only one API, use it as below:

import CanvasNest from 'canvas-nest.js';

const config = {
  color: '255,0,0',
  count: 88,
};

// Using config rendering effect at 'element'.
const cn = new CanvasNest(element, config);

// destroy
cn.destroy();

Configuration

  • color: color of lines, default: '0,0,0'; RGB values: (R,G,B).(note: use ',' to separate.)
  • pointColor: color of points, default: '0,0,0'; RGB values: (R,G,B).(note: use ',' to separate.)
  • opacity: the opacity of line (0~1), default: 0.5.
  • count: the number of lines, default: 99.
  • zIndex: z-index property of the background, default: -1.

Example:

  • Script tag
<script type="text/javascript" color="0,0,255" opacity='0.7' zIndex="-2" count="99" src="dist/canvas-nest.js"></script>
  • Modular usage (Area render)
{
  color: '0,0,255',
  opacity: 0.7,
  zIndex: -2,
  count: 99,
};

Note: If the Configuration isn't customized, default values are available as well.

Related projects

Used by

  • A Tool: a convenient tool box.

License

MIT@hustcc.

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.