Skip to content

Commit

Permalink
added readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ekhmoi committed Oct 1, 2016
1 parent 691b9e9 commit f209edb
Showing 1 changed file with 55 additions and 0 deletions.
55 changes: 55 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@


Version 0.0.1


# ekhmoi-fab-toolbar
A Material Design Fab Toolbar is Ionic v2 component which uses Ionic's fab buttons, buttons.

The floating action button can transform into a toolbar upon press or from a toolbar upon scroll. The toolbar can contain related actions, text and search fields, or any other items that would be useful at hand.

## Usage
```
<ekhmoi-fab-toolbar [options]="options"></ekhmoi-fab-toolbar>
```

```
import { EkhmoiFabToolbar } from '../fab-toolbar/fab-toolbar';
options = {
color: "danger",
icon: 'car',
enableBackdropDismiss: true,
buttons: [
{icon: 'mail', handler: ()=> {console.log('close me')}},
{icon: 'alarm', handler: ()=> {console.log('close me')}},
{icon: 'laptop', handler: ()=> {console.log('dont close me'); return false}}
]
}
```

## Install
Get files inside dist folder and copy to your project

* starting from Ionic 2 RC0.0 (AoT) you should provide all components inside app.module.ts

```
import { EkhmoiFabToolbar } from '../pages/fab-toolbar/fab-toolbar';
@NgModule({
declarations: [
EkhmoiFabToolbar
],
imports: [
IonicModule.forRoot(MyApp)
],
bootstrap: [IonicApp],
entryComponents: [
EkhmoiFabToolbar
]
})
```
##Demo


![alt tag](https://github.com/ekhmoi/Ionic-Component-fab-toolbar/blob/master/demo/Fab%20Toolbar.gif)

0 comments on commit f209edb

Please sign in to comment.