ba-input

A generic form input that can be used in a variety of input types

Component deprecated

This component will be removed in a future release. Use the dedicated input type components instead. If a input type is not available please get in contact with the design system team to raise a request for change

Label text

<ba-input>
    <span slot="label">Label text</span>
</ba-input>

Code

Properties & Attributes

Property	Attribute	Description	Type	Default
`accept`	`accept`	If the value of the type attribute is `"file"`, then this attribute will indicate the types of files that the server accepts, otherwise it will be ignored. The value must be a comma-separated list of unique content type specifiers.	`string \| undefined`	`undefined`
`autocapitalize`	`autocapitalize`	Indicates whether and how the text value should be automatically capitalized as it is entered/edited by the user.	`string`	`'off'`
`autocomplete`	`autocomplete`	Indicates whether the value of the control can be automatically completed by the browser. Valid values are 'on' or 'off' but Chrome ignores 'off' so we use another value to disable autocomplete.	`"null" \| "off" \| "on" \| undefined`	`'null'`
`autocorrect`	`autocorrect`	Whether auto correction should be enabled when the user is entering/editing the text value.	`"off" \| "on" \| undefined`	`'off'`
`autofocus`	`autofocus`	This Boolean attribute lets you specify that a form control should have input focus when the page loads.	`boolean`	`false`
`disabled`	`disabled`	If `true`, the user cannot interact with the input.	`boolean \| undefined`	`false`
`hintText`	`hint-text`	Hint text to show above the input	`string \| undefined`	`undefined`
`inputId`	`input-id`	Sets the ID of the input	`string \| undefined`	`this.id`
`inputmode`	`inputmode`	A hint to the browser for which keyboard to display. Possible values: `"none"`, `"text"`, `"tel"`, `"url"`, `"email"`, `"numeric"`, `"decimal"`, and `"search"`. Use ba-input-datepicker instead of ba-input type='date'.	`"date" \| "decimal" \| "email" \| "none" \| "numeric" \| "password" \| "search" \| "tel" \| "text" \| "url" \| undefined`	`undefined`
`invalid`	`invalid`	Sets the input to invalid	`boolean \| undefined`	`false`
`max`	`max`	The maximum value, which must not be less than its minimum (min attribute) value.	`string \| undefined`	`undefined`
`maxlength`	`maxlength`	If the value of the type attribute is `text`, `email`, `search`, `password`, `tel`, or `url`, this attribute specifies the maximum number of characters that the user can enter.	`number \| undefined`	`undefined`
`min`	`min`	The minimum value, which must not be greater than its maximum (max attribute) value.	`string \| undefined`	`undefined`
`minlength`	`minlength`	If the value of the type attribute is `text`, `email`, `search`, `password`, `tel`, or `url`, this attribute specifies the minimum number of characters that the user can enter.	`number \| undefined`	`undefined`
`multiple`	`multiple`	If `true`, the user can enter more than one value. This attribute applies when the type attribute is set to `"email"` or `"file"`, otherwise it is ignored.	`boolean \| undefined`	`undefined`
`name`	`name`	The name of the control, which is submitted with the form data.	`string \| undefined`	`this.id`
`pattern`	`pattern`	A regular expression that the value is checked against. The pattern must match the entire value, not just some subset. Use the title attribute to describe the pattern to help the user. This attribute applies when the value of the type attribute is `"text"`, `"search"`, `"tel"`, `"url"`, `"email"`, or `"password"`, otherwise it is ignored.	`string \| undefined`	`undefined`
`placeholder`	`placeholder`	Instructional text that shows before the input has a value.	`null \| string \| undefined`	`undefined`
`required`	`required`	If `true`, the user must fill in a value before submitting a form.	`boolean \| undefined`	`false`
`size`	`size`	The initial size of the control. This value is in pixels unless the value of the type attribute is `"text"` or `"password"`, in which case it is an integer number of characters. This attribute applies only when the `type` attribute is set to `"text"`, `"search"`, `"tel"`, `"url"`, `"email"`, or `"password"`, otherwise it is ignored.	`number \| undefined`	`undefined`
`spellCheck`	`spell-check`	If `true`, the element will have its spelling and grammar checked.	`"false" \| "true" \| undefined`	`'false'`
`step`	`step`	Works with the min and max attributes to limit the increments at which a value can be set. Possible values are: `"any"` or a positive floating point number.	`string \| undefined`	`undefined`
`type`	`type`	The type of control to display. The default type is text.	`"date" \| "email" \| "number" \| "password" \| "search" \| "tel" \| "text" \| "time" \| "url" \| undefined`	`'text'`
`value`	`value`	The value of the input.	`null \| string \| undefined`	`''`

Events

Event	Description	Type
`baBlur`	Emitted when the input loses focus.	`CustomEvent<void>`
`baChange`	Emitted when the value has changed.	`CustomEvent<InputChangeEventDetail>`
`baFocus`	Emitted when the input has focus.	`CustomEvent<void>`
`baInput`	Emitted when a keyboard input occurred.	`CustomEvent<KeyboardEvent>`
`baOnInput`	Emitted when a keyboard input occurred.	`CustomEvent<KeyboardEvent>`
`baOnSuggestionSelect`	Emitted when the typeahead suggestion is selected	`CustomEvent<any>`
`baOnTypeahead`	Emitted when the typeahead suggestions need to be displayed	`CustomEvent<InputChangeEventDetail>`

Methods

`getInputElement() => Promise<HTMLInputElement>`

Returns the native <input> element used under the hood.

Returns

Type: Promise<HTMLInputElement>

`isValid() => Promise<boolean>`

An exposed method for triggering the inputs required validation

Returns

Type: Promise<boolean>

`setFocus() => Promise<void>`

Sets focus on the specified ba-input. Use this method instead of the global
input.focus().

Returns

Type: Promise<void>

Slots

Slot	Description
`"error"`	Content is placed to the error at the bottom of the component.
`"label"`	Content is placed within a at the top of the component.