README

nozaki

nozaki cli for creating boilerplate web components.

Install

npm i -g nozaki will give windows|mac|windows users access to the nozaki cli

Use


#create a new component called custom-element and store it in the 
# default "./components" dir
$nozaki new custom-element 

#create a new component called custom-element and store it in the 
# "./wherever" dir
$nozaki new custom-element -dir ./wherever

#create a new example file for the custom-element component 
# and store it in the default "./example" dir
$nozaki example custom-element 

#create a new example file for the custom-element component 
# and store it in the "./whatever" dir
$nozaki example custom-element -exdir ./whatever





#create a new component and example for a component called 
# custom-element and store use the default dirs
$nozaki new custom-element example custom-element

#create a new component and example for a component called 
# custom-element and store use user defined dirs
$nozaki new custom-element -dir ./wherever example custom-element -exdir ./whatever

Boilerplate Example


#to create if needed and store the component in the ./components dir
$nozaki new custom-element

creates


const style=`
    <style>
        
    </style>
`;

function getTemplate(self){
    return `
        ${style}
        
        <div class="${self.dataset.class||''}"
            style="${self.dataset.style||''}"
        >

        </div>
        
    `;
}

class CustomElement extends HTMLElement {
    constructor() {
        super();
        
        //this.shadowRoot
        this.attachShadow({mode: 'open'});
        
        this.shadowRoot.innerHTML=getTemplate(this);

        return this;
    }

    // learn more about webcomponent lifecycle on MDN
    // https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_custom_elements#using_the_lifecycle_callbacks

    static get observedAttributes() {
        return [
            
        ];
    }

    async connectedCallback(){
        
        return this;
    }

    async disconnectedCallback(){

        return this;
    }

    static get observedAttributes() { 
        return []; 
    }

    async attributeChangedCallback(name, oldVal, newVal){

        return this;
    }

}

customElements.define('custom-element', CustomElement);

export {
    CustomElement as default,
    CustomElement
}

Refrences

MDN Using Web Component Lifecycle Callbacks

Checkout the nozaki-components lib/framework

nozaki-components, modern vanilla components designed with ES6+ ESM first works in all modern browsers without transpiling.

Checkout the nozaki-colors module

nozaki-colors An extremely lightweight color and styling module for the console/terminal/commandline.

Usage no npm install needed!