Upload

The Upload input component uses HTML's native file input. It allows users to select files from their device for upload. In addition to native input features, it adds support for Drag and drop and clearing the input.

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

Examples

Base

Show code

HTML

<section>
    <o-field>
        <o-upload v-slot="{ click }" v-model="file">
            <o-button tag="button" variant="primary" @click="click">
                <o-icon icon="upload" />
                <span>Click to upload</span>
            </o-button>
        </o-upload>
    </o-field>

    <p><b>Selected:</b> {{ file?.name }}</p>
</section>

JS

import { ref } from "vue";

const file = ref<File>();

Drag&Drop

Enable drag and drop using the drag-drop prop. To allow multiple files to be uploaded, set the multiple prop.

Show code

HTML

<section>
    <o-field>
        <o-upload v-model="dropFiles" multiple drag-drop>
            <div style="text-align: center">
                <p>
                    <o-icon icon="upload" size="is-large" />
                </p>
                <p>Drop your files here or click to upload</p>
            </div>
        </o-upload>
    </o-field>

    <div class="tags">
        <span v-for="(file, index) in dropFiles" :key="file.name">
            {{ file.name }}
            <o-button
                icon-left="times"
                size="small"
                native-type="button"
                @click="deleteDropFile(index)">
            </o-button>
        </span>
    </div>
</section>

JS

import { ref } from "vue";

const dropFiles = ref<File[]>([]);

function deleteDropFile(index): void {
    dropFiles.value.splice(index, 1);
}

Disabled

Prevent inputs with the disabled prop.

Show code

HTML

<section>
    <o-field>
        <o-upload disabled>
            <o-button tag="button" variant="primary">
                <o-icon icon="upload" />
                <span>Click to upload</span>
            </o-button>
        </o-upload>
    </o-field>

    <o-field>
        <o-upload drag-drop disabled>
            <div style="text-align: center">
                <p>
                    <o-icon icon="upload" size="is-large" />
                </p>
                <p>Drop your files here or click to upload</p>
            </div>
        </o-upload>
    </o-field>
</section>

Variants

Different styles can be achieved with the variant prop.

Show code

HTML

<section>
    <o-field label="Primary">
        <o-upload v-model="file" drag-drop variant="primary" expanded>
            <div style="text-align: center">
                <o-icon icon="upload" /> Hover to see color variant
            </div>
        </o-upload>
    </o-field>

    <o-field label="Secondary">
        <o-upload v-model="file" drag-drop variant="secondary" expanded>
            <div style="text-align: center">
                <o-icon icon="upload" /> Hover to see color variant
            </div>
        </o-upload>
    </o-field>

    <o-field label="Success">
        <o-upload v-model="file" drag-drop variant="success" expanded>
            <div style="text-align: center">
                <o-icon icon="upload" /> Hover to see color variant
            </div>
        </o-upload>
    </o-field>

    <o-field label="Info">
        <o-upload v-model="file" drag-drop variant="info" expanded>
            <div style="text-align: center">
                <o-icon icon="upload" /> Hover to see color variant
            </div>
        </o-upload>
    </o-field>

    <o-field label="Warning">
        <o-upload v-model="file" drag-drop variant="warning" expanded>
            <div style="text-align: center">
                <o-icon icon="upload" /> Hover to see color variant
            </div>
        </o-upload>
    </o-field>

    <o-field label="Danger">
        <o-upload v-model="file" drag-drop variant="danger" expanded>
            <div style="text-align: center">
                <o-icon icon="upload" /> Hover to see color variant
            </div>
        </o-upload>
    </o-field>

    <p><b>Selected:</b> {{ file?.name }}</p>
</section>

JS

import { ref } from "vue";

const file = ref<File>();

Upload Component

Upload one or more files.

<o-upload></o-upload>

Props

Prop name	Description	Type	Values	Default
accept	Same as native accept	string	-
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	-
customValidity	Custom HTML 5 validation error to set on the form control	string | ((currentValue: UploadType<unknown, IsMultiple> | null , state: ValidityState) => string) | undefined	-	""
disabled	Same as native disabled	boolean	-	false
dragDrop	Accepts drag & drop and change its style	boolean	-	false
expanded	Upload will be expanded (full-width)	boolean	-	From config: upload: {   expanded: false }
form	Same as native form	string	-
v-model	The input value state, use v-model to make it two-way binding	File | object	-
multiple	Same as native, also push new item to v-model instead of replacing	IsMultiple	-
name	Same as native name	string	-
native	Replace last chosen files every time (like native file input element)	boolean	-	true
override	Override existing theme classes completely	boolean	-
required	Same as native required	Booleanish	-
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: upload: {   variant: undefined }

Events

Event name	Properties	Description
update:model-value	value object | object[] | File | File[] - updated modelValue prop	modelValue prop two-way binding
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

Slots

Name	Description	Bindings
before	Additional slot before the dragzone
default	Default content	click (event: Event): void - click handler, only needed if a button is used
after	Additional slot after the dragzone

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.
expandedClass	Class of the root element when expanded.	expanded
disabledClass	Class of the root element when disabled.	disabled
variantClass	Class of the root element with variant. 👉 Drag & drop a file to see it in action!	variant	primary info warning danger
dragzoneClass	Class of the drag/drop container element.	dragDrop
dragzoneHoveredClass	Class of the draggable container element when hovered with a file. 👉 Drag & drop a file to see it in action!	dragDrop

Sass Variables

Current theme ➜ Oruga

SASS Variable	Default
$upload-draggable-padding	calc(4 * h.useVar("control-spacer"))
$upload-disabled-opacity	h.useVar("control-disabled-opacity")
$upload-draggable-background-color	h.useVar( "control-background-color")
$upload-draggable-border-color	h.useVar("control-border-color")
$upload-draggable-border-style	dashed
$upload-draggable-border-radius	h.useVar("border-radius")
$upload-draggable-border-width	h.useVar("control-border-width")
$upload-draggable-hover-border-color	h.useVar("secondary")
$upload-draggable-hover-background-color	h.useVar( "control-background-color")

See ➜ 📄 SCSS file

Current theme ➜ Bulma

SASS Variable	Default
$upload-bg	transparent
$upload-dragzone-padding	2em
$upload-colors	file.$file-colors
$upload-border-color	css.getVar("grey-light")

See ➜ 📄 SCSS file

Current theme ➜ Bootstrap

SASS Variable	Default
$upload-dragzone-bg	transparent
$upload-dragzone-bg-hover	transparent
$upload-dragzone-border-color	var(--#{$prefix}border-color)
$upload-dragzone-border-color-hover	var(--#{$prefix}dark-bg-subtle)
$upload-dragzone-border-width	var(--#{$prefix}border-width)
$upload-dragzone-border-radius	var(--#{$prefix}border-radius)
$upload-dragzone-padding	2em
$upload-disabled-opacity	0.5

See ➜ 📄 SCSS file

Current theme ➜ Tailwind

SASS Variable	Default

See ➜ 📄 SCSS file