Socket
Socket
Sign inDemoInstall

@stormid/boilerplate

Package Overview
Dependencies
0
Maintainers
5
Versions
4
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @stormid/boilerplate

Boilerplate for developing UI components


Version published
Weekly downloads
0
decreased by-100%
Maintainers
5
Created
Weekly downloads
 

Readme

Source

Component Name

This is a boilerplate for developing UI components by Storm Id.


Usage

Create a container element in HTML

<div class="js-boilerplate"></div>

Install the package

npm i -S @stormid/boilerplate

Import the module

import boilerplate from '@stormid/boilerplate';

Initialise the module via selector string

const [ instance ] = boilerplate('.js-boilerplate');


Initialise with a DOM element

const element = document.querySelector('.js-boilerplate'); const [ instance ] = boilerplate(element);


Initialise with a Node list

const elements = document.querySelectorAll('.js-boilerplate'); const [ instance ] = boilerplate(elements);


Initialise with an Array of elements

const elements = [].slice.call(document.querySelectorAll('.js-boilerplate')); const [ instance ] = boilerplate(elements);


## Options

{ callback: null }


For example

boilerplate('.js-selector', { callback(){ console.log(this); } });


## API
boilerplate() returns an array of instances. Each instance exposes the interface

{ node, DOMNode augmented by initialisation click, trigger the handleClick method }


## Tests

npm t


## Browser support

## Dependencies

## License
MIT

Keywords

FAQs

Last updated on 15 Feb 2022

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc