Input
<gcds-input>

Also called: text input, input field.

An input is a space to enter short-form information in response to a question or instruction.

• GitHub
• Figma

Build an input

Use an input to ask for information short, one-line response.

Coding and accessibility for inputs

Apply required attributes

For the input to function properly, always use the following attributes with <gcds-input>:

• name
• label
• input-id

Size inputs to fit response type

• Set the size attribute of the input for responses you know have a specific length (size "50" = 50 characters). For example, 6 characters for a postal code or 10 characters for a phone number.
• Set the input to span almost the entire container, like at 90%, when you're unsure of the character count of the response.
• Use the maximum 75 characters for responses without a fixed length.

Handle error messages and validation

• Use the required attribute to activate the required validator. Validation will happen by default on the onBlur event. A missing or invalid entry will prompt an inline error message with preset text.

• If you need to change the validation event, use the validate-on attribute. Validation can happen on blur, when the element loses focus, or manually with the validate() method.

• Use the required attribute for fields that must be filled in. This places "required" at the end of the label.

• Use the error-message attribute to include an error message text for all required inputs. Avoid using error messages for optional ones.

• For optional fields, avoid adding the error-message attribute.

• For an optional field that needs validation based on user input (like validating an email address format), opt to add custom validation with a custom error message.

Include a hint text for task success

• Use the hint attribute to add hint text to help a person provide a complete value in the input and avoid an error state.

• Avoid adding hint text in the field (sometimes called placeholder text) where it will disappear once the field is selected or a response starts to be entered.

Use the inputmode attribute

• Use the inputmode attribute to suggest an appropriate virtual keyboard on mobile devices, without changing how the value is validated.
• Use inputmode=”numeric” with type=”text” for non-incremental numbers, such as account numbers, credit card numbers, or authentication codes. This will open the numeric keyboard on mobile devices.

Hide the input label

• Set the hide-label attribute to true to visually hide the label while maintaining it for assistive technologies.
• Avoid adding hint text when you’re hiding the label or else provide an empty hint string.

Get your code

Generate an instance of the component you need by selecting its code properties.

1. Explore by choosing different code values to generate the instance you want.

2. Get the code and pull it into your environment.

3. Add any copy you need to the component (like text for a label).

Note: The code builder uses English for all code elements, which follows standard practice.