From c829cd5957c3869f6aa4f22569a1c06fc587cedf Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Thu, 21 Oct 2021 12:47:22 +0200 Subject: [PATCH] Add mode to number entity documentation (#1102) * Add mode to number entity documentation * Update docs/core/entity/number.md Co-authored-by: Martin Hjelmare Co-authored-by: Martin Hjelmare --- docs/core/entity/number.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/core/entity/number.md b/docs/core/entity/number.md index 103bb2d0..baf80175 100644 --- a/docs/core/entity/number.md +++ b/docs/core/entity/number.md @@ -17,10 +17,11 @@ Properties should always only return information from memory and not do I/O (lik | min_value | float | 0 | The minimum accepted value (inclusive) | max_value | float | 100 | The maximum accepted value (inclusive) | step | float | **See below** | Defines the resolution of the values, i.e. the smallest increment or decrement +| mode | string | `auto` | Defines how the number should be displayed in the UI. It's recommended to use the default `auto`. Can be `box` or `slider` to force a display mode. Other properties that are common to all entities such as `icon`, `unit_of_measurement`, `name` etc are also applicable. -The default step value is dynamically chosen based on the range (max - min) values. If the difference between max_value and min_value is greater than 1.0, then the default step is 1.0. If however the range is smaller, then the step is iteratively divided by 10 until it becomes lower than the range. +The default step value is dynamically chosen based on the range (max - min) values. If the difference between max_value and min_value is greater than 1.0, then the default step is 1.0. If, however, the range is smaller, then the step is iteratively divided by 10 until it becomes lower than the range. ## Methods