Number Input

<cs-number-input>

Stable

Since 0.1

Number inputs let users enter and edit numeric values, with optional stepper buttons for incrementing and decrementing. Use them for quantities, measurements, and other numeric form fields.

<cs-number-input label="Quantity" value="1"></cs-number-input>

<cs-number-input label="Tickets" hint="How many would you like?" value="2">
  <cs-icon slot="start" name="confirmation_number" variant="fill"></cs-icon>
</cs-number-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-number-input label="How many items?"></cs-number-input>

Hint

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

<cs-number-input
  label="Order quantity"
  hint="Enter the number of items you'd like to order"
></cs-number-input>

Placeholder

Use the placeholder attribute to add a placeholder.

<cs-number-input placeholder="Enter a number"></cs-number-input>

Appearance

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

<div class="cs-stack">
  <cs-number-input label="Outlined" appearance="outlined" value="42"></cs-number-input>
  <cs-number-input label="Filled" appearance="filled" value="42"></cs-number-input>
  <cs-number-input
    label="Filled Outlined"
    appearance="filled-outlined"
    value="42"
  ></cs-number-input>
</div>

Disabled

Use the disabled attribute to disable an input.

<cs-number-input label="Disabled" value="100" disabled></cs-number-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-number-input label="Readonly" value="42" readonly></cs-number-input>

Size

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

<div class="cs-stack">
  <cs-number-input label="Extra Small" size="xs" value="5"></cs-number-input>
  <cs-number-input label="Small" size="s" value="10"></cs-number-input>
  <cs-number-input label="Medium" size="m" value="20"></cs-number-input>
  <cs-number-input label="Large" size="l" value="30"></cs-number-input>
  <cs-number-input label="Extra Large" size="xl" value="40"></cs-number-input>
</div>

Pill

Use the pill attribute to give inputs rounded edges.

<cs-number-input label="Quantity" pill value="5"></cs-number-input>

Min, Max & Step

Use the min and max attributes to set a minimum and maximum value. Use the step attribute to change the granularity the value must adhere to when using the stepper buttons or arrow keys.

<cs-number-input
  label="Donation amount"
  hint="Amount in dollars (10-100, increments of 5)"
  min="10"
  max="100"
  step="5"
  value="25"
></cs-number-input>

Hiding the Steppers

Add the without-steppers attribute to remove the increment and decrement buttons.

<cs-number-input label="No steppers" value="50" without-steppers></cs-number-input>

The keyboard still works.
With the steppers hidden, the arrow keys can still increment and decrement the value.

Custom Stepper Icons

Use the increment-icon and decrement-icon slots to replace the default stepper button icons.

<cs-number-input label="Custom icons" value="5">
  <cs-icon slot="increment-icon" name="add"></cs-icon>
  <cs-icon slot="decrement-icon" name="remove"></cs-icon>
</cs-number-input>

Start & End Decorations

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

<div class="cs-stack">
  <cs-number-input label="Price" value="100">
    <cs-icon slot="start" name="attach_money"></cs-icon>
  </cs-number-input>
  <cs-number-input label="Quantity" value="3">
    <cs-icon slot="end" name="shopping_cart"></cs-icon>
  </cs-number-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-number-input label="Quantity" hint="How many do you need?" value="1"></cs-number-input>
  <cs-number-input label="Price" hint="Cost per unit" value="25"></cs-number-input>
</div>

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

    cs-number-input {
      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>

Validation

Use the required attribute to make the field required. Combine with min and max for range validation.

  
  Submit
  Reset

<form class="number-input-validation">
  <cs-number-input
    name="quantity"
    label="Quantity"
    hint="Enter a value between 1 and 10"
    min="1"
    max="10"
    required
  ></cs-number-input>
  <br />
  <cs-number-input
    name="price"
    label="Price"
    hint="Must be a multiple of 0.25"
    min="0"
    step="0.25"
    required
  ></cs-number-input>
  <br />
  <cs-button appearance="filled" type="submit" variant="neutral">Submit</cs-button>
  <cs-button appearance="filled" type="reset" variant="neutral">Reset</cs-button>
</form>

<script type="module">
  const form = document.querySelector('.number-input-validation');

  form.addEventListener('submit', event => {
    event.preventDefault();

    // Log data to the console for the demo
    console.log(...new FormData(form));
  });
</script>

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/number-input/number-input.js';

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

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

Slots

Learn more about using slots.

Name	Description
`decrement-icon`	An icon to use in lieu of the default decrement icon.
`end`	An element, such as `<cs-icon>`, placed at the end of the input control (before steppers).
`hint`	Text that describes how to use the input. Alternatively, you can use the `hint` attribute.
`increment-icon`	An icon to use in lieu of the default increment icon.
`label`	The input's label. Alternatively, you can use the `label` attribute.
`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
`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`	—	—
`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.	`'numeric' \| 'decimal'`	`'numeric'`	—
`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.	`number`	—	—
`min`	`min`	The input's minimum value.	`number`	—	—
`name`	`name`	The name of the input, submitted as a name/value pair with form data.	`string \| null`	`null`	Yes
`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
`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.	`number \| 'any'`	`1`	—
`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.	—	—	—
`withoutSteppers`	`without-steppers`	Hides the increment/decrement stepper buttons.	`boolean`	`false`	—

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`
`stepDown()`	Decrements the value by the step amount.	—
`stepUp()`	Increments the value by the step amount.	—

Events

Learn more about events.

Name	Description
`beforeinput`	Emitted before the value changes. Can be cancelled with `event.preventDefault()` to prevent the value from changing.
`blur`	Emitted when the control loses focus.
`change`	Emitted when an alteration to the control's value is committed by the user.
`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)`
`focused`	The input has focus.	`:state(focused)`

CSS Parts

Learn more about CSS parts.

Name	Description	CSS selector
`end`	The container that wraps the `end` slot.	`::part(end)`
`form-control-label`	The label.	`::part(form-control-label)`
`hint`	The hint element.	`::part(hint)`
`input`	The internal `<input>` control.	`::part(input)`
`number-input`	The component's outer wrapper.	`::part(number-input)`
`start`	The container that wraps the `start` slot.	`::part(start)`
`stepper`	Both stepper buttons (for shared styling).	`::part(stepper)`
`stepper-decrement`	The decrement (-) button on the start side.	`::part(stepper-decrement)`
`stepper-increment`	The increment (+) button on the end side.	`::part(stepper-increment)`

Dependencies

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

<cs-icon>

Quick Links

Recent Searches