diff --git a/components/fab/README.md b/components/fab/README.md index f85fe063..757f4068 100644 --- a/components/fab/README.md +++ b/components/fab/README.md @@ -8,16 +8,16 @@ > refer to [Material Design Icon Font](https://material.io/icons/) for the list of icons -> FAB can't be disabled +> FAB can't be disabled > add an `href` attribute for link ### events -| event | args | Description | -|-------|------|-------------| -|`@click`||emitted on click | +| event | args | Description | +|---------|------|-------------| +|`@click` | | emitted on click | ### props @@ -39,12 +39,12 @@ ### Custom Icons -> You can omit the icon prop to render your custom icons - **Font Awsome** ```html - + + + ``` @@ -74,9 +74,8 @@ You might want to keep button behavior and do the navigation programatically: ```html Home -``` - - +``` ### Reference + - \ No newline at end of file diff --git a/components/icon-toggle/README.md b/components/icon-toggle/README.md index eed92532..33aa97ef 100644 --- a/components/icon-toggle/README.md +++ b/components/icon-toggle/README.md @@ -1,9 +1,28 @@ ## Usage ```html + + toggle-on="favorite" + toggle-off="favorite_border"> + + + + + + + + + + + + ``` @@ -17,22 +36,32 @@ var vm = new Vue({ > refer to [Material Design Icon Font](https://material.io/icons/) for the list of icons - ### props -| prop | Type | Default | Description | -|-------|------|---------|-------------| -|`v-model`|Boolean|| togggle state binding | -|`disabled`|Boolean|| whether component is disabled | -|`primary`|Boolean|| set primary theme | -|`accent`|Boolean|| set accent theme | -|`toggle-on`|String|| toggled on icon name | -|`toggle-off`|String|| toggled off icon name | -|`label-on`|String|| toggled on aria-label attribute | -|`label-off`|String|| toggled on aria-label attribute | -|`class-on`|String|| optional css class when toggled on| -|`class-off`|String|| optional css class when toggled off | +| prop | Type | Default | Description | +|------------|------------------|-----------|-------------| +|`v-model` | Boolean | value | togggle state binding | +|`disabled` | Boolean | false | whether component is disabled | +|`primary` | Boolean | false | set primary theme | +|`accent` | Boolean | false | set accent theme | +|`toggle-on` | [String, Object] | undefined | toggle on material icon name or options (*) | +|`toggle-off`| [String, Object] | undefined | toggle off material icon name or options (*)| + +- (*) Material Icons case +| prop | Type | Description | +|-------|---------|--------------------| +|`label`| Boolean | label | +|`icon` | String | material icon name | + +- (*) Custom Icons case + +| prop | Type | Description | +|-----------|---------|--------------| +|`label` | Boolean | label | +|`content` | String | icon content | +|`cssClass` | String | icon class | ### Reference + - \ No newline at end of file diff --git a/components/icon-toggle/demo.vue b/components/icon-toggle/demo.vue index e9dd43f8..560e920f 100644 --- a/components/icon-toggle/demo.vue +++ b/components/icon-toggle/demo.vue @@ -2,13 +2,13 @@
- + :toggle-on="{ cssClass:'fa fa-font-awesome'}" + :toggle-off="{ cssClass: 'fa fa-fort-awesome'}" + > @@ -24,4 +24,8 @@ export default { } } } - \ No newline at end of file + + + diff --git a/components/icon-toggle/mdc-icon-toggle.vue b/components/icon-toggle/mdc-icon-toggle.vue index 357a0f88..0338887c 100644 --- a/components/icon-toggle/mdc-icon-toggle.vue +++ b/components/icon-toggle/mdc-icon-toggle.vue @@ -1,12 +1,11 @@