diff --git a/README.md b/README.md index 74cb529d..a0003933 100644 --- a/README.md +++ b/README.md @@ -14,26 +14,27 @@ A community driven boilerplate of best practices for Home Assistant Lovelace cus ## Options -| Name | Type | Requirement | Description | Default -| ---- | ---- | ------- | ----------- | ------- -| type | string | **Required** | `custom:boilerplate-card` -| name | string | **Optional** | Card name | `Boilerplate` -| show_error | boolean | **Optional** | Show what an error looks like for the card | `false` -| show_warning | boolean | **Optional** | Show what a warning looks like for the card | `false` -| entity | string | **Optional** | Home Assistant entity ID. | `none` -| tap_action | object | **Optional** | Action to take on tap | `action: more-info` -| hold_action | object | **Optional** | Action to take on hold | `none` +| Name | Type | Requirement | Description | Default | +| ----------------- | ------- | ------------ | ------------------------------------------- | ------------------- | +| type | string | **Required** | `custom:boilerplate-card` | +| name | string | **Optional** | Card name | `Boilerplate` | +| show_error | boolean | **Optional** | Show what an error looks like for the card | `false` | +| show_warning | boolean | **Optional** | Show what a warning looks like for the card | `false` | +| entity | string | **Optional** | Home Assistant entity ID. | `none` | +| tap_action | object | **Optional** | Action to take on tap | `action: more-info` | +| hold_action | object | **Optional** | Action to take on hold | `none` | +| double_tap_action | object | **Optional** | Action to take on hold | `none` | ## Action Options -| Name | Type | Requirement | Description | Default -| ---- | ---- | ------- | ----------- | ------- -| action | string | **Required** | Action to perform (more-info, toggle, call-service, navigate url, none) | `more-info` -| navigation_path | string | **Optional** | Path to navigate to (e.g. /lovelace/0/) when action defined as navigate | `none` -| url | string | **Optional** | URL to open on click when action is url. The URL will open in a new tab | `none` -| service | string | **Optional** | Service to call (e.g. media_player.media_play_pause) when action defined as call-service | `none` -| service_data | object | **Optional** | Service data to include (e.g. entity_id: media_player.bedroom) when action defined as call-service | `none` -| haptic | string | **Optional** | Haptic feedback for the [Beta IOS App](http://home-assistant.io/ios/beta) _success, warning, failure, light, medium, heavy, selection_ | `none` +| Name | Type | Requirement | Description | Default | +| --------------- | ------ | ------------ | -------------------------------------------------------------------------------------------------------------------------------------- | ----------- | +| action | string | **Required** | Action to perform (more-info, toggle, call-service, navigate url, none) | `more-info` | +| navigation_path | string | **Optional** | Path to navigate to (e.g. /lovelace/0/) when action defined as navigate | `none` | +| url | string | **Optional** | URL to open on click when action is url. The URL will open in a new tab | `none` | +| service | string | **Optional** | Service to call (e.g. media_player.media_play_pause) when action defined as call-service | `none` | +| service_data | object | **Optional** | Service data to include (e.g. entity_id: media_player.bedroom) when action defined as call-service | `none` | +| haptic | string | **Optional** | Haptic feedback for the [Beta IOS App](http://home-assistant.io/ios/beta) _success, warning, failure, light, medium, heavy, selection_ | `none` | ## Starting a new card from boilerplate-card