0.0.0 • Published 11 years ago
brick-boilerplate v0.0.0
Brick-Boilerplate
A Brick custom element starter-kit.
Demo
Usage
Import Web Components polyfill:
<script src="bower_components/platform/platform.js"></script>Import Custom Element:
<link rel="import" href="src/element.html">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:
$ npm install -g bower gulpInstall 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
0.0.0
11 years ago