brick-boilerplate

Empty Brick Web Component Boilerplate

Usage no npm install needed!

<script type="module">
  import brickBoilerplate from 'https://cdn.skypack.dev/brick-boilerplate';
</script>

README

Brick-Boilerplate

A Brick custom element starter-kit.

Demo

Check it live!

Usage

  1. Import Web Components polyfill:

    <script src="bower_components/platform/platform.js"></script>
    
  2. Import Custom Element:

    <link rel="import" href="src/element.html">
    
  3. Start using it:

    <custom-element></custom-element>
    

Options

Attribute Options Default Description
foo string bar An Attribute.

Methods

Method Parameters Returns Description
method() None. Nothing. A method.

Events

Event Description
onsomething Triggers when something happens.

Development

Brick components use Stylus to generate their CSS.

This repository comes outfitted with a set of tools to ease the development process.

To get started:

  • Install Bower & Gulp:

    $ npm install -g bower gulp
    
  • Install local dependencies:

    $ npm install && bower install
    

While developing your component, there is a development server that will watch your files for changes and automatically re-build your styles and re-lint your code.

To run the development server:

  • Run gulp server
  • Navigate to http:localhost:3001

To simply build and lint your code, run gulp build.

You can also push your code to GitHub Pages by running gulp deploy.

License

MIT License