Skip to content

Fixes TextInput component types #3197

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
merged 4 commits into from
Oct 13, 2025
Merged

Fixes TextInput component types #3197

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d86abee
fix text input
bruugey Oct 8, 2025
73b11e4
runs fix
bruugey Oct 8, 2025
b0282aa
fix mistake
bruugey Oct 8, 2025
1ee7daa
reset file
bruugey Oct 8, 2025
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
5 changes: 5 additions & 0 deletions .changeset/eleven-cars-obey.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@leafygreen-ui/text-input': patch
---

Fixes props such that component now accepts a properly typed `ref`
2 changes: 1 addition & 1 deletion packages/emotion/src/version.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
export const VERSION = '5.0.2';
export const VERSION = '5.0.3';
11 changes: 8 additions & 3 deletions packages/text-area/src/TextArea/TextArea.spec.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,9 +182,14 @@ describe('packages/text-area', () => {
});
});

/* eslint-disable jest/no-disabled-tests */
describe.skip('types behave as expected', () => {
test('TextArea throws error when neither aria-labelledby or label is supplied', () => {
describe('types behave as expected', () => {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Curious why the skip was moved here and removed entirely from packages/text-input/src/TextInput/TextInput.spec.tsx. Seems inconsistent and perhaps a mistake?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Technically should still be skipped, since there's no expect statement

test('TextArea takes a ref for a HTMLTextAreaElement', () => {
const ref = React.createRef<HTMLTextAreaElement>();
render(<TextArea label="Some label" ref={ref} />);
});

/* eslint-disable jest/no-disabled-tests */
test.skip('TextArea throws error when neither aria-labelledby or label is supplied', () => {
// @ts-expect-error
<TextArea />;
<TextArea label="Some label" />;
Expand Down
9 changes: 6 additions & 3 deletions packages/text-input/src/TextInput/TextInput.spec.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,8 +228,12 @@ describe('packages/text-input', () => {
});
});

/* eslint-disable jest/no-disabled-tests */
describe.skip('types behave as expected', () => {
describe('types behave as expected', () => {
test('TextInput takes a ref for a HTMLInputElement', () => {
const ref = React.createRef<HTMLInputElement>();
render(<TextInput label="some label" ref={ref} />);
});

test('TextInput throws error when no label is supplied', () => {
// @ts-expect-error
<TextInput />;
Expand All @@ -246,5 +250,4 @@ describe('packages/text-input', () => {
<TextInput type="search" aria-labelledby="some label" />;
});
});
/* eslint-enable jest/no-disabled-tests */
});
2 changes: 1 addition & 1 deletion packages/text-input/src/TextInput/TextInput.types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ interface TextInputTypeProp {
type?: TextInputType;
}
export interface BaseTextInputProps
extends Omit<React.ComponentPropsWithoutRef<'input'>, AriaLabels>,
extends Omit<React.ComponentPropsWithRef<'input'>, AriaLabels>,
DarkModeProps,
LgIdProps {
/**
Expand Down
Loading