Skip to content

dotch/brick-sync

Repository files navigation

brick-sync

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:

    <brick-sync></brick-sync>

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.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published