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

kiwicom · Oct 21, 2024 · e9952b0 · e9952b0
1 parent b840686
commit e9952b0
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 12 deletions.
diff --git a/packages/orbit-components/src/Checkbox/Checkbox.stories.tsx b/packages/orbit-components/src/Checkbox/Checkbox.stories.tsx
@@ -27,7 +27,6 @@ const meta: Meta<typeof Checkbox> = {
     checked: false,
     hasError: false,
     disabled: false,
-    readOnly: false,
     name: "name",
     onChange: action("onChange"),
   },
@@ -41,7 +40,7 @@ export const Default: Story = {
   parameters: {
     info: "Checkbox needs only label and onChange by default.",
     controls: {
-      exclude: ["info", "hasError", "disabled", "readOnly", "name", "value", "onChange"],
+      exclude: ["info", "hasError", "disabled", "name", "value", "onChange"],
     },
   },
 
@@ -126,16 +125,6 @@ export const WithTooltip: Story = {
   },
 };
 
-export const ReadOnly: Story = {
-  args: {
-    readOnly: true,
-  },
-
-  parameters: {
-    info: "This is a preview of this component in read-only state.",
-  },
-};
-
 export const Rtl: Story = {
   render: args => (
     <RenderInRtl>

diff --git a/packages/orbit-components/src/Checkbox/types.d.ts b/packages/orbit-components/src/Checkbox/types.d.ts
@@ -15,6 +15,9 @@ export interface Props extends Common.Globals {
   readonly name?: string;
   readonly info?: React.ReactNode;
   readonly tabIndex?: string | number;
+  /**
+   * @deprecated Radio does not support `readOnly` prop. Use `disabled` instead.
+   */
   readonly readOnly?: boolean;
   readonly tooltip?: React.ReactNode | null;
   // Should be InputEvent type