Skip to contents

Generated wrapper for the Web Awesome wa-radio-group component. When used as a Shiny input, input$<input_id> reflects the component's current value value. Generated from Web Awesome metadata.

Usage

wa_radio_group(
  input_id,
  ...,
  class = NULL,
  style = NULL,
  value = NULL,
  disabled = NULL,
  label = NULL,
  hint = NULL,
  name = NULL,
  custom_error = NULL,
  dir = NULL,
  lang = NULL,
  orientation = NULL,
  required = NULL,
  size = NULL,
  with_hint = NULL,
  with_label = NULL,
  hint_slot = NULL,
  label_slot = NULL
)

Arguments

input_id

Shiny input id for the component. This is also used as the rendered DOM id attribute.

...

Child content for the component's default slot.

class

Optional CSS class string.

style

Optional inline CSS style string.

value

String. The default value of the form control. Primarily used for resetting the form control. This wrapper argument sets the HTML value attribute, which maps to the component's defaultValue field/property rather than its live value property.

disabled

Boolean. Default: FALSE. Disables the radio group and all child radios.

label

String. Default: "". The radio group's label. Required for proper accessibility. If you need to display HTML, use the label slot instead.

hint

String. Default: "". The radio groups's hint. If you need to display HTML, use the hint slot instead.

name

String. Default: null. The name of the radio group, submitted as a name/value pair with form data.

custom_error

String. Default: null. Optional Web Awesome attribute.

dir

String. Optional Web Awesome attribute.

lang

String. Optional Web Awesome attribute.

orientation

Enumerated string. Allowed values: horizontal, vertical. Default: vertical. The orientation in which to show radio items.

required

Boolean. Default: FALSE. Ensures a child radio is checked before allowing the containing form to submit.

size

Enumerated string. Allowed values: large, medium, small. The radio group's size. When present, this size will be applied to all <wa-radio> items inside.

with_hint

Boolean. Default: FALSE. Only required for SSR. Set to TRUE if you're slotting in a hint element so the server-rendered markup includes the hint before the component hydrates on the client.

with_label

Boolean. Default: FALSE. Only required for SSR. Set to TRUE if you're slotting in a label element so the server-rendered markup includes the label before the component hydrates on the client.

hint_slot

Text that describes how to use the radio group. Alternatively, you can use the hint attribute.

label_slot

The radio group's label. Required for proper accessibility. Alternatively, you can use the label attribute.

Value

An HTML tag for the component.

Shiny Bindings

input$<input_id> reflects the component's current value value.