feat(Radio): deprecate readOnly prop. Use disabled instead

kiwicom · Oct 22, 2024 · e9327f4 · e9327f4
1 parent 1101cf2
commit e9327f4
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 16 deletions.
diff --git a/packages/orbit-components/src/Radio/README.md b/packages/orbit-components/src/Radio/README.md
@@ -32,7 +32,6 @@ Table below contains all types of the props available in Radio component.
 | tabIndex       | `string \| number`         |         | Specifies the tab order of an element                                                                     |
 | tooltip        | `Element<Tooltip>`         |         | Optional property when you need to attach Tooltip to the Radio. [See Functional specs](#functional-specs) |
 | value          | `string`                   |         | The value of the Radio.                                                                                   |
-| readOnly       | `boolean`                  |         | If `true`, the Radio will be set up as readOnly.                                                          |
 
 ## Functional specs
 

diff --git a/packages/orbit-components/src/Radio/Radio.stories.tsx b/packages/orbit-components/src/Radio/Radio.stories.tsx
@@ -28,7 +28,6 @@ const meta: Meta<typeof Radio> = {
     checked: false,
     disabled: false,
     hasError: false,
-    readOnly: false,
     tabIndex: 0,
     onChange: action("changed"),
   },
@@ -73,7 +72,7 @@ export const WithError: Story = {
   parameters: {
     info: "Error state of Radio component. Check Orbit.Kiwi for more detailed guidelines.",
     controls: {
-      exclude: ["disabled", "readOnly", "onChange", "tabIndex"],
+      exclude: ["disabled", "onChange", "tabIndex"],
     },
   },
 };
@@ -93,7 +92,7 @@ export const WithTextLinkInLabel: Story = {
 
   parameters: {
     controls: {
-      exclude: ["onChange", "hasError", "disabled", "label", "readOnly", "tabIndex"],
+      exclude: ["onChange", "hasError", "disabled", "label", "tabIndex"],
     },
   },
 };
@@ -108,18 +107,6 @@ export const WithTooltip: Story = {
     />
   ),
 
-  parameters: {
-    controls: {
-      exclude: ["onChange", "hasError", "disabled", "readOnly", "tabIndex"],
-    },
-  },
-};
-
-export const ReadOnly: Story = {
-  args: {
-    readOnly: true,
-  },
-
   parameters: {
     controls: {
       exclude: ["onChange", "hasError", "disabled", "tabIndex"],

diff --git a/packages/orbit-components/src/Radio/types.d.ts b/packages/orbit-components/src/Radio/types.d.ts
@@ -16,6 +16,9 @@ export interface Props extends Common.Globals {
   readonly defaultChecked?: boolean;
   readonly info?: React.ReactNode;
   readonly tooltip?: React.ReactElement<typeof Tooltip>;
+  /**
+   * @deprecated Radio does not support `readOnly` prop. Use `disabled` instead.
+   */
   readonly readOnly?: boolean;
   readonly tabIndex?: string | number;
   // InputEvent