Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

custom image in button #76

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

custom image in button #76

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
112e5ac
support custum image in button
Jun 20, 2016
bb7dd42
fix read me
Jun 20, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,10 @@ This element represents the child button(s) of the menu and can only "live" insi
```html
<mfb-button></mfb-button>
```

...if you want show custom image in button use `image` attribute:
```html
<button mfb-button image="../example.jpg"></button>
```
**NOTE**: If you are adding more than the default number of buttons supported by the provided CSS (currently 4) you will need to compile your own CSS beforehand to support your requirements. It's easy, here's an [example](https://github.com/nobitagit/ng-material-floating-button/issues/28#issuecomment-96980288).

##### TemplateUrl
Expand Down
291 changes: 291 additions & 0 deletions README.md~
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,291 @@
ng-material-floating-button
========================

Material design floating action button implemented as an Angularjs directive.
~~Shamelessly~~ inspired by action buttons from Google Inbox, Evernote and Path.

Made to be fast and easy to customise. It works out of the box with no other dependency apart from Angular, but plays nicely with the [Angular Material](https://material.angularjs.org) bundle, for which it has dedicated templates.

## Demo
Head over to the project [homepage](http://nobitagit.github.io/ng-material-floating-button/) to see it in action as a standalone component, check the [Angular Material integration](http://nobitagit.github.io/ng-material-floating-button/angular-material.html) or just take a look at this awesome gif:

<img src="http://zippy.gfycat.com/LimitedTatteredFieldmouse.gif">

**Other versions**
- [Vanilla html](https://github.com/nobitagit/material-floating-button) (original, upstream version of the component)
- [React component](https://github.com/nobitagit/react-material-floating-button)

## How to use

Download/clone the repo or use your favorite package manager:
```
npm i ng-material-floating-button --save
```
or:

```
bower install ng-mfb --save
```

Then (optionally) run `npm install` to have access to the configured Grunt tasks.

Look in the `demo` folder for usage examples and head to the original component [docs](https://github.com/nobitagit/material-floating-button#how-to-use) to see how to customise the styles of the menu.

If you are **upgrading** check the changelog before doing so in order to prevent breaking changes to bite you.

### Basic setup
Download the whole repo or clone it, then reference the directive css file (here is `mfb/src/mfb.css`)in your `<head>`:

```html
<link href="../path/to/css/mfb.css" rel="stylesheet"/>
```
Place a reference to the directive before the closing `<body>` tag or anywhere after your angular script tag.

```html
<script src="../mfb/src/mfb-directive.js"></script>
```
Make sure you reference the Mfb module as a dependecy to your app or module like so:
```js
var app = angular.module('your-app', ['ng-mfb']);
```
Finally, place the correct html structure in your template. As a first example, assuming your example is using [Ionicons](http://ionicons.com/) as icon font:

```html
<nav mfb-menu position="br" effect="zoomin" label="hover here"
active-icon="ion-edit" resting-icon="ion-plus-round"
toggling-method="click">
<button mfb-button icon="paper-airplane" label="menu item"></button>
</nav>
```
This example shows the two basic components of the directive, a unique `mfb-menu` element which serves as a wrapper to a variable number of child buttons, defined by the `mfb-button` attribute.
This above code will output a basic button menu on the bottom right corner of the screen with a single menu item. Hardly amazing, so let's see how to customise it.

**NOTE**: if you want to change the CSS make you sure you understand how it's supposed to be done. Please read [here](#custom-css) and [here](https://github.com/nobitagit/ng-material-floating-button/tree/master/mfb).

### Element attributes
A number of attributes can be passed to the elements from the template in order to customise both behavior and appearance.

####`<mfb-menu>` element
This can be defined as an attribute or an element. So this is valid:
```html
<ul mfb-menu></ul>
```
...and this is valid too:
```html
<mfb-menu></mfb-menu>
```
##### TemplateUrl
Optional attribute definining the template for the main button. If no template is specified it will fallback to the default `ng-mfb-menu-default.tpl.html`. If you are using [Angular Material](https://material.angularjs.org) in your app you can pass the predefined template for the Angular Material bundle which is `ng-mfb-menu-md.tpl.html`.

Example:
```html
<ul mfb-menu template-url="ng-mfb-menu-md.tpl.html">
<!-- this will display the Angular Material optimised template -->
</ul>
```

By no means you are tied to the default templates, though. See [customising templates](#custom-tpls).

##### Main Action
Defines a main action that will get fired when the main button is clicked. Works best with `toggling-method=hover` to put a main action on the base button.

Example:
```html
<ul mfb-menu main-action="fireMainAction()"></ul>
```

##### Position
Defines in which corner of the screen the component should be displayed.

value | explanation
--- | ---
`tl` | top-left corner
`tr` | top-right corner
`br` | bottom-right corner
`bl` | bottom-left corner

Example:
```html
<ul mfb-menu position="br">
<!-- this will be displayed on the bottom-right corner of the screen -->
</ul>
```
##### Toggling method
Defines how the user will open the menu. Two values are possible:

value | explanation
--- | ---
`hover` | hover to open the menu
`click` | click or tap to open the menu

Example:

```html
<ul mfb-menu toggling-method="click">
<!-- click on the button to open the menu -->
</ul>
```

**NOTE**: Using `hover` will prevent user browsing on modbile/touch devices to properly interact with the menu. The directive provides a fallback for this case.

If you want the menu to work on hover but need support for touch devices you first need to include Modernizr to detect touch support. If you are alreay using it in your project just make sure that the touch detection is enabled.

If you're not using Modernizr already, just include the tiny (<3KB) provided `modernizr.touch.js` script (look in the `mfb/src/lib/` folder) in your `<head>` or get the latest version of this very script right from [here](http://modernizr.com/download/#-touch-teststyles-prefixes). Note that this is a custom build and will only detect for touch support, it's not the full library.

##### Menu state
You can programmatically open/close the menu leveraging this attribute at any time after compilation, without any clicking required by the user, or listen to the current state of the menu.

value | explanation
--- | ---
`open` | menu is... open (surprise, surprise)
`closed` | menu is...(hold tight) ... closed

Example:

```html
<ul mfb-menu menu-state="myVar">
</ul>
```
```js
// in your controller
$scope.myVar = 'closed';
```
NB: currently this value is only updated if using `click` toggling.

##### Effect
Defines the effect that is performed when the menu opens up to show its child buttons.

value |
--- |
`zoomin` |
`slidein` |
`slidein-spring` |
`fountain` |

Test them [here](http://nobitagit.github.io/ng-material-floating-button/).

Example:
```html
<ul mfb-menu effect="zoomin">
</ul>
```
##### Label
The text that is displayed when hovering the main button.
Example:
```html
<ul mfb-menu label="your text here">
</ul>
```

##### Active-icon
The icon that will be displayed by default on the main button.
Example:
```html
<ul mfb-menu active-icon="ion-edit">
</ul>
```
##### Resting-icon
The icon that will be displayed on the main button when hovering/interacting with the menu.
Example:
```html
<ul mfb-menu resting-icon="ion-plus-round">
</ul>
```
#### `<mfb-button>` element
This element represents the child button(s) of the menu and can only "live" inside a wrapper `<mfb-menu>` element. Like its parent, it can be defined both as an attribute and as an element. So this is valid:
```html
<a mfb-button></a>
```
...and this is valid too:
```html
<mfb-button></mfb-button>
```

**NOTE**: If you are adding more than the default number of buttons supported by the provided CSS (currently 4) you will need to compile your own CSS beforehand to support your requirements. It's easy, here's an [example](https://github.com/nobitagit/ng-material-floating-button/issues/28#issuecomment-96980288).

##### TemplateUrl
Optional attribute definining the template for the child buttons. If no template is specified it will fallback to the default `ng-mfb-button-default.tpl.html`. If you are using [Angular Material](https://material.angularjs.org) in your app you can pass the predefined template for the Angular Material bundle which is `ng-mfb-button-md.tpl.html`.

Example:
```html
<button mfb-button template-url="ng-mfb-button-md.tpl.html">
<!-- this will display the Angular Material optimised template -->
</button>
```

Here again customising the template is surely possible, see how [here](#custom-tpls).

##### Icon
Pass the class of the icon font character that is associated to the menu item:
Example:
```html
<a mfb-button icon="ion-paperclip"></a>
```
##### Label
The text that is displayed when hovering the button.
Example:
```html
<a mfb-button label="About us"></a>
```

##### Custom attributes
Due to the nature of the component you'll probably want to associate some actions or use other angular directives such as ng-repeat on the buttons. As these attributes will be copied over to the generated html structure you can simply attach them to the `<mfb-element>`. A couple of examples, here using ui-router:
```html
<!-- if using ui-router, associate an on-click event to the anchor-->
<a mfb-button ui-sref="yourState"></a>
```
And here leveraging a basic ng-repeat with buttons defined via js:
```js
// in your controller...
$scope.buttons = [{
label: 'a link text',
icon: 'ion-paper-airplane'
},{
label: 'another link',
icon: 'ion-plus'
},{
label: 'a third link',
icon: 'ion-paperclip'
};
```
```html
<!-- in your template -->
<!-- this will output 3 buttons with different icon, label and so on-->
<a mfb-button label="{{button.label}}" icon="{{button.icon}}" ng-repeat="button in buttons"></a>
```

#### `mfb-button-close` attribute

When using the toggling method click ```<ul mfb-menu toggling-method="click">``` only the main button toggles the menu. If you want your secondary buttons to close the menu as well you can use the ```mfb-button-close``` attribute on your ```mfb-button```.

That way if your ```mfb-button``` opens a modal or something else that loses focus, your menu will close.

```html
<button mfb-button mfb-button-close>Closes the menu</button>
```

<a name="custom-tpls"></a>
### Customising templates
Custom templates can be passed as a attributes to the directive. Just pass either the url of your own template or the ID of the script containing your template. Refer to the default templates provided to have a working base to build upon.

<a name="custom-css"></a>
### More customisations
The component have plenty more customisations available and they are all handled by the CSS. The CSS and its SCSS source files are found in the `mfb/` folder (which is actually a subtree that pulls from [this repo](https://github.com/nobitagit/material-floating-button)).

For a thorough overview of what and how to customise the look of the component through css make sure you read [these docs](https://github.com/nobitagit/ng-material-floating-button/tree/master/mfb), especially if you plan to keep your copy in sync with this repo by pulling in changes in the future.

## Unit tests
To run the tests you need Jasmine and Karma runner. They can be run from the console with either `grunt karma` or `karma start test/karma.conf.js` commands.

## Contributing and issues
Contributions are very welcome, as well as opening issues if you find any bugs.
If an issue or pull request is **not** specifically related to the Angularjs version (i.e. it's a layout/css bug/feature) please open it on the original component [repo](https://github.com/nobitagit/material-floating-button) rather than here.

## Todos
- [x] add "click to open" functionality and option
- [x] add to bower
- [x] add to npm

## Credits
Thanks to these [contributors](https://github.com/nobitagit/ng-material-floating-button/graphs/contributors).
Demo icons are courtesy of [Ionicons](ionicons.com)
5 changes: 4 additions & 1 deletion src/mfb-directive.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@
' <a data-mfb-label="{{label}}" class="mfb-component__button--child">' +
' <i class="mfb-component__child-icon {{icon}}">' +
' </i>' +
' <img ng-if="image" src="{{image}}">' +
' </a>' +
'</li>'
);
Expand Down Expand Up @@ -196,7 +197,8 @@
replace: true,
scope: {
icon: '@',
label: '@'
label: '@',
image: '@'
},
templateUrl: function(elem, attrs) {
return attrs.templateUrl || 'ng-mfb-button-default.tpl.html';
Expand All @@ -205,3 +207,4 @@
}]);

})(window, angular);

Loading