1.2.0 • Published 2 years ago

canvas-sdk v1.2.0

Weekly downloads
-
License
ISC
Repository
-
Last release
2 years ago

Canvas_Sdk文档

介绍

-用途: 利用canvas绘制渐变性圆环、渐变性半圆环、拓展图标、疑问图标等内容。

安装

使用包管理器

npm i canvas-sdk

import DrawCanvas from 'canvas-sdk'

浏览器直接引入

通过npm run build打包之后,在dist目录下会生成canvas-sdk.min.js文件,可以通过script自行引入

基本使用

<!DOCTYPE html>
<html lang="">
  <head>
    <meta charset="utf-8">
    <style>
      body {
          margin: 0;
          padding: 0;
          height: 100vh;
      }
      #app {
        height: 100%;
        display: flex;
        justify-content: space-around;
        align-items: center;
      }
      canvas {
          width: 100px;
          height: 100px;
          border-radius: 50%;
          cursor: pointer
      }
  </style>
  </head>
  <body>
    <div id="app"></div>
    <script src="./canvas-webpack-test.js"></script>
    <script>
        const ring = new DrawCanvas({
          type: 'ring', 
          container: document.getElementById('app'),
          id: 'ring',
          width: 200,
          height: 200,
          insertBefore: true,
        })
        ring.onClick(() => {
            ring.update({
                percent: 40
            })
        })
        ring.onHover(() => {
            console.log('mouseenter')
        },() => {
            console.log('mouseleave')
        })
    </script>
  </body>
</html>
公共属性说明类型可选值默认值是否必传
type要绘制的图形的名称string'dot','rightArrow','tipQuery','ring','semicircle','expandIcon'-
container放置图形的父元素object-document.querySelector('body')
idcanvas idstring-'canvas'
widthcanvas Width,建议2倍值number-CSS宽的2倍,若无,则300*2
heightcanvas Height,建议2倍值number-CSS高的2倍,若无,则150*2
insertBefore是否将元素添加到容器的第一位booleantrue/falsefalse
方法说明传参类型
onClick点击图形function
onHover鼠标滑过图形function, function
update图形更新object

type的具体使用及示例

1.type === 'dot'

属性说明类型可选值默认值是否必传
isGradient背景色是否渐变Booleantrue/falsefalse
bgColor图像的背景色。渐变色传数组string/Array-'black'

2.type === 'rightArrow'

3.type === 'tipQuery'

4.type === 'ring'

5.type === 'semicircle'

6.type === 'expandIcon'