Skip to content
This repository has been archived by the owner on Sep 25, 2022. It is now read-only.

Fork this repo if you want to start your own Web Component using VanillaJS

Notifications You must be signed in to change notification settings

webcomponents/element-boilerplate

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

49 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

<my-repo>

A bare minimum custom element starter-kit using VanillaJS.

Like Yeoman? Use the generator-element instead.

Looking for a working example? Check hello-world-element.

Demo

Check it live!

Install

Install the component using Bower:

$ bower install my-repo --save

Or download as ZIP.

Usage

  1. Import polyfill:

    <script src="bower_components/webcomponentsjs/webcomponents.min.js"></script>
  2. Import custom element:

    <link rel="import" href="bower_components/my-repo/my-element.html">
  3. Start using it!

    <my-element></my-element>

Options

Attribute Options Default Description
foo string bar Lorem ipsum dolor.

Methods

Method Parameters Returns Description
unicorn() None. Nothing. Magic stuff appears.

Events

Event Description
onsomething Triggers when something happens.

Development

In order to run it locally you'll need to fetch some dependencies and a basic server setup.

  1. Install bower & polyserve:

    $ npm install -g bower polyserve
  2. Install local dependencies:

    $ bower install
  3. Start development server and open http://localhost:8080/components/my-repo/.

    $ polyserve

History

For detailed changelog, check Releases.

License

MIT License

About

Fork this repo if you want to start your own Web Component using VanillaJS

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages