Button Element

A form example demonstrating how to use the ButtonElement static element in VueForm Laravel to create submit buttons, clickable actions, and anchor buttons within Laravel forms. Documentation

🧱 Import Class

use VueFormLaravel\Abstracts\VueFormBuilder;
use VueFormLaravel\Elements\Fields\TagsElement;
use VueFormLaravel\Elements\Static\ButtonElement;
use VueFormLaravel\Elements\Static\StaticElement;
use VueFormLaravel\Elements\Vueform;

🧩 Example

• Input
• Output

class ButtonElementForm extends VueFormBuilder
{
    protected function buildForm()
    {
        return Vueform::build()
            ->schema([
                StaticElement::text('This is a simple form with a submit button. Click the button to trigger form submission.')
                    ->addClass('mb-3'),
                ButtonElement::submitButton()
                    ->events([
                        'click' => 'handleSubmit'
                    ]),
                // anchor button example
                StaticElement::text('Below is an example of an anchor button. It will navigate to the specified URL when clicked.')
                    ->addClass('mt-4 mb-3'),
                ButtonElement::anchorButton('https://www.example.com')
                    ->buttonLabel('Visit Example.com')
            ]);
    }
}

⚙️ Allowed Attributes

⚡ Events

You can define custom button 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

🔔 Example Usage of event (PHP)

ButtonElement::name('example')
    ->events([
        'click' => 'handleClick',
        'beforeCreate' => 'handleBeforeCreate',
        'created' => 'handleCreated',
        'beforeMount' => 'handleBeforeMount',
        'mounted' => 'handleMounted',
        'beforeUpdate' => 'handleBeforeUpdate',
        'updated' => 'handleUpdated',
        'beforeUnmount' => 'handleBeforeUnmount',
        'unmounted' => 'handleUnmounted',
    ])

🔔 Example Usage of event(JavaScript)

function handleClick(form$, el$, event) {
    // 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:

⚙️ Available Static Methods