@paraboly/pwc-readme-boilerplate

0.0.1 • Public • Published

Built With Stencil

WebComponent PWC README Boilerplate

Fully customizable readme boilerplate for web component with StencilJS via Paraboly

npm version npm Platform - Platform Free Web License: MIT

WebComponent PWC Animated Checkbox

Live Codepen Example

Installation

Script tag

  • Put a script tag similar to this <script type="module" src="https://unpkg.com/@paraboly/pwc-readme-boilerplate@latest/dist/pwc-readme-boilerplate/pwc-readme-boilerplate.esm.js"></script> in the head of your index.html
  • Then you can use the element anywhere in your template, JSX, html etc

Node Modules

  • Run npm install @paraboly/pwc-readme-boilerplate --save
  • Put a script tag similar to this <script src='node_modules/@paraboly/pwc-readme-boilerplate/dist/pwc-readme-boilerplate.js'></script> in the head of your index.html
  • Then you can use the element anywhere in your template, JSX, html etc

In a stencil-starter app

  • Run npm install @paraboly/pwc-readme-boilerplate --save
  • Add an import to the npm packages import @paraboly/pwc-readme-boilerplate;
  • Then you can use the element anywhere in your template, JSX, html etc

Usage

Basic Usage

This is just an example from pwc-animated-checkbox, you need to change it !

<pwc-animated-checkbox></pwc-animated-checkbox>

Checkbox onCheckChange Listener Usage

JS Way

This is just an example from pwc-animated-checkbox, you need to change it !

// Multiple Checkboxes
const pwcCheckboxes = document.querySelectorAll("pwc-animated-checkbox");
pwcCheckboxes.forEach(element => {
  element.addEventListener("checkedEvent", event => {
    console.log("Event: ", event.detail);
  });
})  
// Selects the first checkbox
const pwcCheckbox = document.querySelector("pwc-animated-checkbox");
pwcCheckbox.addEventListener("checkedEvent", event => {
console.log("First Element Event: ", event.detail);

Future Plans

  • [x] Documentation
  • [ ] Color Customization
  • [ ] Animation Bug Fix

Authors

FreakyCoder, kuray.ogun@paraboly.com | kurayogun@gmail.com

License

WebComponent PWC README Boilerplate is available under the MIT license. See the LICENSE file for more info.

Dependents (0)

Package Sidebar

Install

npm i @paraboly/pwc-readme-boilerplate

Weekly Downloads

0

Version

0.0.1

License

MIT

Unpacked Size

33.4 kB

Total Files

4

Last publish

Collaborators

  • parabolynpm