120 lines
6.6 KiB
Markdown
120 lines
6.6 KiB
Markdown
# Boilerplate Card by [@iantrich](https://www.github.com/iantrich)
|
|
|
|
A community driven boilerplate of best practices for Home Assistant Lovelace custom cards
|
|
|
|
[![GitHub Release][releases-shield]][releases]
|
|
[![License][license-shield]](LICENSE.md)
|
|
[](https://github.com/custom-components/hacs)
|
|
|
|
![Project Maintenance][maintenance-shield]
|
|
[![GitHub Activity][commits-shield]][commits]
|
|
|
|
[![Discord][discord-shield]][discord]
|
|
[![Community Forum][forum-shield]][forum]
|
|
|
|
## Support
|
|
|
|
Hey dude! Help me out for a couple of :beers: or a :coffee:!
|
|
|
|
[](https://www.buymeacoffee.com/zJtVxUAgH)
|
|
|
|
## 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` |
|
|
| double_tap_action | object | **Optional** | Action to take on double tap | `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` |
|
|
| repeat | number | **Optional** | How often to repeat the `hold_action` in milliseconds. | `non` |
|
|
|
|
## Starting a new card from boilerplate-card
|
|
|
|
### Step 1
|
|
|
|
Clone this repository
|
|
|
|
### Step 2
|
|
|
|
Install necessary modules (verified to work in node 8.x)
|
|
`yarn install` or `npm install`
|
|
|
|
### Step 3
|
|
|
|
Do a test lint & build on the project. You can see available scripts in the package.json
|
|
`npm run build`
|
|
|
|
### Step 4
|
|
|
|
Search the repository for all instances of "TODO" and handle the changes/suggestions
|
|
|
|
### Step 5
|
|
|
|
Customize to suit your needs and contribute it back to the community
|
|
|
|
## Starting a new card from boilerplate-card with [devcontainer][devcontainer]
|
|
|
|
Note: this is available only in vscode ensure you have the [Remote Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension installed.
|
|
|
|
1. Fork and clone the repository.
|
|
2. Open a [devcontainer][devcontainer] terminal and run `npm start` when it's ready.
|
|
3. The compiled `.js` file will be accessible on
|
|
`http://127.0.0.1:5000/boilerplate-card.js`.
|
|
4. On a running Home Assistant installation add this to your Lovelace
|
|
`resources:`
|
|
|
|
```yaml
|
|
- url: 'http://127.0.0.1:5000/boilerplate-card.js'
|
|
type: module
|
|
```
|
|
|
|
_Change "127.0.0.1" to the IP of your development machine._
|
|
|
|
### Bonus
|
|
|
|
If you need a fresh test instance you can install a fresh Home Assistant instance inside the devcontainer as well.
|
|
|
|
1. Run the command `container start`.
|
|
2. Home Assistant will install and will eventually be running on port `9123`
|
|
|
|
## [Troubleshooting](https://github.com/thomasloven/hass-config/wiki/Lovelace-Plugins)
|
|
|
|
NB This will not work with node 9.x if you see the following errors try installing node 8.10.0
|
|
|
|
```yarn install
|
|
yarn install v1.3.2
|
|
[1/4] 🔍 Resolving packages...
|
|
warning rollup-plugin-commonjs@10.1.0: This package has been deprecated and is no longer maintained. Please use @rollup/plugin-commonjs.
|
|
[2/4] 🚚 Fetching packages...
|
|
error @typescript-eslint/eslint-plugin@2.6.0: The engine "node" is incompatible with this module. Expected version "^8.10.0 || ^10.13.0 || >=11.10.1".
|
|
error Found incompatible module
|
|
info Visit https://yarnpkg.com/en/docs/cli/install for documentation about this command.
|
|
```
|
|
|
|
[commits-shield]: https://img.shields.io/github/commit-activity/y/custom-cards/boilerplate-card.svg?style=for-the-badge
|
|
[commits]: https://github.com/custom-cards/boilerplate-card/commits/master
|
|
[devcontainer]: https://code.visualstudio.com/docs/remote/containers
|
|
[discord]: https://discord.gg/5e9yvq
|
|
[discord-shield]: https://img.shields.io/discord/330944238910963714.svg?style=for-the-badge
|
|
[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg?style=for-the-badge
|
|
[forum]: https://community.home-assistant.io/c/projects/frontend
|
|
[license-shield]: https://img.shields.io/github/license/custom-cards/boilerplate-card.svg?style=for-the-badge
|
|
[maintenance-shield]: https://img.shields.io/maintenance/yes/2020.svg?style=for-the-badge
|
|
[releases-shield]: https://img.shields.io/github/release/custom-cards/boilerplate-card.svg?style=for-the-badge
|
|
[releases]: https://github.com/custom-cards/boilerplate-card/releases
|