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

spawn-a-neko

v1.1.0

Published

Embed a popup menu for users to spawn oneko-like nekos on your website

Downloads

3

Readme

Spawn a Neko!

This is a silly little JavaScript package to easily embed a widget on your website that lets users spawn oneko-like nekos the follow the pointer!

For an example of a site that includes the widget, see my blog.

Usage

Include the CSS in HTML

You'll need to include the CSS in your page for this to work. Add this somewhere in your HTML <head>:

<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/SCP-iota/spawn-a-neko@master/style.css" />

Or Include it With a Bundler

If you're using a JavaScript bundler like Webpack and already using a plugin to bundle CSS, you can import the CSS directly:

import 'spawn-a-neko/style.css'

Include the Script in HTML

Include this towards the end of your HTML's <body> element:

<script src="https://cdn.jsdelivr.net/gh/SCP-iota/spawn-a-neko@master/spawn-a-neko.js"></script>
<script>
    SpawnANeko.start()
</script>

Or Use ESM...

<script type="module">
    import { start } from "https://cdn.skypack.dev/spawn-a-neko"

    start()
</script>

Or Use With a JavaScript Bundler...

If you're using a JavaScript bundler like Webpack, you can get the spawn-a-neko package from NPM and include it in your site's code.

npm install spawn-a-neko

...as an ES Module

import { start } from "spawn-a-neko";

window.addEventListener('load', start);

...or as a CommonJS Module

require("spawn-a-neko").start();

Customizing Colors

You can customize the colors using custom CSS properties in your own stylesheet. (The values shown here are the defaults.):

<style>
    .spawn-a-neko-button, .spawn-a-neko-panel {
        /* Primary background color for the button and panel */
        --spawn-a-neko-primary-color: #cc0099;

        /* Border color of the panel */
        --spawn-a-neko-border-color: #660066;
    }

    .spawn-a-neko-button {
        /* Shown on the main button when hovered with the mouse pointer */
        --spawn-a-neko-button-hover-color: #990099;

        /* Shown on the main button when being pressed */
        --spawn-a-neko-button-active-color: #ff00ff;
    }

    .spawn-a-neko-spawn-button {
        /* Background color of the spawn button */
        --spawn-a-neko-spawn-button-color: #9900ff;
    }
</style>

Advanced Usage

For more control over where the button gets added, you can use the creatButton function and Button class.

With HTML-included Script

const button = SpawnANeko.createButton();
new SpawnANeko.Button(button);
document.body.appendChild(button);

With Bundled ES Module

import { createButton, Button } from "spawn-a-neko";

const button = createButton();
new Button(button);
document.body.appendChild(button);

With Bundled CommonJS Module

const { createButton, Button } = require("spawn-a-neko");

const button = createButton();
new Button(button);
document.body.appendChild(button);