Input

The Input component uses HTML's native text input. It allows a user to enter a single line of text.

Combine it with the Field component to access all the functionalities.

Examples

Base

Show code

HTML

<section>
    <o-field label="Name">
        <o-input model-value="John Silver" />
    </o-field>

    <o-field label="Email" variant="danger" message="This email is invalid">
        <o-input type="email" model-value="john@" :maxlength="30" />
    </o-field>

    <o-field
        label="Username"
        variant="success"
        message="This username is available">
        <o-input model-value="johnsilver" :maxlength="30" />
    </o-field>

    <o-field label="Password">
        <o-input
            type="password"
            model-value="iwantmytreasure"
            password-reveal />
    </o-field>

    <o-field label="Clearable">
        <o-input model-value="John Silver" clearable />
    </o-field>

    <o-field label="Message">
        <o-input
            :maxlength="200"
            type="textarea"
            autosize
            placeholder="Enter some text..." />
    </o-field>

    <o-field>
        <o-input model-value="" placeholder="No label" />
    </o-field>

    <o-field label="Number">
        <o-input
            :model-value="42"
            number
            type="number"
            placeholder="Number"
            rounded />
    </o-field>

    <o-field label="Disabled">
        <o-input placeholder="Disabled" disabled />
    </o-field>

    <o-field label="Expanded">
        <o-input placeholder="Expanded" expanded />
    </o-field>

    <o-field label="Counter">
        <o-input
            placeholder="Counter"
            :maxlength="10"
            :maxitems="5"
            counter />
    </o-field>
</section>

Variants

Different styles can be achieved with the variant prop.

Show code

HTML

<section>
    <o-field label="Primary" variant="primary">
        <o-input placeholder="Primary" />
    </o-field>

    <o-field label="Secondary" variant="secondary">
        <o-input placeholder="Secondary" />
    </o-field>

    <o-field label="Success" variant="success">
        <o-input placeholder="Success" />
    </o-field>

    <o-field label="Info" variant="info">
        <o-input placeholder="Info" />
    </o-field>

    <o-field label="Warning" variant="warning">
        <o-input placeholder="Warning" />
    </o-field>

    <o-field
        label="Error"
        variant="danger"
        message="You can have a message too">
        <o-input placeholder="Error" />
    </o-field>
</section>

Sizes

The component can be displayed in different sizes using the size prop.

Show code

HTML

<section>
    <o-field>
        <o-input placeholder="small" size="small" icon="user" />
    </o-field>

    <o-field>
        <o-input placeholder="default" icon="user" />
    </o-field>

    <o-field>
        <o-input placeholder="medium" size="medium" icon="user" />
    </o-field>

    <o-field>
        <o-input placeholder="Large" size="large" icon="user" />
    </o-field>
</section>

With Icons

Add an icon to the component to explain its function more visually.

Show code

HTML

<section>
    <o-field>
        <o-input
            placeholder="Search..."
            type="search"
            icon="search"
            icon-clickable
            @icon-click="searchIconClick" />
    </o-field>

    <o-field>
        <o-input
            placeholder="Search..."
            type="search"
            icon-right="search"
            icon-right-clickable />
    </o-field>

    <o-field>
        <o-input
            v-model="email"
            placeholder="Email"
            type="email"
            icon="envelope"
            icon-right="times-circle"
            icon-right-clickable
            @icon-right-click="clearIconClick" />
    </o-field>
</section>

JS

import { ref } from "vue";

const email = ref("");

function searchIconClick(): void {
    alert("You wanna make a search?");
}

function clearIconClick(): void {
    email.value = "";
    alert("Email cleared!");
}

Input Component

Get user Input. Use with Field to access all functionalities.

<o-input></o-input>

Props

Prop name	Description	Type	Values	Default
aria-activedescendant	Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.	string	-
aria-atomic	Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.	Booleanish	-
aria-autocomplete	Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.	"both" | "inline" | "list" | "none"	-
aria-busy	Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user.	Booleanish	-
aria-checked	Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.	"mixed" | Booleanish	-
aria-colcount	Defines the total number of columns in a table, grid, or treegrid.	Numberish	-
aria-colindex	Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.	Numberish	-
aria-colspan	Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.	Numberish	-
aria-controls	Identifies the element (or elements) whose contents or presence are controlled by the current element.	string	-
aria-current	Indicates the element that represents the current item within a container or set of related elements.	"date" | "location" | "page" | "step" | "time" | Booleanish	-
aria-describedby	Identifies the element (or elements) that describes the object.	string	-
aria-details	Identifies the element that provides a detailed, extended description for the object.	string	-
aria-disabled	Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.	Booleanish	-
aria-dropeffect	deprecated - in ARIA 1.1 Indicates what functions can be performed when a dragged object is released on the drop target.	"copy" | "execute" | "link" | "move" | "none" | "popup"	-
aria-errormessage	Identifies the element that provides an error message for the object.	string	-
aria-expanded	Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.	Booleanish	-
aria-flowto	Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.	string	-
aria-grabbed	deprecated - in ARIA 1.1 Indicates an element's "grabbed" state in a drag-and-drop operation.	Booleanish	-
aria-haspopup	Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.	"dialog" | "grid" | "listbox" | "menu" | "tree" | Booleanish	-
aria-hidden	Indicates whether the element is exposed to an accessibility API.	Booleanish	-
aria-invalid	Indicates the entered value does not conform to the format expected by the application.	"grammar" | "spelling" | Booleanish	-
aria-keyshortcuts	Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.	string	-
aria-label	Defines a string value that labels the current element.	string	-
aria-labelledby	Identifies the element (or elements) that labels the current element.	string	-
aria-level	Defines the hierarchical level of an element within a structure.	Numberish	-
aria-live	Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.	"assertive" | "off" | "polite"	-
aria-modal	Indicates whether an element is modal when displayed.	Booleanish	-
aria-multiline	Indicates whether a text box accepts multiple lines of input or only a single line.	Booleanish	-
aria-multiselectable	Indicates that the user may select more than one item from the current selectable descendants.	Booleanish	-
aria-orientation	Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.	"horizontal" | "vertical"	-
aria-owns	Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.	string	-
aria-placeholder	Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.	string	-
aria-posinset	Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.	Numberish	-
aria-pressed	Indicates the current "pressed" state of toggle buttons.	"mixed" | Booleanish	-
aria-readonly	Indicates that the element is not editable, but is otherwise operable.	Booleanish	-
aria-relevant	Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.	"additions removals" | "additions text" | "additions" | "all" | "removals additions" | "removals text" | "removals" | "text additions" | "text removals" | "text"	-
aria-required	Indicates that user input is required on the element before a form may be submitted.	Booleanish	-
aria-roledescription	Defines a human-readable, author-localized description for the role of an element.	string	-
aria-rowcount	Defines the total number of rows in a table, grid, or treegrid.	Numberish	-
aria-rowindex	Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.	Numberish	-
aria-rowspan	Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.	Numberish	-
aria-selected	Indicates the current "selected" state of various widgets.	Booleanish	-
aria-setsize	Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.	Numberish	-
aria-sort	Indicates if items in a table or grid are sorted in ascending or descending order.	"ascending" | "descending" | "none" | "other"	-
aria-valuemax	Defines the maximum allowed value for a range widget.	Numberish	-
aria-valuemin	Defines the minimum allowed value for a range widget.	Numberish	-
aria-valuenow	Defines the current value for a range widget.	Numberish	-
aria-valuetext	Defines the human readable text alternative of aria-valuenow for a range widget.	string	-
autocapitalize	Same as native autocapitalize	string	-
autocomplete	Native options to use in HTML5 validation, whether the value of the form's controls can be automatically completed by the browser.	string	-	From config: input: {   autocomplete: "off" }
autosize	Automatically adjust height in textarea	boolean	-	false
clearIcon	Icon name to be added on the clear button	string	-	From config: input: {   clearIcon: "close-circle" }
clearable	Add a button/icon to clear the inputed text	boolean	-	From config: input: {   clearable: false }
cols	Same as native cols (textarea only)	Numberish	-
counter	Show character counter when maxlength prop is passed	boolean	-	From config: input: {   counter: false }
customValidity	Custom HTML 5 validation error to set on the form control	string | ((currentValue: InputType<IsNumber> | null , state: ValidityState) => string) | undefined	-	""
debounce	Number of milliseconds to delay before emitting the value	number	-	From config: autocomplete: {   debounce: undefined }
disabled	Same as native disabled	boolean	-	false
enterkeyhint	Same as native enterkeyhint	"done" | "enter" | "go" | "next" | "previous" | "search" | "send"	-
expanded	Makes input full width when inside a grouped or addon field	boolean	-	From config: input: {   expanded: false }
form	Same as native form	string	-
icon	Icon to be shown	string	-	From config: input: {   icon: undefined }
iconClickable	Makes the icon clickable	boolean	-	false
iconPack	Icon pack to use	string	mdi, fa, fas and any other custom icon pack	From config: input: {   iconPack: undefined }
iconRight	Icon to be added on the right side	string	-	From config: input: {   iconRight: undefined }
iconRightClickable	Make the icon right clickable	boolean	-	false
iconRightVariant	Variant of right icon	string	-
id	Same as native id. Also pass the id to a wrapping o-field component. Default is a uuid.	string	-	useId()
inputmode	Same as native inputmode	"decimal" | "email" | "none" | "numeric" | "search" | "tel" | "text" | "url"	-
list	Same as native list	string	-
max	Same as native max	Numberish	-
maxlength	Same as native maxlength. Also used to show character counter when counter prop is enabled.	number | string	-
min	Same as native min	Numberish	-
minlength	Same as native minlength	Numberish	-
modelModifiers		Partial<Record<string, true>>	-
v-model	The input value state, use v-model to make it two-way binding	number | string	-
name	Same as native name	string	-
number	Convert the ´modelValueinto typenumber`	boolean	-
override	Override existing theme classes completely	boolean	-
passwordReveal	Adds the reveal password functionality	boolean	-	false
pattern	Same as native pattern	string	-
placeholder	Same as native placeholder	string	-
readonly	Same as native readonly	Booleanish	-
required	Same as native required	Booleanish	-
rounded	Makes the element rounded	boolean	-	false
rows	Same as native rows (textarea only)	Numberish	-
size	Size of the control	string	small, medium, large	From config: input: {   size: undefined }
spellcheck	Same as native spellcheck	Booleanish	-
statusIcon	Show status icon using field and variant prop	boolean	-	From config: {   statusIcon: true }
step	Same as native step	Numberish	-
title	Same as native title	string	-
translate	Same as native translate	"no" | "yes"	-
type	Input type, like native	string	Any native input type, and textarea	"text"
useHtml5Validation	Enable HTML 5 native validation	boolean	-	From config: {   useHtml5Validation: true }
variant	Color variant of the control	string	primary, info, success, warning, danger, and any other custom color	From config: input: {   variant: undefined }
wrap	Same as native wrap (textarea only)	string	-

Events

Event name	Properties	Description
update:model-value	value string | number - updated modelValue prop	modelValue prop two-way binding
input	value string - input value event Event - native event	on input change event
focus	event Event - native event	on input focus event
blur	event Event - native event	on input blur event
invalid	event Event - native event	on input invalid event
icon-click	event Event - native event	on icon click event
icon-right-click	event Event - native event	on icon right click event

Class Inspector

Classes applied to the element:

➜ Want to know how does the Class Inspector work?

Class props inspector is useful to see class props you want to use to customize Oruga components and how they change a component. You can click on Inspect button to find the exact element where a specific class prop acts.

In the Class props inspector there are other columns:

Class prop

This column contains the name of the Class prop you want to inspect.
If you find a name with a link ( ▷ classPropName) this refers to a subitem (e.g. Dropdown Item in Dropdown).

Description

This column contains the description of the Class prop you want to inspect.
👉 This icon indicates some warning, e.g. this Class prop is visible only on mobile.

Props

This column contains a list of props that activate the class, e.g. if a class prop contains disabled prop it means that only when the component has disabled prop.

Suffixes

This column contains all the possible suffixes that you'll receive if you use a function to customize your Class prop.

Class prop	Description	Props	Suffixes
rootClass	Class of the root element.
sizeClass	Class of the root element with size.	size	small medium large
variantClass	Class of the root element with variant. 👉 Variant property should be applied to the wrapping field.	variant	primary info warning danger
expandedClass	Class of the root element when expanded.	expanded
disabledClass	Class of the root element when disabled.	disabled
roundedClass	Class of the root element when rounded.	rounded
textareaClass	Class of the root element when type `textarea`.	type
hasIconRightClass	Class to the root element when a right icon is used.	iconRight
inputClass	Class of the native input element.
placeholderClass	Class of the native input element with a placeholder.
iconLeftSpaceClass	Class of the native input element with left icon space.	icon
iconRightSpaceClass	Class of the native input element with right icon space.	iconRight
iconLeftClass	Class of the left icon element.	icon
iconRightClass	Class of the right icon element.	iconRight
counterClass	Class of the counter element.	counter maxlength

Sass Variables

Current theme ➜ Oruga

SASS Variable	Default
$input-color	h.useVar("font-color")
$input-font-size	h.useVar("font-size")
$input-font-weight	h.useVar("font-weight")
$input-line-height	h.useVar("line-height")
$input-height	h.useVar("control-height")
$input-padding	h.useVar("control-padding-vertical") h.useVar("control-padding-horizontal")
$input-disabled-opacity	h.useVar("control-disabled-opacity")
$input-box-shadow	h.useVar("control-box-shadow-inset")
$input-border-width	h.useVar("control-border-width")
$input-border-style	solid
$input-border-color	h.useVar("control-border-color")
$input-border-radius	h.useVar("border-radius")
$input-border-radius-rounded	h.useVar("border-radius-rounded")
$input-background-color	h.useVar("control-background-color")
$input-textarea-min-height	120px
$input-textarea-max-height	600px
$input-textarea-padding	h.useVar("control-spacer")
$input-counter-font-size	0.75rem
$input-counter-padding	0.25rem 0.5rem

See ➜ 📄 SCSS file

Current theme ➜ Bulma

SASS Variable	Default
$input-colors	dv.$colors

See ➜ 📄 SCSS file

Current theme ➜ Bootstrap

SASS Variable	Default
$input-icon-color	$input-color
$input-icon-spacer	0.75rem
$input-icon-padding-sm	2rem
$input-icon-padding	2.5rem
$input-icon-padding-lg	3rem

See ➜ 📄 SCSS file

Current theme ➜ Tailwind

SASS Variable	Default

See ➜ 📄 SCSS file