Skip to content

Commit 4ccdcd8

Browse files
authored
CRAFT-1895 -docs TextInputField (#658)
chore(docs): add textinputfield
1 parent ec84cf3 commit 4ccdcd8

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

packages/nimbus/src/patterns/fields/text-input-field/text-input-field.mdx

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: Patterns-TextInputField
33
title: TextInputField
4-
description: An input component that takes in a text as input
4+
description: This pattern component integrates the TextInput within a FormField using a simple, consistent, and opinionated API.
55
documentState: InitialDraft
66
order: 999
77
menu:
@@ -16,14 +16,17 @@ tags:
1616
- TextInputField
1717
---
1818

19-
# Text Input Field
19+
## Overview
2020

21-
A convenience component that integrates `TextInput` with `FormField` using a simplified API for common use cases.
21+
TextInputField is a pattern component that combines the FormField wrapper with the TextInput component. This integration provides a complete form field experience including accessible labels, helper text descriptions, info popovers for supplementary information, and comprehensive validation and error handling, all through a simplified, opinionated API.
2222

23-
## Overview
23+
### Resources
2424

25-
Adds accessible labels, descriptions, error messages, and help dialogs to a TextInput.
25+
For detailed guidance on the individual components that make up this pattern, consult the component guidelines:
2626

27+
- [TextInput Guidelines](/components/inputs/textinput) - Text input patterns, interaction guidelines, and accessibility standards
28+
- [FormField Guidelines](/components/inputs/formfield) - Label options, helper text, validation patterns, and form field accessibility
29+
- [Storybook](https://nimbus-storybook.vercel.app/?path=/docs/patterns-fields-textinputfield--docs)
2730

2831
## Props
2932

0 commit comments

Comments
 (0)