Skip to content

[carbon-components-react] Checkbox accepts a ref #56414

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
typescript-bot merged 2 commits into from
Oct 11, 2021
Merged

[carbon-components-react] Checkbox accepts a ref #56414

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
46b3a46
Current behavior for `Checkbox#ref`
eps1lon Oct 10, 2021
1fb3d37
[carbon-components-react] `Checkbox` accepts a `ref`
eps1lon Oct 10, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions types/carbon-components-react/carbon-components-react-tests.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import {
AccordionItem,
AspectRatio,
Button,
Checkbox,
CodeSnippet,
CodeSnippetType,
Column,
Expand Down Expand Up @@ -1191,3 +1192,15 @@ const dataTableSkeletonBasic = (
</Dialog>
);
}

//
// Checkbox
//
{
const inputRef = React.createRef<HTMLInputElement>();
<Checkbox
id=""
labelText=""
ref={inputRef}
/>;
}
4 changes: 2 additions & 2 deletions types/carbon-components-react/lib/components/Checkbox/Checkbox.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import * as React from "react";
import { ReactInputAttr } from "../../../typings/shared";
import { ForwardRefReturn, ReactInputAttr } from "../../../typings/shared";

type ExcludedAttributes = "id" | "onChange" | "type";

Expand All @@ -20,6 +20,6 @@ export interface CheckboxProps extends Omit<ReactInputAttr, ExcludedAttributes>
wrapperClassName?: string | undefined,
}

declare const Checkbox: React.RefForwardingComponent<HTMLInputElement, CheckboxProps>;
declare const Checkbox: ForwardRefReturn<HTMLInputElement, CheckboxProps>;

export default Checkbox;