Date Element

A form example demonstrating how to use the DateElement field in VueForm Laravel to add date picker inputs for selecting and submitting dates in Laravel forms. Documentation


🧱 Import Class

use VueFormLaravel\Abstracts\VueFormBuilder;
use VueFormLaravel\Elements\Fields\DateElement;
use VueFormLaravel\Elements\Vueform;

🧩 Example

class DateElementForm extends VueFormBuilder
{
    protected function buildForm()
    {
        return Vueform::build()
            ->schema([
                DateElement::name('date_of_birth')
                    ->label('Date of Birth')
                    ->placeholder('Select your date of birth')
            ]);
    }
}

⚙️ Allowed Attributes

Name Data Type Default Example
addClass array|object|string|function null DateElement::name("name")->addClass()
addClasses object|function {} DateElement::name("name")->addClasses()
addons object {} DateElement::name("name")->addons()
after object|string|number null DateElement::name("name")->after()
autocomplete string|number null DateElement::name("name")->autocomplete()
before object|string|number null DateElement::name("name")->before()
between object|string|number null DateElement::name("name")->between()
columns object|string|number null DateElement::name("name")->columns()
conditions array [] DateElement::name("name")->conditions()
date boolean true DateElement::name("name")->date()
default string|date null DateElement::name("name")->default()
description string|object null DateElement::name("name")->description()
disabled boolean|function|array|object false DateElement::name("name")->disabled()
disables array [] DateElement::name("name")->disables()
displayErrors boolean true DateElement::name("name")->displayErrors()
displayFormat string locale.vueform.dateFormats.* DateElement::name("name")->displayFormat()
extendOptions object {} DateElement::name("name")->extendOptions()
fieldName string|object name label
floating string|boolean|object null DateElement::name("name")->floating()
formatData function null DateElement::name("name")->formatData()
formatLoad function null DateElement::name("name")->formatLoad()
hour24 boolean true DateElement::name("name")->hour24()
id string null DateElement::name("name")->id()
info string|object null DateElement::name("name")->info()
infoPosition string right DateElement::name("name")->infoPosition()
inline boolean false DateElement::name("name")->inline()
label string|object|function null DateElement::name("name")->label()
loadFormat string locale.vueform.dateFormats.* DateElement::name("name")->loadFormat()
max string|date null DateElement::name("name")->max()
messages object {} DateElement::name("name")->messages()
min string|date null DateElement::name("name")->min()
name string|number undefined DateElement::name("name")->name()
overrideClass array|object|string|function null DateElement::name("name")->overrideClass()
overrideClasses object|function {} DateElement::name("name")->overrideClasses()
placeholder string|object null DateElement::name("name")->placeholder()
presets array [] DateElement::name("name")->presets()
readonly boolean|function|array|object false DateElement::name("name")->readonly()
removeClass array|object|function null DateElement::name("name")->removeClass()
removeClasses object|function {} DateElement::name("name")->removeClasses()
replaceClass object|function null DateElement::name("name")->replaceClass()
replaceClasses object|function {} DateElement::name("name")->replaceClasses()
rules array|string|object null DateElement::name("name")->rules()
seconds boolean false DateElement::name("name")->seconds()
size string undefined DateElement::name("name")->size()
slots object {} DateElement::name("name")->slots()
submit boolean true DateElement::name("name")->submit()
templates object {} DateElement::name("name")->templates()
time boolean false DateElement::name("name")->time()
valueFormat string|boolean locale.vueform.dateFormats.* DateElement::name("name")->valueFormat()
view string undefined DateElement::name("name")->view()
views object {} DateElement::name("name")->views()

⚡ Events

You can define custom date element events Documentation directly in PHP using the ->events() method.

Each event value refers to a JavaScript function name.

These functions must be defined inside:

public/vueform-laravel/vueform-custom.js

This allows you to extend or override default behaviors for your generated VueForm components

Name Parameters Description
reset - {component} el$ - the element's component Triggered when the input is resetted.
clear - {component} el$ - the element's component Triggered when the input is cleared.
change - {string} newValue - the new value
- {string} oldValue - the old value
- {component} el$ - the element's component
Triggered when the element's value is changed.
beforeCreate - {component} el$ - the element's component Triggered in beforeCreate hook.
created - {component} el$ - the element's component Triggered in created hook.
beforeMount - {component} el$ - the element's component Triggered in beforeMount hook.
mounted - {component} el$ - the element's component Triggered in mounted hook.
beforeUpdate - {component} el$ - the element's component Triggered in beforeUpdate hook.
updated - {component} el$ - the element's component Triggered in updated hook.
beforeUnmount - {component} el$ - the element's component Triggered in beforeUnmount (or beforeDestroy in Vue 2) hook.
unmounted - {component} el$ - the element's component Triggered in unmounted (or destroyed in Vue 2) hook.

🔔 Example Usage of event (PHP)

DateElement::name('example')
    ->events([
        'reset' => 'handleReset',
        'clear' => 'handleClear',
        'change' => 'handleChange',
        'beforeCreate' => 'handleBeforeCreate',
        'created' => 'handleCreated',
        'beforeMount' => 'handleBeforeMount',
        'mounted' => 'handleMounted',
        'beforeUpdate' => 'handleBeforeUpdate',
        'updated' => 'handleUpdated',
        'beforeUnmount' => 'handleBeforeUnmount',
        'unmounted' => 'handleUnmounted',
    ])

🔔 Example Usage of event(JavaScript)

function handleReset(el$) {
    // Your code here
}
function handleClear(el$) {
    // Your code here
}
function handleChange(newValue, oldValue, el$) {
    // Your code here
}
function handleBeforeCreate(el$) {
    // Your code here
}
function handleCreated(el$) {
    // Your code here
}
function handleBeforeMount(el$) {
    // Your code here
}
function handleMounted(el$) {
    // Your code here
}
function handleBeforeUpdate(el$) {
    // Your code here
}
function handleUpdated(el$) {
    // Your code here
}
function handleBeforeUnmount(el$) {
    // Your code here
}
function handleUnmounted(el$) {
    // Your code here
}

⚡ Slots

The following slots Documentation are available for this element:

Name Scope Description
label - {component} el$ - the element's component Renders a label for the element in ElementLabel component.
info - {component} el$ - the element's component Renders an info icon in ElementInfo component next the the element label. When the icon is hovered it shows the content of this slot. The element needs to have a label to render this.
required -
description - {component} el$ - the element's component Renders description for the element in ElementDescription component.
before - {component} el$ - the element's component Renders an ElementText component before the input field.
between - {component} el$ - the element's component Renders an ElementText component after the input field and before description.
after - {component} el$ - the element's component Renders an ElementText component after the description and error.
addon-before - {component} el$ - the element's component Prepends an addon to the input field.
addon-after - {component} el$ - the element's component Appends an addon to the input field.