Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@jcwillox
jcwillox committed Jan 8, 2022
1 parent c493148 commit a3adb77
Showing 1 changed file with 12 additions and 8 deletions.
20 changes: 12 additions & 8 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,17 @@ This is a complete rewrite of the original [`button-entity-row`](https://github.

## Options

| Name | Type | Requirement | Description |
| ------------ | ----------------------------------------------------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------- |
| type | `string` | **Required** | `custom:paper-buttons-row` |
| buttons | List [`string` or [`button object`](#button-options)] | **Required** | List of buttons to display. [See button options](#button-options) |
| base_config | [`button object`](#button-options) | **Optional** | Specify a base config that will be deep-merged with each buttons config. Buttons can override the base config |
| styles | `object` | **Optional** | CSS styles to apply to the entire button group. e.g. to change the flex-box alignment. |
| extra_styles | `string` | **Optional** | Inject CSS directly into the paper-buttons-row container, useful for animations. |
| Name | Type | Requirement | Description |
| ------------ | ----------------------------------------------------- | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| type | `string` | **Required** | `custom:paper-buttons-row` |
| buttons | List [`string` or [`button object`](#button-options)] | **Required** | List of buttons to display. [See button options](#button-options) |
| base_config | [`button object`](#button-options) | **Optional** | Specify a base config that will be deep-merged with each buttons config. Buttons can override the base config |
| styles | `object` | **Optional** | CSS styles to apply to the entire button group. e.g. to change the flex-box alignment. |
| extra_styles | `string` | **Optional** | Inject CSS directly into the paper-buttons-row container, useful for animations. |
| | | | |
| position | `"center"` \| `"right"` | **Optional** | Position embedded buttons in the middle or end of the entity-row (default: `center`). [See embedding in entity rows](#embedding-in-other-entity-rows) |
| hide_badge | `boolean` | **Optional** | Hide state badge when embedding in an entity-row |
| hide_state | `boolean` | **Optional** | Hide state text or toggle when embedding in an entity-row |

### Button Options

Expand All @@ -34,7 +38,7 @@ When only an `entity` is provided the button will attempt to toggle it by defaul
| hold_action | `map` | **Optional** | Hold action map [See action options](#action-options) |
| double_tap_action | `map` | **Optional** | Double Tap action map [See action options](#action-options) |
| | | | |
| styles | [`style object`](#style-options) (templatable) | **Optional** | Map of CSS styles to apply to the button, icon, text or ripple. [See style options](#style-options) |
| styles | [`style object`](#style-options) (templatable) | **Optional** | Map of CSS styles to apply to the button, icon, text or ripple. [See style options](#style-options) |
| state_styles | `map[state: style object]` | **Optional** | Map of states to a [`style object`](#style-options), [See example](#using-style-and-state_styles). |
| state_icons | `map[state: icon]` | **Optional** | Material icon for each state of the entity. Map state to icon, [See example](#using-state-icons-state-text-and-actions). |
| state_text | `map[state: text]` | **Optional** | Button text for each state of the entity, Map state to text, [See example](#using-state-icons-state-text-and-actions). |
Expand Down

0 comments on commit a3adb77

Please sign in to comment.