Generated wrapper for the Web Awesome wa-rating component. When used
as a Shiny input, input$<input_id> reflects the component's current
value value. The Shiny value is returned as a numeric value.
Generated from Web Awesome metadata.
Usage
wa_rating(
input_id,
...,
class = NULL,
style = NULL,
value = NULL,
disabled = NULL,
label = NULL,
name = NULL,
custom_error = NULL,
default_value = NULL,
dir = NULL,
get_symbol = NULL,
lang = NULL,
max = NULL,
precision = NULL,
readonly = NULL,
required = NULL,
size = NULL
)Arguments
- input_id
Shiny input id for the component. This is also used as the rendered DOM
idattribute.- ...
Child content for the component's default slot.
- class
Optional CSS class string.
- style
Optional inline CSS style string.
- value
Number. Default:
0. The current rating.- disabled
Boolean. Default:
FALSE. Disables the rating.- label
String. Default:
"". A label that describes the rating to assistive devices.- name
String. Default:
null. The name of the rating, submitted as a name/value pair with form data.- custom_error
String. Default:
null. Optional Web Awesome attribute.- default_value
Number. Default:
0. The default value of the form control. Used to reset the rating to its initial value.- dir
String. Optional Web Awesome attribute.
- get_symbol
A function that customizes the symbol to be rendered. The first and only argument is the rating's current value. The function should return a string containing trusted HTML of the symbol to render at the specified value. Works well with
<wa-icon>elements.- lang
String. Optional Web Awesome attribute.
- max
Number. Default:
5. The highest rating to show.- precision
Number. Default:
1. The precision at which the rating will increase and decrease. For example, to allow half-star ratings, set this attribute to0.5.- readonly
Boolean. Default:
FALSE. Makes the rating readonly.- required
Boolean. Default:
FALSE. Makes the rating a required field.- size
Enumerated string. Allowed values:
large,medium,small. Default:medium. The component's size.