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

@parcility/kennel

v2.0.5

Published

A comprehensive, easy-to-use native depiction renderer.

Downloads

6

Readme

Kennel

A complete implementation of Sileo's native depictions in TypeScript.


Get Started

$ npm i @parcility/kennel

API

Kennel was written to be as easy to interact with as possible.

render(depiction: any, options?: Parital<RenderOptions>): Promise<HTMLElement | string>

Render a depiction to either a HTMLElement or a string.

depiction: An object that stores the native depiction's contents.

options: The settings used for rendering. options.ssr: Output a string instead of a DOM element. options.defaultTintColor: The css color used for the tint.

hydrate(target?: ParentNode): void

Runs the hydrate function on views that need to be hydrate. Can only be ran on the client side. target: The root element for hydration. Defaults to document.body.

Example

// Import Kennel
import { render, hydrate } from "@parcility/kennel";

// Assumes the `depiction` variables exists elsewhere. The second argument (options) can be omitted.
let output = await render(depiction, { ssr: true });

// sometime on the client.
hydrate();

A full demo is available by running yarn dev.


Development

Testing

Run the test page, which loads depictions from the test/ directory.

yarn dev

Building

This is not required if you installed Kennel through NPM.

1: Install dependencies

yarn install

2: Build module

yarn build