terra-form-input

[mjhenkes]

terra-form-input

Known Aliases

Document any known aliases of the component, decide if another name makes more sense.

• Has known aliases
  • text-input
  • numeric-stepper
• Requires name change

Design Standard Doc

Any documentation needed to be added to terra-ui describing the make up and usage of the component
Any doc examples that need to be updated?

• Missing design standard documentation.

Guides

Any guides needed to be added to terra-ui describing the usage of this component when used with other components.

• Missing Guides

• Missing UX recommended Usage.

• Deprecation guide

Accessibility Guides

• Missing Accessibility Guides

Behaviours

• Missing behaviours
  • optionally disable autocomplete
  • remove placeholder
  • Needs a custom form field that handles 'character count'
• Contains bad practice behaviours that should be removed
  • Question: Consumers can get into a bad accessibility state without using form field or supplying their own label.

Accessibility

• Meets wcag 2.0 standards
• Meets wcag 2.1 standards

Deprecation

• Component is a bad pattern and should be deprecated.

Related Issues

Dependent on form field audit

Other Considerations

Site Restructuring:

• UX recommends that for the terra-form-input component, that the basic and standalone text input component: "Input" (e.g. import Input from 'terra-form-input';) should be moved/hidden from the default "Components" section on the Terra-UI docsite
• Instead, showcase the field composite version of the component: "InputField" (e.g. import InputField from 'terra-form-input/lib/InputField';) as the default export and what shows in the "Components" section on the Terra-UI docsite

The basic and standalone input component could be instead published under a new section for advanced component development or a "Building Blocks" type section, where raw components are shown together with explicit cautions that they should only be used when the consumer understands how to properly integrate it into higher-order components that have appropriate A11Y added and follow UX standards and expectations.

This consideration would also be true for all other Terra form components (e.g. terra-form-textarea, terra-form-checkbox, etc.) and similar form-like components (e.g. terra-date-input, terra-time-input, etc.).

[mjhenkes]

Re-organize terra form: #3195
Disable autocomplete: #2973
Remove placeholder: #2712