@paraboly/pwc-state-view
TypeScript icon, indicating that this package has built-in type declarations

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 README Boilerplate

Live Codepen Example

Installation

Script tag

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

Node Modules

  • Run npm install @paraboly/project-name --save
  • Put a script tag similar to this <script src='node_modules/@paraboly/project-name/dist/project-name.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/project-name --save
  • Add an import to the npm packages import @paraboly/project-name;
  • 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
  • [x] LICENSE
  • [ ] Color Customization
  • [ ] Animation Bug Fix

Authors

Author, author@work_email.com | author@personal_email.com

License

WebComponent PWC README Boilerplate is available under the MIT license.

See the LICENSE file for more info.

Package Sidebar

Install

npm i @paraboly/pwc-state-view

Weekly Downloads

53

Version

0.0.1

License

MIT

Unpacked Size

1.31 MB

Total Files

75

Last publish

Collaborators

  • parabolynpm