Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Readme: some more styling #155

Merged
merged 1 commit into from
Feb 21, 2025
Merged

fix: Readme: some more styling #155

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 19 additions & 19 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,9 @@ resources:
| ------------- | ------- | ------------ | ----------------------------------------------------------------------------------------------- |
| type | string | **Required** | `custom:restriction-card` |
| card | map | **Required** | Card to render within `restriction-card` |
| restrictions | map | **Optional** | Additional restrictions. See [Restrictions Options](#restrictions-options) |
| exemptions | list | **Optional** | List of exemption objects. See [Exemption Options](#exemption-options) |
| condition | map | **Optional** | Conditional object to make lock active. See [Condition Options](#condition-options) |
| restrictions | map | **Optional** | Additional restrictions. See [Restrictions options](#restrictions-options) |
| exemptions | list | **Optional** | List of exemption objects. See [Exemption options](#exemption-options) |
| condition | map | **Optional** | Conditional object to make lock active. See [Condition options](#condition-options) |
| row | boolean | **Optional** | Set to true to give a default `margin:left: 24px` |
| duration | number | **Optional** | Duration of unlock in seconds. Default is `5` |
| action | string | **Optional** | Action type to trigger the unlock. Options are `tap`, `double_tap`, or `hold`. Default is `tap` |
Expand All @@ -55,27 +55,27 @@ resources:

| Name | Type | Requirement | Description |
| ------- | ---- | ------------ | ------------------------------------------------------------------------- |
| confirm | map | **Optional** | Confirmation unlock restriction. See [Confirm Options](#confirm-options). |
| pin | map | **Optional** | Pin code restriction. See [Pin Options](#pin-options). |
| block | map | **Optional** | Block interaction restriction. See [Block Options](#block-options). |
| hide | map | **Optional** | Hide card restriction. See [Hide Options](#hide-options).. |
| confirm | map | **Optional** | Confirmation unlock restriction. See [Confirm options](#confirm-options) |
| pin | map | **Optional** | Pin code restriction. See [Pin options](#pin-options) |
| block | map | **Optional** | Block interaction restriction. See [Block options](#block-options) |
| hide | map | **Optional** | Hide card restriction. See [Hide options](#hide-options) |

## Confirm options

| Name | Type | Requirement | Description |
| ---------- | ------ | ------------ | ------------------------------------------------------------------------------------------- |
| text | string | **Optional** | Text to display in confirmation dialog |
| exemptions | list | **Optional** | List of exemption objects. See [Exemption Options](#exemption-options). |
| condition | map | **Optional** | Conditional object to make restriction active. See [Condition Options](#condition-options). |
| exemptions | list | **Optional** | List of exemption objects. See [Exemption options](#exemption-options) |
| condition | map | **Optional** | Conditional object to make restriction active. See [Condition options](#condition-options) |

## Pin options

| Name | Type | Requirement | Description |
| ----------------- | ------ | ------------ | ------------------------------------------------------------------------------------------------------------------------- |
| code | string/list | **Required** | Pin code the user needs to enter to unlock. Could be a list of codes |
| text | string | **Optional** | Text to display in prompt dialog |
| exemptions | list | **Optional** | List of exemption objects. See [Exemption Options](#exemption-options). |
| condition | map | **Optional** | Conditional object to make restriction active. See [Condition Options](#condition-options). |
| exemptions | list | **Optional** | List of exemption objects. See [Exemption options](#exemption-options) |
| condition | map | **Optional** | Conditional object to make restriction active. See [Condition options](#condition-options) |
| retry_delay | number | **Optional** | Number of seconds that you want to delay next attempt to unlock. Default is `0` |
| max_retries | number | **Optional** | Number of consecutive invalid retries allowed before blocking for the `max_retries_delay` seconds. Default is `unlimited` |
| max_retries_delay | number | **Optional** | Number of seconds to block attempts to unlock after the `max_retries` has been reached |
Expand All @@ -85,30 +85,30 @@ resources:
| Name | Type | Requirement | Description |
| ---------- | ------ | ------------ | ------------------------------------------------------------------------------------------- |
| text | string | **Optional** | Text to display in alert |
| exemptions | list | **Optional** | List of exemption objects. See [Exemption Options](#exemption-options). |
| condition | map | **Optional** | Conditional object to make restriction active. See [Condition Options](#condition-options). |
| exemptions | list | **Optional** | List of exemption objects. See [Exemption options](#exemption-options) |
| condition | map | **Optional** | Conditional object to make restriction active. See [Condition options](#condition-options) |

## Hide options

| Name | Type | Requirement | Description |
| ---------- | ---- | ------------ | ------------------------------------------------------------------------------------------- |
| exemptions | list | **Optional** | List of exemption objects. See [Exemption Options](#exemption-options). |
| condition | map | **Optional** | Conditional object to make restriction active. See [Condition Options](#condition-options). |
| exemptions | list | **Optional** | List of exemption objects. See [Exemption options](#exemption-options) |
| condition | map | **Optional** | Conditional object to make restriction active. See [Condition options](#condition-options) |

## Exemption options

| Name | Type | Requirement | Description |
| ---- | ------ | ------------ | ---------------------------------------------------------- |
| user | string | **Required** | User id to exempt. This is found in the user profile `ID`. |
| user | string | **Required** | User id to exempt. This is found in the user profile `ID` |

## Condition options

| Name | Type | Requirement | Description |
| --------- | ------ | ------------ | --------------------------------------------------------------------------------------------------- |
| value | string | **Required** | String representing the state. |
| value | string | **Required** | String representing the state |
| entity | string | **Required** | Entity to use condition and is what also causes the card to update |
| attribute | string | **Optional** | Attribute of the entity to use instead of the state. |
| operator | string | **Optional** | Operator to use in the comparison. Can be `==`,`<=`,`<`,`>=`,`>`,`!=`, or `regex`. Default is `==`. |
| attribute | string | **Optional** | Attribute of the entity to use instead of the state |
| operator | string | **Optional** | Operator to use in the comparison. Can be `==`,`<=`,`<`,`>=`,`>`,`!=`, or `regex`. Default is `==` |

## Theme variables

Expand Down
Loading