Skip to content

Commit

Permalink
Merge pull request #11 from holblin/master
Browse files Browse the repository at this point in the history
Add options, fix display, make it closer to google keep
  • Loading branch information
PiotrMachowski authored Mar 30, 2021
2 parents d0a8ac0 + 314f9d4 commit 4b79411
Show file tree
Hide file tree
Showing 2 changed files with 266 additions and 132 deletions.
19 changes: 16 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,13 @@ This is a companion card for [Google Keep sensor](https://github.com/PiotrMachow
| --- | --- | --- | --- | --- |
| `title` | `string` | `False` | - | Desired title of a card |
| `entity` | `string` | `True` | - | ID of Google Keep sensor |
| `theme` | `string` | `False` | `light` | Theme to be used for notes. Possible values: `light`, `dark` |
| `theme` | `string` | `False` | `light` | Theme to be used for notes. Possible values: `light`, `dark`, `auto` |
| `alpha` | `float` | `False` | 1 | Level of transparency used for notes (0 - fully transparent, 1 - not transparent) |
| `show` | `list` | `True` | - | List of sections that should be displayed. Possible values: `checked`, `unchecked` |
| `hide_if_empty` | `boolean` | `False` | `false` | Enables hiding cart when there are no notes found. Possible values: `true`, `false` |

| `system_box` | `boolean` | `False` | `false` | Make each note a HA tile instead of encapsulating them into a HA tile |
| `force_background` | `boolean` | `False` | `false` | Force the background to white/black according to the theme |
| `small_title_margin` | `boolean` | `False` | `false` | Reduce the bottom margin of the title |

## Example usage:
```yaml
Expand All @@ -37,18 +39,29 @@ views:
```
## Installation
### Manual
1. Download [*google-keep-card.js*](https://github.com/PiotrMachowski/Lovelace-Google-Keep-card/raw/master/dist/google-keep-card.js) to `/www/custom_lovelace/google_keep_card` directory:
```bash
mkdir -p www/custom_lovelace/google_keep_card
cd www/custom_lovelace/google_keep_card/
wget https://github.com/PiotrMachowski/Lovelace-Google-Keep-card/raw/master/dist/google-keep-card.js
```
2. Add card to resources in `ui-lovelace.yaml` or in raw editor if you are using frontend UI editor:
2. Add card to resources:
```yaml
resources:
- url: /local/custom_lovelace/google_keep_card/google-keep-card.js
type: module
```

### HACS
1. Find this card in "Frontend" section and install it
2. Add card to resources:
```yaml
resources:
- url: /hacsfiles/google_keep_card/google-keep-card.js
type: module
```

## FAQ
* **Does this card allow editing notes?**

Expand Down
Loading

0 comments on commit 4b79411

Please sign in to comment.