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

shadow-component

v0.2.6

Published

This is a test implementation of components with shadow dom and full template rendering of changes of state

Downloads

65

Readme

This is Shaco

Shaco is a simple experiment with Shadow DOM and "component", Shaco permit you create Components that use Shado DOM templates.

This will create a new custom HTML element and inside will put you Shadow DOW template. Shaco use Incremental DOM from Google in order to render components

A Shaco Component is created in this way:

Shaco.ComponentFactory({
	elementName: string // The name of the new custom html tag
	state(), // default state
	onMount(), // This is a callback attached to the native callback 'attachedCallback' for the custom element
	onUnMount(), // This is a callback attachedt to the native calbback 'detachedCallback' for the custom element
	template: string, // Define the Shadow DOM template
	view: string | function, // This define how you custom element will render when state chage. The function must use Shaco.createElement sintax
	// Events will be decrated
	events: Array // This is an array on Event (A Object that need Shaco to delagate listeners), the espeficication is below
})

The other 2 important concepts are:

  • The Shaco.createElement
  • Event Object

The Shaco.createElement

This is a function that create a new HTML element, this element could be assigned to your custom element innerHTML

Shaco.createElement(TagName, key, state, DOMElementAttributesObj, Child)
  • TagName: This is the name of the element to create, could be a estandar HTML tag or a custom Tag (like one component created with shaco)
  • key: in order to indentify array of elements, use it when you map over and array of objects
  • state: If the tag is a Shaco Component, this will be the initial state of the component
  • DOMElementAttributesObj: Whatever DOM element attibute that is right now supported, like style or class, etc.
  • Child: Another Shaco.createElement or a string that will be inside the element created

Event Object

IMPORTANT: This is no longer required. Now you use normal events on Shaco.createElement

The event object will be used to delegate listeners on the Component. This is the structure of the Event Objet:

{
	selector: string, // this is the Child selector for the delagation
	type:  string, // the normal set of events for the function addEventListeners
	calback: function // the function that will be excuted when the event is fire
}

Example

This is an example of how to use Shaco, see the example folder or the TODO example in this Repository