npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

wc-scratch

v0.6.0

Published

A fun scratch card native web component without any dependencies.

Downloads

422

Readme

wc-scratch 🧽

A fun scratch card native web component without any dependencies.

🎉 Installation

Install it ith npm:

npm i wc-scratch

Or link it using a script tag:

<script type="module" src="https://unpkg.com/wc-scratch@latest/dist/wc-scratch.js"></script>

✨ Usage

Import the component - this will also register it as a custom element with the tag name <wc-scratch>:

import 'wc-scratch'

Now you can use the component in your markup:

<wc-scratch>
  <h1 style="margin: 0">Scratch me free!</h1>
</wc-scratch>

⚙️ Configuration

🎰 Slot

| Slot name | Description | |-----------|-------------| | default | The content to be scratched free. | | scratch-source | Used to pass an image that acts as a scratch-color replacement. |

Example on how to use the scratch-source slot:

<wc-scratch>
  <h1>Scratch me!</h1>
  <img slot="scratch-source" crossorigin style="display: none;" src="https://example.com/example.jpeg" alt="image" />
</wc-scratch>
  • To get the best experience make sure that your content is the same size as the image used to hide it.
  • You need to set display: none on this image so the original is getting hidden. We only read its image data and paint it on the canvas.
  • For images fetched over the internet you also need to set crossorigin if you want to use the percentage-update feature or else the CanvasRenderingContext2D: getImageData() will throw an error.

💡 Props

| Property | Type | Default | Description | |----------|------|---------|-------------| | brush-size | number | 10 | Defines the lineWidth attribute. | | brush-shape | string | 'round' | Defines the lineJoin attribute. | | scratch-color | string | '#000000' | The color you want to scratch away with your scratch card. Can be any valid CSS color. | percentage-update | boolean | false | Flag to toggle the percentage-update event emitter on or off. |

🎈 Events

| Name | Type | Description | |------|------|-------------| | percentage-update | { detail: number } | Emits a custom event with the cleared amount as a percentage. |

Example:

<script>
  const scratch = document.querySelector('wc-scratch[percentage-update]')
  scratch.addEventListener('percentage-update', ({ detail }) => console.log(detail))
</script>

✔️ Caveats

  1. Please avoid using margin on a content element since it can lead to improper sizing of the canvas element and therefore the content might be visible.

  2. Calculation of the cleared area is rounded with a 150 pixel error margin.