Input
Examples
Basic Input with Label
Help Text
Label with Tooltip
Label with Context Note
Placeholders
Clearable
Toggle Password
Disabled
Sizes
Pill
Input Types
Min Max Validation
Prefix & Suffix Icons
Prefix Submit Button
Customizing Label Position
Importing
Slots
Properties
Events
Methods
Parts
Dependencies

Input

<zn-input> | ZnInput

Since 1.0

experimental

Short summary of the component’s intended use.

Examples

Basic Input with Label

Use the label attribute to give the input an accessible label.

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

This component works with standard <form> elements. Please refer to the section on form controls to learn more about form submission and client-side validation.

Help Text

Add descriptive help text to an input with the help-text attribute. For help text that contains HTML, use the help-text slot instead.

List full names, separated by a semicolon

<zn-input label="Previous legal names" help-text="List full names, separated by a semicolon"></zn-input>
<br />
<zn-input label="Previous legal names">
  <div slot="help-text">List <strong>full</strong> names, separated by a <strong>semicolon</strong></div>
</zn-input>

Use the label-tooltip attribute to add text that appears in a tooltip triggered by an info icon next to the label.

Usage: Use a label tooltip to provide helpful but non-essential instructions or examples to guide people when filling in the input. Use help text to communicate instructions or requirements for filling in the input without errors.

<zn-input label="Previous legal names" label-tooltip="Names previously used on official government documents, such as passport, driver license, or ID card" help-text="List full names, separated by a semicolon"></zn-input>

Label with Context Note

Use the context-note attribute to add text that provides additional context or reference. For text that contains HTML, use the context-note slot. Note: On small screens the context note will wrap below the label if there isn’t enough room next to the label.

Usage: Use a context note to provide secondary contextual data, especially dynamic data, that would help people when filling in the input. Use help text to communicate instructions or requirements for filling in the input without errors.

$10,000.29 available

<zn-input type="currency" label="Amount" context-note="$10,000.29 available" help-text="You can transfer up to $2,500 per day"></zn-input>
<br />
<zn-input type="currency" label="Amount" help-text="You can transfer up to $2,500 per day">
  <div slot="context-note"><strong>$10,000.29</strong> available</div>
</zn-input>

Placeholders

Use the placeholder attribute to add a placeholder.

<zn-input placeholder="Type something"></zn-input>

Clearable

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

<zn-input label="Clearable input" value="I can be cleared!" clearable></zn-input>

Toggle Password

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

<zn-input type="password" label="Password" password-toggle></zn-input>

Disabled

Use the disabled attribute to disable an input.

<zn-input label="Disabled input" disabled></zn-input>

Sizes

Use the size attribute to change an input’s size. Size medium is the input’s default.

<zn-input label="small input" size="small"></zn-input>
<br />
<zn-input label="Medium input" size="medium"></zn-input>
<br />
<zn-input label="Large input" size="large"></zn-input>

Pill

Use the pill attribute to give inputs rounded edges.

Note: Pill inputs are not a standard input pattern in our Design System

<zn-input label="Medium pill" pill></zn-input>
<br />
<zn-input label="Large pill" size="large" pill></zn-input>

Input Types

The type attribute controls the type of input the browser renders. As shown in the examples below, some input types have default prefix and suffix elements. Not all available types are shown below. See the Properties table for the full list of options.

Has $ prefix and USD suffix by default and native input type set to number. The currency input does NOT have input masking at this time.

Has no icon by default

Use the optional-icon attribute to display the default optional icon for email inputs

Has no icon by default

Use the optional-icon attribute to display the default optional icon for phone number inputs

Use the no-spin-buttons attribute to hide the browser’s default increment/decrement buttons for number inputs

Has a search icon by default. Use the clearable attribute to make the input clearable

<zn-input type="currency" label="Input type: Currency"><div slot="help-text">Has <code>$</code> prefix and <code>USD</code> suffix by default and native input type set to <code>number</code>. The currency input does <strong>NOT</strong> have input masking at this time.</div></zn-input>
<br />
<zn-input type="date" label="Input type: Date" placeholder="Date" help-text="Calendar icon opens the browser default date picker"></zn-input>
<br />
<zn-input type="email" label="Input type: Email">
  <div slot="help-text">Has no icon by default</div>
</zn-input>
<br />
<zn-input type="email" label="Input type: Email, with icon" optional-icon>
  <div slot="help-text">Use the <code>optional-icon</code> attribute to display the default optional icon for email inputs </div>
</zn-input>
<br />
<zn-input type="tel" label="Input type: Tel">
  <div slot="help-text">Has no icon by default</div>
</zn-input>
<br />
<zn-input type="tel" label="Input type: Tel, with icon" optional-icon>
  <div slot="help-text">Use the <code>optional-icon</code> attribute to display the default optional icon for phone number inputs </div>
</zn-input>
<br />
<zn-input type="number" label="Input type: Number"></zn-input>
<br />
<zn-input type="number" label="Input type: Number, no spin buttons" no-spin-buttons>
    <div slot="help-text">Use the <code>no-spin-buttons</code> attribute to hide the browser's default increment/decrement buttons for number inputs</div>
</zn-input>
<br />
<zn-input type="search" label="Input type: Search" clearable><div slot="help-text">Has a search icon by default. Use the <code>clearable</code> attribute to make the input clearable</div></zn-input>
<br />

Min Max Validation

<zn-input type="date" label="Input type: Date" placeholder="Date" help-text="Calendar icon opens the browser default date picker" min="01/01/1970"></zn-input>
<br />
<zn-input type="number" label="Input type: Number" min="10" max="100"></zn-input>

Prefix & Suffix Icons

Several input types have specific prefix and suffix elements or icons that are displayed by default. You can also use the prefix and suffix slots to add icons or text elements for other use cases.

Follow these general guidelines when adding prefix and suffix icons to the input:

Use the zn-icon component
In general don’t resize icons or change their color from the default already set by the zn-input component

Note: If you find your use case requires a different size or color from the default, bring it up to the Design Team so that we can consider whether the pattern needs to be updated.

Note: ts_form_for doesn’t support slots. Prefix and suffix icons cannot be added when rendering zn-input with ts_form_for. However, the optional-icon attribute can be set to true to display default icons for input types currency, email, tel, and search.

<zn-input label="Prefix icon example: DO">
  <zn-icon src="rocket_launch" slot="prefix"></zn-icon>
</zn-input>
<br />
<br />
<zn-input label="Prefix icon example: RESIZED" help-text="Same icon as above, resized. Note that a larger prefix or suffix icon will push the input text out of alignment." value="Input text, shifted 4px right due to icon size">
  <zn-icon src="rocket_launch" style="--icon-size: 24px" slot="prefix"></zn-icon>
</zn-input>

Prefix Submit Button

Use the type="submit" attribute to create a submit button as a Suffix to the input. This is useful for search inputs.

<zn-input label="Search" placeholder="Search">
  <zn-button slot="suffix" type="submit" variant="primary">Search</zn-button>
</zn-input>

Or as a Prefix

<zn-input label="Search" placeholder="Search">
  <zn-button slot="prefix" type="submit" variant="primary">Search</zn-button>
</zn-input>

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.

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

<style>
  .label-on-left {
    --label-width: 3.75rem;
    --gap-width: 1rem;
  }

  .label-on-left + .label-on-left {
    margin-top: var(--zn-spacing-medium);
  }

  .label-on-left::part(form-control) {
    display: grid;
    grid: auto / var(--label-width) 1fr;
    gap: var(--zn-spacing-3x-small) var(--gap-width);
    align-items: center;
  }

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

  .label-on-left::part(form-control-help-text) {
    grid-column-start: 2;
  }
</style>

Importing

If you’re using the autoloader or the traditional loader, you can ignore this section. Otherwise, feel free to use any of the following snippets to cherry pick this component.

To import this component from the CDN using a script tag:

<script type="module" src="https://cdn.jsdelivr.net/npm/@kubex/zinc@1.0.0/dist/components/input/input.js"></script>

To import this component from the CDN using a JavaScript import:

import 'https://cdn.jsdelivr.net/npm/@kubex/zinc@1.0.0/dist/components/input/input.js';

To import this component using a bundler:

import '@kubex/zinc/dist/components/input/input.js';

Slots

Name	Description
`label`	The input’s label. Alternatively, you can use the `label` attribute.
`label-tooltip`	Used to add text that is displayed in a tooltip next to the label. Alternatively, you can use the `label-tooltip` attribute.
`context-note`	Used to add contextual text that is displayed above the input, on the right. Alternatively, you can use the `context-note` attribute.
`prefix`	Used to prepend a presentational icon or similar element to the input.
`suffix`	Used to append a presentational icon or similar element to the input.
`clear-icon`	An icon to use in lieu of the default clear icon.
`show-password-icon`	An icon to use in lieu of the default show password icon.
`hide-password-icon`	An icon to use in lieu of the default hide password icon.
`help-text`	Text that describes how to use the input. Alternatively, you can use the `help-text` attribute.

Learn more about using slots.

Properties

Name	Description	Type	Default
`type`	The type of input. Works the same as native `<input>` element. But only a subset of types is supported. Defaults to `text`	`'currency' \| 'date' \| 'datetime-local' \| 'email' \| 'number' \| 'password' \| 'search' \| 'tel' \| 'text' \| 'time' \| 'url'`	`'text'`
`name`	The name of the input, submitted as a name/value pair with form data.	`string`	`""`
`value`	The current value of the input, submitted as a name/value pair with form data.	`any`	`''`
`defaultValue`	The default value of the form control. Primarily used for resetting the form control.	`string`	`''`
`size`	The inputs size *	`'small' \| 'medium' \| 'large'`	`'medium'`
`pill`	Draws a pill-styled input *	`boolean`	`false`
`label`	The inputs label. If you need to display HTML, use the `label` slot. *	`string`	`''`
`labelTooltip` `label-tooltip`	Text that appears in a tooltip next to the label. If you need to display HTML in the tooltip, use the `label-tooltip` slot. *	`string`	`''`
`contextNote` `context-note`	Text that appears above the input, on the right, to add additional context. If you need to display HTML in this text, use the `context-note` slot instead	`string`	`''`
`helpText` `help-text`	The input’s help text. If you need to display HTML, use the `help-text` slot instead. *	`string`	`''`
`clearable`	Adds a clear button when the input is not empty *	`boolean`	`false`
`optionalIcon` `optional-icon`	Adds the default optional icon for this input type. Currently only types `email` and `tel` have a default optional icon.	`boolean`	`false`
`disabled`	Disables the input *	`boolean`	`false`
`placeholder`	Placeholder text to show as a hint when the input is empty.	`string`	`''`
`readonly`	Makes the input read-only *	`boolean`	`false`
`passwordToggle` `password-toggle`	Adds a button to toggle the passwords visibility, only applies to password types *	`boolean`	`false`
`passwordVisible` `password-visible`	Determines whether or no the password is currently visible. Only applies to password types *	`boolean`	`false`
`noSpinButtons` `no-spin-buttons`	Hides the browsers built-in increment/decrement spin buttons for number inputs *	`boolean`	`false`
`form`	By default, form-controls are associated with the nearest containing `<form>` element. This attribute allows you to place the form control outside 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.	`string`	-
`required`	Makes the input a required field.	`boolean`	`false`
`pattern`	A regular expression pattern to validate input against.	`string`	-
`minlength`	The minimum length of input that will be considered valid.	`number`	-
`maxlength`	The maximum length of input that will be considered valid.	`number`	-
`min`	The input’s minimum value. Only applies to date and number input types.	`number \| string`	-
`max`	The input’s maximum value. Only applies to date and number input types.	`number \| string`	-
`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'`	-
`autocapitalize`	Controls whether and how text input is automatically capitalized as it is entered by the user.	`'off' \| 'none' \| 'on' \| 'sentences' \| 'words' \| 'characters'`	-
`autocorrect`	Indicates whether the browser’s autocorrect feature is on or off.	`'off' \| 'on'`	-
`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`	Indicates that the input should receive focus on page load.	`boolean`	-
`enterkeyhint`	Used to customize the label or icon of the Enter key on virtual keyboards.	`'enter' \| 'done' \| 'go' \| 'next' \| 'previous' \| 'search' \| 'send'`	-
`spellcheck`	Enables spell checking on the input.	`boolean`	`true`
`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'`	-
`valueAsDate`	Gets or sets the current value as `date` object. Returns `null` if the value can’t be converted. This will use the native `<input type="{{type}}">` implementation and may result in an error.	-	-
`valueAsNumber`	Gets or sets the current value as a number. Return `null` if the value can’t be converted.	-	-
`validity`	Gets the validity state object	-	-
`validationMessage`	Gets the validation message	-	-
`updateComplete`	A read-only promise that resolves when the component has finished updating.

Learn more about attributes and properties.

Events

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

Learn more about events.

Methods

Name	Description	Arguments
`focus()`	Sets focus on the input.	`options: FocusOptions`
`blur()`	Removes focus from the input.	-
`select()`	Selects all the text in the input.	-
`setSelectionRange()`	Sets the start and end positions of the text selection (0-based).	`selectionStart: number, selectionEnd: number, selectionDirection: 'forward' \| 'backward' \| 'none'`
`setRangeText()`	Replaces a range of text with a new string.	`replacement: string, start: number, end: number, selectMode: 'select' \| 'start' \| 'end' \| 'preserve'`
`showPicker()`	Displays the browser picker for an input element (only works if the browser supports it for the input type).	-
`stepUp()`	Increments the value of a numeric input type by the value of the step attribute.	-
`stepDown()`	Decrements the value of a numeric input type by the value of the step attribute.	-
`checkValidity()`	Checks the validity but does not show a validation message. Returns `true` when valid and `false` when invalid.	-
`getForm()`	Gets the associated form, if one exists.	-
`reportValidity()`	Checks for validity and shows the browser’s validation message if the control is invalid.	-
`setCustomValidity()`	Sets a custom validation message. Pass an empty string to restore validity.	`message: string`

Learn more about methods.

Parts

Name	Description
`form-control`	The form control that wraps the label, input, and help text.
`form-control-label`	The label’s wrapper.
`form-control-input`	The input’s wrapper.
`form-control-help-text`	The help text’s wrapper.
`base`	The component’s base wrapper.
`input`	The internal `<input>` control.
`prefix`	The container that wraps the prefix.
`clear-button`	The clear button.
`password-toggle-button`	The password toggle button.
`suffix`	The container that wraps the suffix.

Learn more about customizing CSS parts.

Dependencies

This component automatically imports the following dependencies.

<zn-example>
<zn-icon>
<zn-tooltip>

Examples

Basic Input with Label

Help Text

Label with Tooltip

Label with Context Note

Placeholders

Clearable

Toggle Password

Disabled

Sizes

Pill

Input Types

Min Max Validation

Prefix & Suffix Icons

Prefix Submit Button

Customizing Label Position

Importing

Slots

Properties

Events

Methods

Parts

Dependencies