dash-banner
v0.2.2
Published
[![Build Status](https://travis-ci.org/samaritanministries/dash-banner.js.svg?branch=master)](https://travis-ci.org/samaritanministries/dash-banner.js) [![Dash-Banner Version](https://img.shields.io/badge/Version-2.1.0-green.svg)]()
Downloads
4
Readme
Dash Banner
Dash Banner has been converted to use ES6 and Webpack, however it is still being shipped with a bundled Javascript file for use with pre-ES6 applications. Instructions for both are included.
Installation
Dash-Banner.js is delivered as a bower component.
- Install bower
npm install -g bower
Note: Bower requires node, npm and git.
- Create a
bower.json
file
bower init
- Install the dash-banner.js bower component and save it to your
bower.json
file
bower install dash-banner.js --save
Usage
- Dashing Framework
- Add an element with
data-id=dash-banner-container
to your page. - Additional examples
Including SASS in your project
Include component styles in your main application SASS file.
@import "path/to/dash_banner/dist/dash-banner"
ES5
- Add
<script src="path/to/dash_banner/dist/dash-banner.js"></script>
to your index. DashBanner.View.flashSuccess("Great Success!");
ES6
import DashBannerView from "path/to/dash_banner/scripts/dash_banner/view.js"
DashBannerView.flashSuccess("Great Success!");
Project Setup
Dependencies
- install node/npm
npm run setup
Running the Tests
For a single run of the tests:
npm test
To run the tests with a watcher:
npm run karma
Running the Demo App
npm start
- Open
http://localhost:8080/webpack-dev-server
Releasing a New Version
- Update the changelog
- Commit your changes
- Run
./bower_deploy.sh
Note: With the addition of the font icons, the icons will not display unless the page is loaded into a web server. grunt uxServer is not available to be ran in this component as of now, however apache or stack can be used to run it properly (LAMP/WAMP/MAMP).