Skip to content

Commit

Permalink
feat(docs): change messages API from tables to lists in README (#1091)
Browse files Browse the repository at this point in the history
* feat(message): change API from tables to lists

* feat(message): change API from tables to lists

* chore(): update
  • Loading branch information
jennmedellin authored and emoralesb05 committed Jan 16, 2018
1 parent b82fed7 commit d86d5cf
Showing 1 changed file with 21 additions and 12 deletions.
33 changes: 21 additions & 12 deletions src/platform/core/message/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,27 @@ But you can also set a `color` from our lib and it can be applied in the compone

## API Summary

Properties:

| Name | Type | Description |
| --- | --- | 650--- |
| `label?` | `string` | Sets the label of the message.
| `sublabel?` | `string` | Sets the sublabel of the message.
| `icon?` | `string` | The icon to be displayed before the title. Defaults to `info_outline` icon
| `color?` | `'primary', 'accent' or 'warn'` | Sets the color of the message. Can also use any material color: `purple`, `light-blue`, etc.
| `opened?` | `boolean` | Shows or hiddes the message depending on its value. Defaults to 'true'.
| `open` | `function()` | Renders the message on screen.
| `close` | `function()` | Removes the message content from screen.
| `toggle` | `function()` | Toggles between open and close depending on state.
#### Inputs

+ label?: string
+ Sets the label of the message.
+ sublabel?: string
+ Sets the sublabel of the message.
+ icon?: string
+ The icon to be displayed before the title. Defaults to `info_outline` icon.
+ color?: 'primary' | 'accent' | 'warn'
+ Sets the color of the message. Can also use any material color: `purple`, `light-blue`, etc.
+ opened?: boolean
+ Shows or hides the message depending on its value. Defaults to 'true'.

#### Methods

+ open: function
+ Renders the message on screen.
+ close: function
+ Removes the message content from screen.
+ toggle: function
+ Toggles between open and close depending on state.

## Setup

Expand Down

0 comments on commit d86d5cf

Please sign in to comment.