Document as_int in NumberSelector

This commit is contained in:
epenet 2024-11-08 11:26:58 +01:00 committed by GitHub
parent cd18fda670
commit 7364b16407
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -1085,10 +1085,17 @@ mode:
type: string
required: false
default: slider
as_int:
description: Force the resulting number into an integer.
type: bool
required: false
{% endconfiguration %}
The output of this selector is a number, for example: `42`
Please note that the user input is never rounded, regardless of the step,
and will always return a float unless `as_int` is set to `True`.
### Example number selectors <!-- omit from toc -->
An example number selector that allows a user a percentage, directly in a