Input

<cs-input>

Stable

Since 0.1

Inputs collect single-line data from the user, such as text, numbers, email addresses, and passwords. They support labels, hints, validation, and prefix or suffix slots.

<cs-input label="Name"></cs-input>

<cs-input type="password" label="Password" hint="Must be at least 8 characters." value="correcthorse">
  <cs-icon slot="start" name="lock"></cs-icon>
</cs-input>

This component works with standard <form> elements. See form controls for form submission and client-side validation.

Examples

Label

Use the label attribute to give the input an accessible label. For labels that contain HTML, use the label slot instead.

<cs-input label="What is your name?"></cs-input>

Hint

Add descriptive hint to an input with the hint attribute. For hints that contain HTML, use the hint slot instead.

<cs-input label="Nickname" hint="What would you like people to call you?"></cs-input>

Placeholder

Use the placeholder attribute to add a placeholder.

<cs-input label="Search" placeholder="Search the docs"></cs-input>

Clearable

Add the with-clear attribute to add a clear button when the input has content.

<cs-input placeholder="Clearable" with-clear></cs-input>

Toggle Password

Add the password-toggle attribute to add a toggle button that will show the password when activated.

<cs-input type="password" placeholder="Password Toggle" password-toggle></cs-input>

Appearance

Use the appearance attribute to change the input’s visual appearance.

<div class="cs-stack">
  <cs-input appearance="outlined" placeholder="outlined"></cs-input>
  <cs-input appearance="filled" placeholder="filled"></cs-input>
  <cs-input appearance="filled-outlined" placeholder="filled-outlined"></cs-input>
</div>

Disabled

Use the disabled attribute to disable an input.

<cs-input placeholder="Disabled" disabled></cs-input>

Readonly

Use the readonly attribute to keep a value visible but uneditable. Unlike disabled, a readonly input stays focusable and its value is still submitted with the form.

<cs-input label="Account ID" value="CS-2049" readonly></cs-input>

Size

Use the size attribute to change an input’s size.

<div class="cs-stack">
  <cs-input size="xs" placeholder="Extra small"></cs-input>
  <cs-input size="s" placeholder="Small"></cs-input>
  <cs-input size="m" placeholder="Medium"></cs-input>
  <cs-input size="l" placeholder="Large"></cs-input>
  <cs-input size="xl" placeholder="Extra large"></cs-input>
</div>

Pill

Use the pill attribute to give inputs rounded edges.

<cs-input placeholder="Search" pill></cs-input>

Input Types

The type attribute controls the type of input the browser renders.

<div class="cs-stack">
  <cs-input type="email" placeholder="Email"></cs-input>
  <cs-input type="number" placeholder="Number"></cs-input>
  <cs-input type="date" placeholder="Date"></cs-input>
</div>

Start & End Decorations

Use the start and end slots to add presentational elements like <cs-icon> within the input.

<div class="cs-stack">
  <cs-input label="Search" placeholder="Search the docs">
    <cs-icon name="search" slot="start"></cs-icon>
  </cs-input>
  <cs-input label="Website" placeholder="example.com">
    <cs-icon name="public" slot="start"></cs-icon>
    <cs-icon name="info" slot="end" variant="fill"></cs-icon>
  </cs-input>
</div>

Customizing Label Position

Use CSS parts to customize the way form controls are drawn. This example uses CSS grid to position the label to the left of the control, but the possible orientations are nearly endless. The same technique works for inputs, textareas, radio groups, and similar form controls.

<div class="label-on-left">
  <cs-input label="Name" hint="Enter your name"></cs-input>
  <cs-input label="Email" type="email" hint="Enter your email"></cs-input>
  <cs-textarea label="Bio" hint="Tell us something about yourself"></cs-textarea>
</div>

<style>
  .label-on-left {
    display: grid;
    grid-template-columns: auto 1fr;
    gap: var(--cs-space-l);
    align-items: center;

    cs-input,
    cs-textarea {
      grid-column: 1 / -1;
      grid-row-end: span 2;
      display: grid;
      grid-template-columns: subgrid;
      gap: 0 var(--cs-space-l);
      align-items: center;
    }

    ::part(form-control-label) {
      text-align: right;
    }

    ::part(hint) {
      grid-column: 2;
    }
  }
</style>

API

Importing

If you're using the autoloader or a hosted project, components load on demand — no manual import needed. To cherry-pick this component, use one of the following snippets.

npm

Self-Hosted

React

import '@cruglobal/cornerstone-components/components/input/input.js';

import './cornerstone/components/input/input.js';

import CsInput from '@cruglobal/cornerstone-components/react/input/index.js';

Slots

Learn more about using slots.

Name	Description
`clear-icon`	An icon to use in lieu of the default clear icon.
`end`	An element, such as `<cs-icon>`, placed at the end of the input control.
`hide-password-icon`	An icon to use in lieu of the default hide password icon.
`hint`	Text that describes how to use the input. Alternatively, you can use the `hint` attribute.
`label`	The input's label. Alternatively, you can use the `label` attribute.
`show-password-icon`	An icon to use in lieu of the default show password icon.
`start`	An element, such as `<cs-icon>`, placed at the start of the input control.

Attributes & Properties

Learn more about attributes and properties.

Property	Attribute	Description	Type	Default	Reflects
`appearance`	`appearance`	The input's visual appearance.	`'filled' \| 'outlined' \| 'filled-outlined'`	`'outlined'`	Yes
`autocapitalize`	`autocapitalize`	Controls whether and how text input is automatically capitalized as it is entered by the user.	`'off' \| 'none' \| 'on' \| 'sentences' \| 'words' \| 'characters'`	—	—
`autocomplete`	`autocomplete`	Specifies what permission the browser has to provide assistance in filling out form field values. Refer to this page on MDN for available values.	`string`	—	—
`autocorrect`	`autocorrect`	Indicates whether the browser's autocorrect feature is on or off. When set as an attribute, use `"off"` or `"on"`. When set as a property, use `true` or `false`.	`boolean`	—	—
`autofocus`	`autofocus`	Indicates that the input should receive focus on page load.	`boolean`	—	—
`defaultValue`	`value`	The default value of the form control. Primarily used for resetting the form control.	`string \| null`	—	Yes
`disabled`	`disabled`	Disables the form control.	`boolean`	`false`	—
`enterkeyhint`	`enterkeyhint`	Used to customize the label or icon of the Enter key on virtual keyboards.	`'enter' \| 'done' \| 'go' \| 'next' \| 'previous' \| 'search' \| 'send'`	—	—
`form`	—	By default, form controls are associated with the nearest containing `<form>` element. This attribute allows you to place the form control outside of a form and associate it with the form that has this `id`. The form must be in the same document or shadow root for this to work.	`HTMLFormElement \| null`	—	—
`hint`	`hint`	The input's hint. If you need to display HTML, use the `hint` slot instead.	`string`	`''`	—
`inputmode`	`inputmode`	Tells the browser what type of data will be entered by the user, allowing it to display the appropriate virtual keyboard on supportive devices.	`'none' \| 'text' \| 'decimal' \| 'numeric' \| 'tel' \| 'search' \| 'email' \| 'url'`	—	—
`label`	`label`	The input's label. If you need to display HTML, use the `label` slot instead.	`string`	`''`	—
`max`	`max`	The input's maximum value. Only applies to date and number input types.	`number \| string`	—	—
`maxlength`	`maxlength`	The maximum length of input that will be considered valid.	`number`	—	—
`min`	`min`	The input's minimum value. Only applies to date and number input types.	`number \| string`	—	—
`minlength`	`minlength`	The minimum length of input that will be considered valid.	`number`	—	—
`name`	`name`	The name of the input, submitted as a name/value pair with form data.	`string \| null`	`null`	Yes
`passwordToggle`	`password-toggle`	Adds a button to toggle the password's visibility. Only applies to password types.	`boolean`	`false`	—
`passwordVisible`	`password-visible`	Determines whether or not the password is currently visible. Only applies to password input types.	`boolean`	`false`	—
`pattern`	`pattern`	A regular expression pattern to validate input against.	`string`	—	—
`pill`	`pill`	Draws a pill-style input with rounded edges.	`boolean`	`false`	Yes
`placeholder`	`placeholder`	Placeholder text to show as a hint when the input is empty.	`string`	`''`	—
`readonly`	`readonly`	Makes the input readonly.	`boolean`	`false`	Yes
`required`	`required`	Makes the input a required field.	`boolean`	`false`	Yes
`size`	`size`	The input's size.	`'xs' \| 's' \| 'm' \| 'l' \| 'xl'`	`'m'`	Yes
`spellcheck`	`spellcheck`	Enables spell checking on the input.	`boolean`	`true`	—
`ssrHint`	`ssr-hint`	Only required for SSR. Set to `true` if you're slotting in a `hint` element so the server-rendered markup includes the hint before the component hydrates on the client.	`boolean`	`false`	—
`ssrLabel`	`ssr-label`	Only required for SSR. Set to `true` if you're slotting in a `label` element so the server-rendered markup includes the label before the component hydrates on the client.	`boolean`	`false`	—
`step`	`step`	Specifies the granularity that the value must adhere to, or the special value `any` which means no stepping is implied, allowing any numeric value. Only applies to date and number input types.	`number \| 'any'`	—	—
`type`	`type`	The type of input. Works the same as a native `<input>` element, but only a subset of types are supported. Defaults to `text`.	`'date' \| 'datetime-local' \| 'email' \| 'number' \| 'password' \| 'search' \| 'tel' \| 'text' \| 'time' \| 'url'`	`'text'`	Yes
`validationTarget`	—	Override this to change where constraint validation popups are anchored.	`undefined \| HTMLElement`	—	—
`validators`	—	Validators are static because they have `observedAttributes`, essentially attributes to "watch" for changes. Whenever these attributes change, we want to be notified and update the validator.	`Validator[]`	`[]`	—
`value`	—	The current value of the input, submitted as a name/value pair with form data.	—	—	—
`withClear`	`with-clear`	Adds a clear button when the input is not empty.	`boolean`	`false`	—
`withoutSpinButtons`	`without-spin-buttons`	Hides the browser's built-in increment/decrement spin buttons for number inputs.	`boolean`	`false`	Yes

Methods

Learn more about methods.

Name	Description	Arguments
`blur()`	Removes focus from the input.	—
`focus()`	Sets focus on the input.	`options: FocusOptions`
`formStateRestoreCallback()`	Called when the browser is trying to restore element’s state to state in which case reason is "restore", or when the browser is trying to fulfill autofill on behalf of user in which case reason is "autocomplete". In the case of "restore", state is a string, File, or FormData object previously set as the second argument to setFormValue.	`state: string \| File \| FormData \| null, reason: 'autocomplete' \| 'restore'`
`resetValidity()`	Reset validity is a way of removing manual custom errors and native validation.	—
`select()`	Selects all the text in the input.	—
`setCustomValidity()`	Do not use this when creating a "Validator". This is intended for end users of components. We track manually defined custom errors so we don't clear them on accident in our validators.	`message: string`
`setRangeText()`	Replaces a range of text with a new string.	`replacement: string, start: number, end: number, selectMode: 'select' \| 'start' \| 'end' \| 'preserve'`
`setSelectionRange()`	Sets the start and end positions of the text selection (0-based).	`selectionStart: number, selectionEnd: number, selectionDirection: 'forward' \| 'backward' \| 'none'`
`showPicker()`	Displays the browser picker for an input element (only works if the browser supports it for the input type).	—
`stepDown()`	Decrements the value of a numeric input type by the value of the step attribute.	—
`stepUp()`	Increments the value of a numeric input type by the value of the step attribute.	—

Events

Learn more about events.

Name	Description
`blur`	Emitted when the control loses focus.
`change`	Emitted when an alteration to the control's value is committed by the user.
`cs-clear`	Emitted when the clear button is activated.
`cs-invalid`	Emitted when the form control has been checked for validity and its constraints aren't satisfied.
`focus`	Emitted when the control gains focus.
`input`	Emitted when the control receives input.

Custom States

Learn more about custom states.

Name	Description	CSS selector
`blank`	The input is empty.	`:state(blank)`

CSS Parts

Learn more about CSS parts.

Name	Description	CSS selector
`clear-button`	The clear button.	`::part(clear-button)`
`end`	The container that wraps the `end` slot.	`::part(end)`
`form-control-label`	The label.	`::part(form-control-label)`
`hint`	The hint's wrapper.	`::part(hint)`
`input`	The internal `<input>` control.	`::part(input)`
`input-wrapper`	The component's outer wrapper.	`::part(input-wrapper)`
`password-toggle-button`	The password toggle button.	`::part(password-toggle-button)`
`start`	The container that wraps the `start` slot.	`::part(start)`

Dependencies

This component automatically imports the following elements. Sub-dependencies, if any exist, are included in this list.

<cs-icon>

Quick Links

Recent Searches