@dxc-technology/halstack-react 0.0.0-1e19032 → 0.0.0-1e57e26

package/radio-group/RadioGroup.test.js

@@ -53,18 +53,24 @@ describe("Radio Group component tests", function () {
   test("Initial render has correct aria attributes and tabIndex", function () {
     var _render = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_RadioGroup["default"], {
       label: "test-radioGroup-label",
-      options: options
+      options: options,
+      error: ""
     })),
         getByRole = _render.getByRole,
         getAllByRole = _render.getAllByRole,
-        getByText = _render.getByText;
+        getByText = _render.getByText,
+        container = _render.container;
 
     var radioGroup = getByRole("radiogroup");
     var radios = getAllByRole("radio");
+    var errorId = "error-".concat(getByText("test-radioGroup-label").id.replace("label-", ""));
+    var error = container.querySelector("#".concat(errorId));
     expect(radioGroup.getAttribute("aria-disabled")).toBe("false");
     expect(radioGroup.getAttribute("aria-labelledby")).toBe(getByText("test-radioGroup-label").id);
     expect(radioGroup.getAttribute("aria-invalid")).toBe("false");
     expect(radioGroup.getAttribute("aria-required")).toBe("true");
+    expect(radioGroup.getAttribute("aria-orientation")).toBe("vertical");
+    expect(error.getAttribute("aria-live")).toBe("off");
     radios.forEach(function (radio, index) {
       // if no option was previously selected, first option is the focusable one
       index === 0 ? expect(radio.tabIndex).toBe(0) : expect(radio.tabIndex).toBe(-1);
@@ -73,14 +79,25 @@ describe("Radio Group component tests", function () {
       expect(radio.getAttribute("aria-labelledby")).toBe(getByText("Option 0".concat(index + 1)).id);
     });
   });
-  test("Disabled state renders with correct aria attribute, correct tabIndex values and it is not focusable by keyboard", function () {
+  test("aria-orientation attribute changes depending on stacking prop value", function () {
     var _render2 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_RadioGroup["default"], {
+      label: "test-radioGroup-label",
+      options: options,
+      stacking: "row"
+    })),
+        getByRole = _render2.getByRole;
+
+    var radioGroup = getByRole("radiogroup");
+    expect(radioGroup.getAttribute("aria-orientation")).toBe("horizontal");
+  });
+  test("Disabled state renders with correct aria attribute, correct tabIndex values and it is not focusable by keyboard", function () {
+    var _render3 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_RadioGroup["default"], {
       label: "test-radioGroup-label",
       options: options,
       disabled: true
     })),
-        getByRole = _render2.getByRole,
-        getAllByRole = _render2.getAllByRole;
+        getByRole = _render3.getByRole,
+        getAllByRole = _render3.getAllByRole;
 
     var radioGroup = getByRole("radiogroup");
     var radios = getAllByRole("radio");
@@ -115,14 +132,13 @@ describe("Radio Group component tests", function () {
     });
   });
   test("Disabled option renders with correct aria attribute, correct tabIndex value and it is not focusable by keyboard (focus 'jumps' the disabled option)", function () {
-    var _render3 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_RadioGroup["default"], {
+    var _render4 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_RadioGroup["default"], {
       name: "test",
       label: "test-radioGroup-label",
       options: single_disabled_options
     })),
-        getByRole = _render3.getByRole,
-        getAllByRole = _render3.getAllByRole,
-        container = _render3.container;
+        getByRole = _render4.getByRole,
+        getAllByRole = _render4.getAllByRole;
 
     var radioGroup = getByRole("radiogroup");
     var radios = getAllByRole("radio");
@@ -150,13 +166,13 @@ describe("Radio Group component tests", function () {
     expect(radios[2].tabIndex).toBe(-1);
   });
   test("Error state renders with correct aria attributes", function () {
-    var _render4 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_RadioGroup["default"], {
+    var _render5 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_RadioGroup["default"], {
       label: "test-radioGroup-label",
       options: options,
       error: "Error message"
     })),
-        getByRole = _render4.getByRole,
-        getByText = _render4.getByText;
+        getByRole = _render5.getByRole,
+        getByText = _render5.getByText;
 
     var radioGroup = getByRole("radiogroup");
     var errorMessage = getByText("Error message");
@@ -168,21 +184,20 @@ describe("Radio Group component tests", function () {
     var onChange = jest.fn();
     var onBlur = jest.fn();
 
-    var _render5 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_RadioGroup["default"], {
+    var _render6 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_RadioGroup["default"], {
       label: "test-radioGroup-label",
       options: options,
       onChange: onChange,
       onBlur: onBlur
     })),
-        getByRole = _render5.getByRole,
-        getAllByRole = _render5.getAllByRole;
+        getByRole = _render6.getByRole,
+        getAllByRole = _render6.getAllByRole;
 
     var radioGroup = getByRole("radiogroup");
     expect(radioGroup.getAttribute("aria-required")).toBe("true");
 
     _react2.fireEvent.blur(radioGroup);
 
-    expect(onBlur).toHaveBeenCalled();
     expect(onBlur).toHaveBeenCalledWith({
       error: "This field is required. Please, choose an option."
     });
@@ -191,12 +206,10 @@ describe("Radio Group component tests", function () {
 
     _userEvent["default"].click(getAllByRole("radio")[0]);
 
-    expect(onChange).toHaveBeenCalled();
     expect(onChange).toHaveBeenCalledWith("1");
 
     _react2.fireEvent.blur(radioGroup);
 
-    expect(onBlur).toHaveBeenCalled();
     expect(onBlur).toHaveBeenCalledWith({
       value: "1"
     });
@@ -205,22 +218,21 @@ describe("Radio Group component tests", function () {
     var onChange = jest.fn();
     var onBlur = jest.fn();
 
-    var _render6 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_RadioGroup["default"], {
+    var _render7 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_RadioGroup["default"], {
       label: "test-radioGroup-label",
       value: "",
       options: options,
       onChange: onChange,
       onBlur: onBlur
     })),
-        getByRole = _render6.getByRole,
-        getAllByRole = _render6.getAllByRole;
+        getByRole = _render7.getByRole,
+        getAllByRole = _render7.getAllByRole;
 
     var radioGroup = getByRole("radiogroup");
     expect(radioGroup.getAttribute("aria-required")).toBe("true");
 
     _react2.fireEvent.blur(radioGroup);
 
-    expect(onBlur).toHaveBeenCalled();
     expect(onBlur).toHaveBeenCalledWith({
       value: "",
       error: "This field is required. Please, choose an option."
@@ -228,13 +240,12 @@ describe("Radio Group component tests", function () {
 
     _userEvent["default"].click(getAllByRole("radio")[0]);
 
-    expect(onChange).toHaveBeenCalled();
     expect(onChange).toHaveBeenCalledWith("1");
   });
   test("The 'defaultValue' gives the radio group an initial value when it is uncontrolled", function () {
     var onChange = jest.fn();
 
-    var _render7 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_RadioGroup["default"], {
+    var _render8 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_RadioGroup["default"], {
       defaultValue: "2",
       name: "test",
       label: "test-radio-group-label",
@@ -242,8 +253,8 @@ describe("Radio Group component tests", function () {
       options: options,
       onChange: onChange
     })),
-        getAllByRole = _render7.getAllByRole,
-        container = _render7.container;
+        getAllByRole = _render8.getAllByRole,
+        container = _render8.container;
 
     var radio = getAllByRole("radio")[1];
     var submitInput = container.querySelector("input[name=\"test\"]");
@@ -255,7 +266,7 @@ describe("Radio Group component tests", function () {
     var onChange = jest.fn();
     var onBlur = jest.fn();
 
-    var _render8 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_RadioGroup["default"], {
+    var _render9 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_RadioGroup["default"], {
       name: "test",
       label: "test-radio-group-label",
       helperText: "test-radio-group-helper-text",
@@ -265,16 +276,15 @@ describe("Radio Group component tests", function () {
       optional: true,
       optionalItemLabel: "No selection"
     })),
-        getByRole = _render8.getByRole,
-        getByText = _render8.getByText,
-        container = _render8.container;
+        getByRole = _render9.getByRole,
+        getByText = _render9.getByText,
+        container = _render9.container;
 
     var radioGroup = getByRole("radiogroup");
     expect(radioGroup.getAttribute("aria-required")).toBe("false");
 
     _react2.fireEvent.blur(radioGroup);
 
-    expect(onBlur).toHaveBeenCalled();
     expect(onBlur).toHaveBeenCalledWith({});
     expect(radioGroup.getAttribute("aria-invalid")).toBe("false");
     var optionalLabel = getByText("No selection");
@@ -282,7 +292,6 @@ describe("Radio Group component tests", function () {
 
     _userEvent["default"].click(optionalLabel);
 
-    expect(onChange).toHaveBeenCalled();
     expect(onChange).toHaveBeenCalledWith("");
     expect(submitInput.value).toBe("");
   });
@@ -290,7 +299,7 @@ describe("Radio Group component tests", function () {
     var onChange = jest.fn();
     var onBlur = jest.fn();
 
-    var _render9 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_RadioGroup["default"], {
+    var _render10 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_RadioGroup["default"], {
       name: "test",
       value: "2",
       label: "test-radio-group-label",
@@ -299,9 +308,9 @@ describe("Radio Group component tests", function () {
       onChange: onChange,
       onBlur: onBlur
     })),
-        getByRole = _render9.getByRole,
-        getAllByRole = _render9.getAllByRole,
-        container = _render9.container;
+        getByRole = _render10.getByRole,
+        getAllByRole = _render10.getAllByRole,
+        container = _render10.container;
 
     var radioGroup = getByRole("radiogroup");
     var radios = getAllByRole("radio");
@@ -312,12 +321,10 @@ describe("Radio Group component tests", function () {
 
     _userEvent["default"].click(radios[6]);
 
-    expect(onChange).toHaveBeenCalled();
     expect(onChange).toHaveBeenCalledWith("7");
 
     _react2.fireEvent.blur(radioGroup);
 
-    expect(onBlur).toHaveBeenCalled();
     expect(onBlur).toHaveBeenCalledWith({
       value: "2"
     });
@@ -325,16 +332,16 @@ describe("Radio Group component tests", function () {
   test("Select an option by clicking on its label", function () {
     var onChange = jest.fn();
 
-    var _render10 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_RadioGroup["default"], {
+    var _render11 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_RadioGroup["default"], {
       name: "test",
       label: "test-radio-group-label",
       helperText: "test-radio-group-helper-text",
       options: options,
       onChange: onChange
     })),
-        getByText = _render10.getByText,
-        getAllByRole = _render10.getAllByRole,
-        container = _render10.container;
+        getByText = _render11.getByText,
+        getAllByRole = _render11.getAllByRole,
+        container = _render11.container;
 
     var radioLabel = getByText("Option 09");
     var checkedRadio = getAllByRole("radio")[8];
@@ -343,7 +350,6 @@ describe("Radio Group component tests", function () {
 
     _userEvent["default"].click(radioLabel);
 
-    expect(onChange).toHaveBeenCalled();
     expect(onChange).toHaveBeenCalledWith("9");
     expect(checkedRadio.getAttribute("aria-checked")).toBe("true");
     expect(checkedRadio.tabIndex).toBe(0);
@@ -353,15 +359,15 @@ describe("Radio Group component tests", function () {
   test("Select an option by clicking on its radio input", function () {
     var onChange = jest.fn();
 
-    var _render11 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_RadioGroup["default"], {
+    var _render12 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_RadioGroup["default"], {
       name: "test",
       label: "test-radio-group-label",
       helperText: "test-radio-group-helper-text",
       options: options,
       onChange: onChange
     })),
-        getAllByRole = _render11.getAllByRole,
-        container = _render11.container;
+        getAllByRole = _render12.getAllByRole,
+        container = _render12.container;
 
     var checkedRadio = getAllByRole("radio")[6];
     var submitInput = container.querySelector("input[name=\"test\"]");
@@ -369,7 +375,6 @@ describe("Radio Group component tests", function () {
 
     _userEvent["default"].click(checkedRadio);
 
-    expect(onChange).toHaveBeenCalled();
     expect(onChange).toHaveBeenCalledWith("7");
     expect(checkedRadio.getAttribute("aria-checked")).toBe("true");
     expect(checkedRadio.tabIndex).toBe(0);
@@ -379,7 +384,7 @@ describe("Radio Group component tests", function () {
   test("Select an option that is already checked does not call onChange event but gives the focus", function () {
     var onChange = jest.fn();
 
-    var _render12 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_RadioGroup["default"], {
+    var _render13 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_RadioGroup["default"], {
       defaultValue: "2",
       name: "test",
       label: "test-radio-group-label",
@@ -387,7 +392,7 @@ describe("Radio Group component tests", function () {
       options: options,
       onChange: onChange
     })),
-        getAllByRole = _render12.getAllByRole;
+        getAllByRole = _render13.getAllByRole;
 
     var checkedRadio = getAllByRole("radio")[1];
     expect(checkedRadio.tabIndex).toBe(0);
@@ -401,16 +406,16 @@ describe("Radio Group component tests", function () {
   test("The 'enter' key checks the current focused option if anyone is checked", function () {
     var onChange = jest.fn();
 
-    var _render13 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_RadioGroup["default"], {
+    var _render14 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_RadioGroup["default"], {
       name: "test",
       label: "test-radio-group-label",
       helperText: "test-radio-group-helper-text",
       options: options,
       onChange: onChange
     })),
-        getByRole = _render13.getByRole,
-        getAllByRole = _render13.getAllByRole,
-        container = _render13.container;
+        getByRole = _render14.getByRole,
+        getAllByRole = _render14.getAllByRole,
+        container = _render14.container;
 
     var radioGroup = getByRole("radiogroup");
     var checkedRadio = getAllByRole("radio")[0];
@@ -423,7 +428,6 @@ describe("Radio Group component tests", function () {
       charCode: 13
     });
 
-    expect(onChange).toHaveBeenCalled();
     expect(onChange).toHaveBeenCalledWith("1");
     expect(checkedRadio.getAttribute("aria-checked")).toBe("true");
     expect(checkedRadio.tabIndex).toBe(0);
@@ -432,16 +436,16 @@ describe("Radio Group component tests", function () {
   test("The 'space' key checks the current focused option if anyone is checked", function () {
     var onChange = jest.fn();
 
-    var _render14 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_RadioGroup["default"], {
+    var _render15 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_RadioGroup["default"], {
       name: "test",
       label: "test-radio-group-label",
       helperText: "test-radio-group-helper-text",
       options: options,
       onChange: onChange
     })),
-        getByRole = _render14.getByRole,
-        getAllByRole = _render14.getAllByRole,
-        container = _render14.container;
+        getByRole = _render15.getByRole,
+        getAllByRole = _render15.getAllByRole,
+        container = _render15.container;
 
     var radioGroup = getByRole("radiogroup");
     var checkedRadio = getAllByRole("radio")[0];
@@ -454,7 +458,6 @@ describe("Radio Group component tests", function () {
       charCode: 32
     });
 
-    expect(onChange).toHaveBeenCalled();
     expect(onChange).toHaveBeenCalledWith("1");
     expect(checkedRadio.getAttribute("aria-checked")).toBe("true");
     expect(checkedRadio.tabIndex).toBe(0);
@@ -464,7 +467,7 @@ describe("Radio Group component tests", function () {
     var onChange = jest.fn();
     var onBlur = jest.fn();
 
-    var _render15 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_RadioGroup["default"], {
+    var _render16 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_RadioGroup["default"], {
       name: "test",
       label: "test-radio-group-label",
       helperText: "test-radio-group-helper-text",
@@ -472,9 +475,9 @@ describe("Radio Group component tests", function () {
       onChange: onChange,
       onBlur: onBlur
     })),
-        getByRole = _render15.getByRole,
-        getAllByRole = _render15.getAllByRole,
-        container = _render15.container;
+        getByRole = _render16.getByRole,
+        getAllByRole = _render16.getAllByRole,
+        container = _render16.container;
 
     var radioGroup = getByRole("radiogroup");
     var radios = getAllByRole("radio");
@@ -503,11 +506,11 @@ describe("Radio Group component tests", function () {
     expect(radios[1].tabIndex).toBe(0);
     expect(submitInput.value).toBe("2");
   });
-  test("The 'arrowDown' and 'arrowRight' keys move the selection to the next radio", function () {
+  test("The 'arrowDown' and 'arrowRight' keys move the selection to the next radio. When the last radio is reached, moves the selection to the first one", function () {
     var onChange = jest.fn();
     var onBlur = jest.fn();
 
-    var _render16 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_RadioGroup["default"], {
+    var _render17 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_RadioGroup["default"], {
       defaultValue: "8",
       name: "test",
       label: "test-radio-group-label",
@@ -516,9 +519,9 @@ describe("Radio Group component tests", function () {
       onChange: onChange,
       onBlur: onBlur
     })),
-        getByRole = _render16.getByRole,
-        getAllByRole = _render16.getAllByRole,
-        container = _render16.container;
+        getByRole = _render17.getByRole,
+        getAllByRole = _render17.getAllByRole,
+        container = _render17.container;
 
     var radioGroup = getByRole("radiogroup");
     var radios = getAllByRole("radio");
@@ -552,11 +555,11 @@ describe("Radio Group component tests", function () {
     expect(radios[0].tabIndex).toBe(0);
     expect(submitInput.value).toBe("1");
   });
-  test("The 'arrowUp' and 'arrowLeft' keys move the selection to the previous radio", function () {
+  test("The 'arrowUp' and 'arrowLeft' keys move the selection to the previous radio. When the first radio is reached, moves the selection to the last one", function () {
     var onChange = jest.fn();
     var onBlur = jest.fn();
 
-    var _render17 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_RadioGroup["default"], {
+    var _render18 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_RadioGroup["default"], {
       defaultValue: "2",
       name: "test",
       label: "test-radio-group-label",
@@ -565,9 +568,9 @@ describe("Radio Group component tests", function () {
       onChange: onChange,
       onBlur: onBlur
     })),
-        getByRole = _render17.getByRole,
-        getAllByRole = _render17.getAllByRole,
-        container = _render17.container;
+        getByRole = _render18.getByRole,
+        getAllByRole = _render18.getAllByRole,
+        container = _render18.container;
 
     var radioGroup = getByRole("radiogroup");
     var radios = getAllByRole("radio");
@@ -604,16 +607,16 @@ describe("Radio Group component tests", function () {
   test("Keyboard focus movement continues from the last radio input clicked", function () {
     var onChange = jest.fn();
 
-    var _render18 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_RadioGroup["default"], {
+    var _render19 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_RadioGroup["default"], {
       name: "test",
       label: "test-radio-group-label",
       helperText: "test-radio-group-helper-text",
       options: options,
       onChange: onChange
     })),
-        getByRole = _render18.getByRole,
-        getAllByRole = _render18.getAllByRole,
-        container = _render18.container;
+        getByRole = _render19.getByRole,
+        getAllByRole = _render19.getAllByRole,
+        container = _render19.container;
 
     var radioGroup = getByRole("radiogroup");
     var radios = getAllByRole("radio");
@@ -628,7 +631,6 @@ describe("Radio Group component tests", function () {
       charCode: 40
     });
 
-    expect(onChange).toHaveBeenCalled();
     expect(onChange).toHaveBeenCalledWith("5");
     expect(radios[4].getAttribute("aria-checked")).toBe("true");
     expect(document.activeElement).toEqual(radios[4]);
@@ -644,7 +646,6 @@ describe("Radio Group component tests", function () {
       charCode: 37
     });
 
-    expect(onChange).toHaveBeenCalled();
     expect(onChange).toHaveBeenCalledWith("8");
     expect(radios[7].getAttribute("aria-checked")).toBe("true");
     expect(document.activeElement).toEqual(radios[7]);
@@ -654,7 +655,7 @@ describe("Radio Group component tests", function () {
   test("Readonly radio group lets the user move the focus, but neither click nor keyboard press changes the value", function () {
     var onChange = jest.fn();
 
-    var _render19 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_RadioGroup["default"], {
+    var _render20 = (0, _react2.render)( /*#__PURE__*/_react["default"].createElement(_RadioGroup["default"], {
       name: "test",
       label: "test-radio-group-label",
       helperText: "test-radio-group-helper-text",
@@ -662,9 +663,9 @@ describe("Radio Group component tests", function () {
       onChange: onChange,
       readonly: true
     })),
-        getByRole = _render19.getByRole,
-        getAllByRole = _render19.getAllByRole,
-        container = _render19.container;
+        getByRole = _render20.getByRole,
+        getAllByRole = _render20.getAllByRole,
+        container = _render20.container;
 
     var radioGroup = getByRole("radiogroup");
     var radios = getAllByRole("radio");

package/radio-group/types.d.ts

@@ -1,29 +1,106 @@
 export declare type Option = {
+    /**
+     * Label of the option placed next to the radio input.
+     */
     value: string;
+    /**
+     * Value of the option. It should be unique and
+     * not an empty string, which is reserved to the optional item added
+     * by 'optional' prop.
+     */
     label: string;
+    /**
+     * If true, disables the option.
+     */
     disabled?: boolean;
 };
 declare type RadioGroupProps = {
+    /**
+     * Text to be placed above the radio group.
+     */
     label: string;
+    /**
+     * Name attribute of the input element. This attribute will allow users
+     * to find the component's value during the submit event.
+     */
     name?: string;
+    /**
+     * Helper text to be placed above the radio group.
+     */
     helperText?: string;
+    /**
+     * An array of objects representing the selectable options.
+     */
     options: Option[];
+    /**
+     * If true, the component will be disabled.
+     */
     disabled?: boolean;
+    /**
+     * If true, the radio group will be optional, showing
+     * (Optional) next to the label and adding a default last
+     * option with an empty string as value. Otherwise, the field will be
+     * considered required and an error will be passed as a parameter to the
+     * OnBlur functions if an option wasn't selected.
+     */
     optional?: boolean;
+    /**
+     * Label of the optional radio input.
+     */
     optionalItemLabel?: string;
+    /**
+     * If true, the component will be marked as readonly.
+     */
     readonly?: boolean;
+    /**
+     * Sets the orientation of the options within the radio group.
+     */
     stacking?: "row" | "column";
+    /**
+     * Initial value of the radio group, only when it is uncontrolled.
+     */
     defaultValue?: string;
+    /**
+     * Value of the radio group. If undefined, the component will be
+     * uncontrolled and the value will be managed internally by the
+     * component.
+     */
     value?: string;
+    /**
+     * This function will be called when the user chooses an option. The new
+     * value will be passed to this function.
+     */
     onChange?: (value: string) => void;
+    /**
+     * This function will be called when the radio group loses the focus. An
+     * object including the value and the error will be passed to this
+     * function. If there is no error, error will not be defined.
+     */
     onBlur?: (val: {
         value?: string;
         error?: string;
     }) => void;
+    /**
+     * If it is a defined value and also a truthy string, the component will
+     * change its appearance, showing the error below the radio group. If the
+     * defined value is an empty string, it will reserve a space below the
+     * component for a future error, but it would not change its look. In
+     * case of being undefined or null, both the appearance and the space for
+     * the error message would not be modified.
+     */
     error?: string;
+    /**
+     * Value of the tabindex attribute.
+     */
     tabIndex?: number;
 };
+/**
+ * Reference to the component.
+ */
 export declare type RefType = HTMLDivElement;
+/**
+ * Single radio prop types.
+ */
 export declare type RadioProps = {
     option: Option;
     currentValue?: string;