Skip to content

Commit 0923abb

Browse files
committed
Updated Readme file
1 parent 82f0782 commit 0923abb

File tree

1 file changed

+24
-23
lines changed

1 file changed

+24
-23
lines changed

README.md

Lines changed: 24 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -30,38 +30,40 @@ And
3030

3131
## Properties
3232

33-
`style` - Sets styles properties.
34-
* Type - Object
35-
36-
| Properties | Type | Values |
37-
| :--------------- | :------- | :--------- |
38-
| `bgColor` | String | <b>'#333333'</b><br> Accepts all color formats: HEX, RGB & RGBA |
39-
| `position` | String | <b>Default 'bottom-left'</b> <br>'bottom-left', 'bottom-right', 'top-left','top-right' |
40-
| `zIndex` | String | <b>Default '999'</b> <br>Set any value that suits your needs. |
41-
| `ripple` | Object | Has <b>two properties</b>: <br> -`show`: `true` or `false` <br> -`color`: `'dark'` or `'light'`|
42-
43-
`actions` - Sets a list of actions.
44-
* Type - Object
45-
46-
| Properties | Type | Values |
47-
| :--------------- | :------- | :--------- |
48-
| `name` | String | Name of the event. |
49-
| `icon` | String | Icon name. <br> (Please refer to [Material icons](https://material.io/icons/)) |
33+
| Properties | Type | Values |
34+
| :--------------- | :------- | :--------- |
35+
| `bg-color` | String | <b>Default '#333333'</b><br> Accepts all color formats: HEX, RGB & RGBA |
36+
| `position` | String | <b>Default 'bottom-left'</b> <br>'bottom-left', 'bottom-right', 'top-left','top-right' |
37+
| `z-index` | String | <b>Default '999'</b> <br>Set any value that suits your needs. |
38+
| `ripple-show` | Boolean | <b>Default true</b> <br>Options: true or false. |
39+
| `ripple-color` | String | <b>Default 'light'</b> <br>Options: 'light' or 'dark'. |
40+
| `actions` | Object | Has <b>two properties</b>: <br> -`name` (String) Name of the event. <br> -`icon`(String) Icon name. (Please refer to [Material icons](https://material.io/icons/))|
5041

5142

5243
## Examples
5344

54-
Include the component in your .vue file, `styles` & `actions` props are required for the component to work. The `@event` has to match the name given in the `actions` prop.
45+
Include the component in your .vue file, `actions` prop is required for the component to work. The `@event` has to match the name given in the `actions` prop.
5546
```
5647
<template>
57-
<fab :styles="fabStyles"
58-
:actions="fabActions"
48+
<fab :actions="fabActions"
5949
@cache="cache"
6050
@alertMe="alert"
6151
></fab>
6252
</template>
6353
```
6454

55+
Either `color` and `position` are set by default but they can be changed.
56+
57+
```
58+
<fab
59+
:position="position"
60+
:bg-color="bgColor"
61+
:actions="fabActions"
62+
@cache="cache"
63+
@alertMe="alert"
64+
></fab>
65+
```
66+
6567
Match your data with your components props. The `bgColor` accepts either HEX, RBG or RGBA format.
6668

6769
<b>Remember:</b> Only material icons are accepted.
@@ -75,9 +77,8 @@ export default {
7577
},
7678
data(){
7779
return {
78-
fabStyles: {
79-
bgColor: '#778899'
80-
},
80+
bgColor: '#778899',
81+
position: 'top-right',
8182
fabActions: [
8283
{
8384
name: 'cache',

0 commit comments

Comments
 (0)