Skip to content

docs(text-input): Update TextInput README to reflect /testing import #3506

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
jetpacmonkey merged 1 commit into from
Feb 6, 2026
+12 −6
Merged

docs(text-input): Update TextInput README to reflect /testing import #3506

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 12 additions & 6 deletions packages/text-input/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,8 @@ Either `label` or `aria-labelledby` must be provided a string, or there will be
### Usage

```tsx
import TextInput, { getTestUtils } from '@leafygreen-ui/text-input';
import TextInput from '@leafygreen-ui/text-input';
import { getTestUtils } from '@leafygreen-ui/text-input/testing';

const utils = getTestUtils(lgId?: string); // lgId refers to the custom `data-lgid` attribute passed to `TextInput`. It defaults to 'lg-text_input' if left empty.
```
Expand All @@ -95,7 +96,8 @@ const utils = getTestUtils(lgId?: string); // lgId refers to the custom `data-lg

```tsx
import { render } from '@testing-library/react';
import TextInput, { getTestUtils } from '@leafygreen-ui/text-input';
import TextInput from '@leafygreen-ui/text-input';
import { getTestUtils } from '@leafygreen-ui/text-input/testing';

...

Expand All @@ -114,7 +116,8 @@ When testing multiple `TextInput`'s it is recommended to add the custom `data-lg

```tsx
import { render } from '@testing-library/react';
import TextInput, { getTestUtils } from '@leafygreen-ui/text-input';
import TextInput from '@leafygreen-ui/text-input';
import { getTestUtils } from '@leafygreen-ui/text-input/testing';

...

Expand Down Expand Up @@ -142,9 +145,12 @@ test('text-input', () => {

```tsx
import { render } from '@testing-library/react';
import Toggle, { getTestUtils as getToggleTestUtils } from '@leafygreen-ui/toggle';
import TextInput, { getTestUtils as getTextInputTestUtils } from '@leafygreen-ui/text-input';
import TextArea, { getTestUtils as getTextAreaTestUtils } from '@leafygreen-ui/text-area';
import Toggle from '@leafygreen-ui/toggle';
import { getTestUtils as getToggleTestUtils } from '@leafygreen-ui/toggle/testing';
import TextInput from '@leafygreen-ui/text-input';
import { getTestUtils as getTextInputTestUtils } from '@leafygreen-ui/text-input/testing';
import TextArea from '@leafygreen-ui/text-area';
import { getTestUtils as getTextAreaTestUtils } from '@leafygreen-ui/text-area/testing';

...

Expand Down
Loading