Function radioList

  • radioList(props): Element

  • Creates a radio list component for single selection from multiple options.

    Parameters

    • props: UiRadioListFieldProps

      Configuration object

    Returns Element

    A JSX element representing the radio list component

    Example

    Basic usage with required props

    radioList({
      name: 'gender',
      label: 'Gender',
      items: [
        { value: 'male', label: 'Male' },
        { value: 'female', label: 'Female' },
        { value: 'other', label: 'Other' }
      ]
    });

    Example

    Usage with default value

    radioList({
      name: 'preferredContact',
      label: 'Preferred Contact Method',
      items: [
        { value: 'email', label: 'Email' },
        { value: 'phone', label: 'Phone' },
        { value: 'mail', label: 'Mail' }
      ],
      defaultValue: 'email',
      required: true,
      disabled: false
    });

    Example

    Usage with global state

    radioList({
      name: 'food',
      label: 'food',
      items: async (state) =>
        state.country === 'us'
          ? [{value: 'burger', label: 'Burger'}, {value: 'fries', label: 'Fries'}]
          : [{value: 'pasta', label: 'Pasta'}, {value: 'pizza', label: 'Pizza'}, {value: 'salad', label: 'Salad'}],
    });

Settings