shoelace/docs/components/input.md

3.4 KiB

Input

[component-header:sl-input]

Inputs collect data from the user.

<sl-input></sl-input>

?> This component doesn't work with standard forms. Use <sl-form> instead.

?> Please refer to the section on form control validation to learn how to do client-side validation.

Examples

Placeholders

Use the placeholder attribute to add a placeholder.

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

Clearable

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

<sl-input placeholder="Clearable" clearable></sl-input>

Toggle Password

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

<sl-input type="password" placeholder="Password Toggle" size="small" toggle-password></sl-input>
<br>
<sl-input type="password" placeholder="Password Toggle" size="medium" toggle-password></sl-input>
<br>
<sl-input type="password" placeholder="Password Toggle" size="large" toggle-password></sl-input>

Filled Inputs

Add the filled attribute to draw a filled input.

<sl-input placeholder="Type something" filled></sl-input>

Pill

Use the pill attribute to give inputs rounded edges.

<sl-input placeholder="Small" size="small" pill></sl-input>
<br>
<sl-input placeholder="Medium" size="medium" pill></sl-input>
<br>
<sl-input placeholder="Large" size="large" pill></sl-input>

Input Types

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

<sl-input type="email" Placeholder="Email"></sl-input>
<br>
<sl-input type="number" Placeholder="Number"></sl-input>
<br>
<sl-input type="date" Placeholder="Date"></sl-input>

Disabled

Use the disabled attribute to disable an input.

<sl-input placeholder="Disabled" size="small" disabled></sl-input>
<br>
<sl-input placeholder="Disabled" size="medium" disabled></sl-input>
<br>
<sl-input placeholder="Disabled" size="large" disabled></sl-input>

Sizes

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

<sl-input placeholder="Small" size="small"></sl-input>
<br>
<sl-input placeholder="Medium" size="medium"></sl-input>
<br>
<sl-input placeholder="Large" size="large"></sl-input>

Prefix & Suffix Icons

Use the prefix and suffix slots to add icons.

<sl-input placeholder="Small" size="small">
  <sl-icon name="house" slot="prefix"></sl-icon>
  <sl-icon name="chat" slot="suffix"></sl-icon>
</sl-input>
<br>
<sl-input placeholder="Medium" size="medium">
  <sl-icon name="house" slot="prefix"></sl-icon>
  <sl-icon name="chat" slot="suffix"></sl-icon>
</sl-input>
<br>
<sl-input placeholder="Large" size="large">
  <sl-icon name="house" slot="prefix"></sl-icon>
  <sl-icon name="chat" slot="suffix"></sl-icon>
</sl-input>

Labels

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

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

Help Text

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

<sl-input 
  label="Nickname" 
  help-text="What would you like people to call you?"
></sl-input>

[component-metadata:sl-input]