readme.md

Claps button web component

See the Pen claps-button web component by Arvin (@arvin0731) on CodePen.

Develop

npm install
npm start

To build the component for production, run:

npm run build

To run the unit tests for the components, run:

npm test

Using this component

Script tag

• Put a script tag similar to this <script src='https://unpkg.com/[email protected]/dist/mycomponent.js'></script> in the head of your index.html
• Then you can use the element anywhere in your template, JSX, html etc

<!--in your index.html-->
<script src='https://unpkg.com/[email protected]/dist/claps-button.js'></script>
<!-- // other code -->

You can change size and color by passing them as props

<claps-button size="5rem" color="#ffe000"></claps-button>

If you want to perserve the claps number, you can pass preserve as props, it'll save to localstorage with claps-wc-${location.pathname} as key.

<claps-button size="3rem" preserve ></claps-button>

claps-button emit an custom event called clapDone when you click it, you can listen to that event to get the current count

export default function App() {
  document.addEventListener("clapDone", e => {
    console.log(e.detail.count);
  });
  return (
    <div className="App">
      <div className="container">
        <claps-button size="4rem" color="#ffe000" preserve />
      </div>
    </div>
  );
}

Set the eventlimit to control how many claps and custom event you want to trigger

<claps-button size="3rem" eventlimit="10"></claps-button>

This will only trigger clapDone when counter is between 0 to 9.

You can use it with innercount. innercount control how many claps you've already clap. However, innercount won't work on initial load, you have to dynamic set the value.

Set the counter number by pass defaultcount attribute

<claps-button size="3rem" defaultcount="5"></claps-button>

Change emoji is also possible

<claps-button size="3rem" preserve emoji="🔥"></claps-button>

Node Modules

• Run npm install claps-button --save
• Put a script tag similar to this <script src='node_modules/claps-button/dist/mycomponent.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 claps-button --save
• Add an import to the npm packages import claps-button;
• Then you can use the element anywhere in your template, JSX, html etc

Built by Stencil

Stencil is a compiler for building fast web apps using Web Components.

Stencil combines the best concepts of the most popular frontend frameworks into a compile-time rather than run-time tool. Stencil takes TypeScript, JSX, a tiny virtual DOM layer, efficient one-way data binding, an asynchronous rendering pipeline (similar to React Fiber), and lazy-loading out of the box, and generates 100% standards-based Web Components that run in any browser supporting the Custom Elements v1 spec.

Stencil components are just Web Components, so they work in any major framework or with no framework at all.