Skip to content

Commit

Permalink
attempting to get InputField docs to build
Browse files Browse the repository at this point in the history
  • Loading branch information
mperrotti committed Dec 16, 2021
1 parent 5c56710 commit b42dc39
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/content/InputField.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,7 @@ render(ValidationExample)

The container that handles the layout and passes the relevant IDs and ARIA attributes it's children.

<!--
<PropsTable>
<PropsTable.Row
name="children"
Expand Down Expand Up @@ -167,11 +168,13 @@ The container that handles the layout and passes the relevant IDs and ARIA attri
/>
<PropsTable.Row name="validationResult" type="string" description="The key of the validation message to show " />
</PropsTable>
-->

### InputField.Label

A `InputField.Label` must be passed for the field to be accessible to assistive technology, but it may be visually hidden.

<!--
<PropsTable>
<PropsTable.Row
name="boolean"
Expand All @@ -180,23 +183,27 @@ A `InputField.Label` must be passed for the field to be accessible to assistive
description="Whether the label should be visually hidden"
/>
</PropsTable>
-->

### InputField.Caption

`InputField.Caption` may be used to render hint text for fields that require additional context.

<!--
<PropsTable>
<PropsTable.Row
name="children"
type="React.ReactNode"
description="The content (usually just text) that is rendered to give contextual info about the field"
/>
</PropsTable>
-->

### InputField.Validation

`InputField.Validation` may be used to render contextual validation information if the field was flagged during validation.

<!--
<PropsTable>
<PropsTable.Row
name="children"
Expand All @@ -209,6 +216,7 @@ A `InputField.Label` must be passed for the field to be accessible to assistive
description="The key of the property from `InputField` that corresponds to this validation message. When `InputField`'s `validationResult` prop matches `InputField.Validation`'s `validationKey` prop, this message is shown."
/>
</PropsTable>
-->

## Component status

Expand Down

0 comments on commit b42dc39

Please sign in to comment.