@manufosela/canvas-polygon
v1.0.0
Published
Webcomponent canvas-polygon following open-wc recommendations to draw polygons on a canvas
Downloads
1
Readme
<canvas-polygon>
This webcomponent draw polygons on a canvas. This webcomponent follows the open-wc recommendation
Installation
npm i canvas-polygon
Usage
<script type="module">
import 'canvas-polygon/canvas-polygon.js';
</script>
<canvas-polygon></canvas-polygon>
<canvas-polygon size="100" sides="3" line-width="4" bg-color="cyan"></canvas-polygon>
Attributtes
- size - The size of the canvas element in pixels.
- sides - The number of sides of the polygon to render.
- line-width - The width of the polygon's stroke in pixels.
- bg-color - The background color of the canvas element.
- offset-rotation - The rotation offset of the polygon in radians.
Linting and formatting
To scan the project for linting and formatting errors, run
npm run lint
To automatically fix linting and formatting errors, run
npm run format
Testing with Web Test Runner
To execute a single test run:
npm run test
To run the tests in interactive watch mode run:
npm run test:watch
Demoing with Storybook
To run a local instance of Storybook for your component, run
npm run storybook
To build a production version of Storybook, run
npm run storybook:build
Tooling configs
For most of the tools, the configuration is in the package.json
to minimize the amount of files in your project.
If you customize the configuration a lot, you can consider moving them to individual files.
Local Demo with web-dev-server
npm start
To run a local development server that serves the basic demo located in demo/index.html