Getting started

InstallUsageGuidelinesContributeRelease

Foundation

Navigation

Forms

ButtonButton GroupCheckboxCheckbox GroupClipboard ButtonComboboxEditable DescriptionEditable HeadingFile InputForm FieldIcon ButtonMulti SelectNumber InputRadioSearch InputSelectSliderSlug InputSwitchTag InputTextareaText Input

Slug Input

Slug input allows user to enter a slug for a resource they're creating, for example a new workspace.

#

#

#

Show a prefix before the input to hint where the slug would be used via prefix prop.

#

Input should be disabled, when it shouldn't be allowed to be interacted with.

#

Compared to a disabled input, read only input is usually used for values that user might want to copy to clipboard.

#

SlugInput supports three states of validation via validationState prop:

  1. "validating" - Slug is being validated.
  2. "valid" - Slug is valid.
  3. "invalid" - Slug is invalid.

#

#

  • Use sentence case for placeholder text.
  • End placeholder text with three dots.

#

Inherits margin props.

NameDefaultDescription
isDisabled

boolean

Determines whether input is disabled and doesn't respond to any user interactions.

isReadOnly

boolean

Determines whether input can be interacted with, but value can't be changed.

isRequired

boolean

Indicates that input is required to fill out.

prefix

string

Prefix to show before the value.

value

string

Input value.

validationState

"validating" | "invalid" | "valid"

Validation state.

width"xs""xs" | "sm" | "md" | "lg" | "auto" | "100%"

Input width.

On this page

  • Example
  • Usage
  • Prefix
  • Disabled
  • Read only
  • Validation
  • Guidelines
  • Content
  • Props