Laravel HTML

https://github.com/spatie/laravel-html
Admin
Laravel HTML is a package that provides a clean and simple API for generating HTML elements...
Tokens:39,286
Snippets:308
Trust Score:10
License:MIT
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Install via Composer

Source: https://github.com/spatie/laravel-html/blob/main/docs/installation-setup.md

Install the spatie/laravel-html package using Composer. Requires PHP 7 or higher.

```bash
composer require spatie/laravel-html
```

--------------------------------

### Register Service Provider in config/app.php

Source: https://github.com/spatie/laravel-html/blob/main/docs/installation-setup.md

Add the HtmlServiceProvider to the providers array in config/app.php for Laravel versions before 11.

```php
// config/app.php
'providers' => [
    ...
    Spatie\Html\HtmlServiceProvider::class,
];
```

--------------------------------

### open() example

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/element-methods.md

Returns the opening tag as an HtmlString including all children. The comment shows the output.

```php
echo Div::child(P::text('First child'))->open();
// "<div><p>First child</p>"
```

--------------------------------

### Register Service Provider in bootstrap/providers.php (Laravel 11)

Source: https://github.com/spatie/laravel-html/blob/main/docs/installation-setup.md

For Laravel 11, register the service provider in bootstrap/providers.php instead of config/app.php.

```php
// bootstrap/providers.php
return [
    ...
    Spatie\Html\HtmlServiceProvider::class,
];
```

--------------------------------

### prependChild() example

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/element-methods.md

Prepends a child element before existing children. The comment shows the resulting HTML.

```php
$paragraphOne = P::text('First');
$paragraphTwo = P::text('Second');
$divElement = Div::child($paragraphTwo)
                 ->preprendChild($paragraphOne);
// <div><p>First</p><p>Second</p></div>
```

--------------------------------

### child() and children() methods

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/element-methods.md

Adds one or more child elements. The first example adds a single child; the second adds multiple children via an array.

```php
echo Div::child(P::text('This is the first paragraph'))
// "<div><p>This is the first paragraph</p></div>"
```

```php
echo Div::children([P::text('This is the first paragraph'), Span::text('Span content')])
// "<div><p>This is the first paragraph</p><span>Span content</span></div>"
```

--------------------------------

### Setting multiple attributes with attributes()

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/element-methods.md

Sets multiple attributes from an array or collection. The example shows setting data-id and data-username attributes.

```php
echo Div::attributes(['data-id' => '123', 'data-username' => 'John']);
// "<div data-id="123" data-username="John"></div>"
```

--------------------------------

### close() example

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/element-methods.md

Returns the closing tag as an HtmlString, unless the element is a void element like <br>. The comment shows the output.

```php
echo Div::child(P::text('First child'))->close();
// "</div>"
```

--------------------------------

### if() example

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/element-methods.md

Conditionally transforms the element. Since elements are immutable, the callback must return a new instance.

```php
echo Div::if(10000 > 9000, function ($divElement) {
    return $divElement->text('10.000 is over 9.000');
});
// "<div>10.000 is over 9.000</div>"
```

--------------------------------

### Builder vs Element Method Value Resolution

Source: https://github.com/spatie/laravel-html/blob/main/README.md

Builder methods may resolve initial values (e.g., from session), while element methods are deterministic. The example shows `html()->email('email', 'hello@example.com')` vs `html()->email('email')->value('hello@example.com')`.

```php
// This will try to resolve an initial value, and fall back to 'hello@example.com'
$email = html()->email('email', 'hello@example.com');

// This will always have 'hello@example.com' as it's value
$email = html()->email('email')->value('hello@example.com');
```

--------------------------------

### Render element with child

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/element-methods.md

Returns the complete element including all children as an Illuminate\Support\HtmlString. The example echoes the rendered output of a div containing a paragraph with text.

```php
echo Div::child(P::text('First child'))->render();
// "<div><p>First child</p></div>"
```

--------------------------------

### Setting an attribute with attribute()

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/element-methods.md

Sets a single attribute on an element. The example shows adding a data-custom attribute with a value.

```php
echo Div::attribute('data-custom', 'Attribute value');
// "<div data-custom="Attribute value"></div>"
```

--------------------------------

### text() example

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/element-methods.md

Sets inner contents with HTML escaped via htmlentities(). The comment shows the escaped output.

```php
echo Div::text('This text is "ironic"');
// "<div>This text is &quot;ironic&quot;</div>"
```

--------------------------------

### Immutable Element Instances

Source: https://github.com/spatie/laravel-html/blob/main/README.md

Element instances are immutable; fluent methods return new instances. The example shows that calling `class()` twice on the same variable does not accumulate classes.

```php
$icon = html()->span()->class('fa');

$icon->class('fa-eye'); // '<span class="fa fa-eye"></span>'
$icon->class('fa-eye-slash'); // '<span class="fa fa-eye-slash"></span>'
```

--------------------------------

### getAttribute() with fallback

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/element-methods.md

Retrieves an attribute value, optionally with a fallback if the attribute is not set. The first example shows getting an existing attribute; the second shows the fallback behavior.

```php
echo Div::attribute('data-custom', 'Attribute value')
        ->getAttribute('data-custom');
// "Attribute value"
```

```php
echo Div::getAttribute('data-username', 'Unknown');
// "Unknown"
```

--------------------------------

### Create a generic element with Element::withTag

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/element-classes.md

Use the generic Spatie\Html\Elements\Element class to create any HTML element by passing the tag name to withTag. The example creates a <p> tag with text content and outputs the corresponding HTML string.

```php
echo Element::withTag('p')->text('This is the content!');
// "<p>This is the content!</p>"
```

--------------------------------

### Run composer test

Source: https://github.com/spatie/laravel-html/blob/main/README.md

Use this command to run the package's test suite. It is part of the testing instructions in the README.

```bash
$ composer test
```

--------------------------------

### file($name = null): File

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/html-builder.md

Creates a file input element. Returns an instance of Spatie\Html\Elements\File.

```APIDOC
## file($name = null): File

### Description
Creates a file input element. Returns an instance of Spatie\Html\Elements\File.

### Method
- (PHP method)

### Parameters
- **$name** (string|null) - Optional - The name attribute.

### Returns
- **File** - An instance of Spatie\Html\Elements\File.
```

--------------------------------

### Create a custom Html class extending Spatie\Html\Html

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/extending.md

Define a custom class that extends the base Html class to add custom methods like yesNoRadio. The method uses Div and radio elements to generate a yes/no radio button group, with checked states based on old input or model values.

```php
<?php

namespace App\Services;

use Spatie\Html\Elements\Div;
use Spatie\Html\Html;

class HtmlExtended extends Html
{
    public function yesNoRadio($name = null, $model = null)
    {
        return Div::create()->addChildren(
            Div::create()->class('form-check form-check-inline')
                ->addChildren($this->radio($name)->class('form-check-input')->id($name.'_yes')->value(1)->checked(old($name) === '1' || $model[$name] === 1))
                ->addChildren($this->label('Yes')->for($name.'_yes')->class('form-check-label'))
        )->addChildren(
            Div::create()->class('form-check form-check-inline')
                ->addChildren($this->radio($name)->class('form-check-input')->id($name.'_no')->value(0)->checked(old($name) === '0' || $model[$name] === 0))
                ->addChildren($this->label('No')->for($name.'_no')->class('form-check-label'))
        );
    }
}
```

--------------------------------

### Removing an attribute with forgetAttribute()

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/element-methods.md

Removes an attribute from an element. The example sets a data-custom attribute and then forgets it, resulting in an empty div.

```php
echo Div::attribute('data-custom', 'Attribute value')
        ->forgetAttribute('data-custom');
// "<div></div>"
```

--------------------------------

### open()

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/element-methods.md

Returns the element's opening tag as an Illuminate\Support\HtmlString, including all children. Useful for rendering forms in combination with close().

```APIDOC
## open()

### Description
Returns the element's opening tag as an `Illuminate\Support\HtmlString`, including all children. Useful for rendering forms in combination with `close()`.

### Method
open()

### Returns
- **HtmlString** - The opening tag with children.

### Example
```php
echo Div::child(P::text('First child'))->open();
// "<div><p>First child</p>"
```

### Usage with Forms
```html
{{ Form::action('/post-url')->method('POST')->open() }}

<!-- Other form inputs here -->

{{ Form::close() }}
```
```

--------------------------------

### Register Facade Alias in config/app.php

Source: https://github.com/spatie/laravel-html/blob/main/README.md

Optionally register an alias for the facade in the Laravel configuration file `config/app.php`.

```php
// config/app.php
'aliases' => [
    ...
    'Html' => Spatie\Html\Facades\Html::class,
];
```

--------------------------------

### Create a Span Element with Text

Source: https://github.com/spatie/laravel-html/blob/main/README.md

Create a span element with text using the `html()` builder.

```php
html()->span()->text('Hello world!');
```

--------------------------------

### File element methods

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/element-classes.md

Methods available on the File element class for setting attributes.

```APIDOC
## File element methods

### Description
Methods available on the File element class for setting attributes.

### Methods
- `function accept(?string $value)` - Sets the accept attribute.
- `function acceptAudio()` - Sets the accept attribute to audio types.
- `function acceptImage()` - Sets the accept attribute to image types.
- `function acceptVideo()` - Sets the accept attribute to video types.
- `function autofocus(?$autofocus)` - Sets the autofocus attribute.
- `function multiple()` - Sets the multiple attribute.
- `function name(?string $name)` - Sets the name attribute.
- `function required()` - Sets the required attribute.
```

--------------------------------

### Check radio buttons with model and old input

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/core-concepts.md

Use the checked method to set radio button state based on old input or model comparison. The example shows two radio buttons for title, with 'Mr' checked when conditions match.

```php
{{ html()->model(new User(['title' => 'Mr'])) }}
{{ html()->radio('title')->value('Mr')->checked(old('title', $user->title === 'Mr')) }}
{{ html()->radio('title')->value('Ms')->checked(old('title', $user->title === 'Ms')) }}
// <input type="radio" name="title" value="Mr" checked="checked" />
// <input type="radio" name="title" value="Ms" />
```

--------------------------------

### a($href = null, $text = null): A

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/html-builder.md

Creates an anchor element. Returns an instance of Spatie\Html\Elements\A.

```APIDOC
## a($href = null, $text = null): A

### Description
Creates an anchor element. Returns an instance of Spatie\Html\Elements\A.

### Method
- (PHP method)

### Parameters
- **$href** (string|null) - Optional - The href attribute value.
- **$text** (string|null) - Optional - The text content of the anchor.

### Returns
- **A** - An instance of Spatie\Html\Elements\A.
```

--------------------------------

### Input element methods

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/element-classes.md

Methods available on the Input element class for setting attributes.

```APIDOC
## Input element methods

### Description
Methods available on the Input element class for setting attributes.

### Methods
- `function autocomplete(bool|string $autocomplete = true)` - Sets the autocomplete attribute.
- `function autofocus(?$autofocus)` - Sets the autofocus attribute.
- `function checked($checked = true)` - Sets the checked attribute.
- `function disabled($disabled = true)` - Sets the disabled attribute.
- `function isReadonly($readonly = true)` - Sets the readonly attribute.
- `function maxlength(int $maxlength)` - Sets the maxlength attribute.
- `function minlength(int $minlength)` - Sets the minlength attribute.
- `function name(?string $name)` - Sets the name attribute.
- `function placeholder(?string $placeholder)` - Sets the placeholder attribute.
- `function required($required = true)` - Sets the required attribute.
- `function size($size)` - Sets the size attribute.
- `function type(?string $type)` - Sets the type attribute.
- `function unchecked()` - Removes the checked attribute.
- `function value(?string $value)` - Sets the value attribute.
```

--------------------------------

### render()

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/element-methods.md

Returns the complete element including all children as an Illuminate\Support\HtmlString. This method is used to output the final HTML representation of the element.

```APIDOC
## `render()`

### Description
Returns the complete element including all children as an `Illuminate\Support\HtmlString`.

### Method
`render()`

### Return Value
- `Illuminate\Support\HtmlString` - The complete HTML string of the element.

### Example
```php
echo Div::child(P::text('First child'))->render();
// "<div><p>First child</p></div>"
```
```

--------------------------------

### element($tag): Element

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/html-builder.md

Creates a generic element with the given tag. Returns an instance of Spatie\Html\Elements\Element.

```APIDOC
## element($tag): Element

### Description
Creates a generic element with the given tag. Returns an instance of Spatie\Html\Elements\Element.

### Method
- (PHP method)

### Parameters
- **$tag** (string) - Required - The HTML tag name.

### Returns
- **Element** - An instance of Spatie\Html\Elements\Element.
```

--------------------------------

### Select element methods

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/element-classes.md

Methods available on the Select element class for setting attributes.

```APIDOC
## Select element methods

### Description
Methods available on the Select element class for setting attributes.

### Methods
- `function autocomplete(bool|string $autocomplete = true)` - Sets the autocomplete attribute.
- `function autofocus(?$autofocus)` - Sets the autofocus attribute.
- `function disabled(?$disabled)` - Sets the disabled attribute.
- `function isReadonly(?$readonly)` - Sets the readonly attribute.
- `function multiple()` - Sets the multiple attribute.
- `function name(?string $name)` - Sets the name attribute.
- `function optgroup(string $label, iterable $options)` - Adds an optgroup with the given label and options.
- `function options(iterable $options)` - Sets the options for the select.
- `function placeholder(?$text)` - Sets a placeholder option.
- `function required(?$required)` - Sets the required attribute.
- `function value(?string $value)` - Sets the value attribute.
```

--------------------------------

### open() and close() form rendering

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/element-methods.md

Shows using open() and close() together to render a form in a Blade template. The HTML comment indicates where other form inputs go.

```html
{{ Form::action('/post-url')->method('POST')->open() }}

<!-- Other form inputs here -->

{{ Form::close() }}
```

--------------------------------

### token(): Input

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/html-builder.md

Creates a hidden token input element. Returns an instance of Spatie\Html\Elements\Input.

```APIDOC
## token(): Input

### Description
Creates a hidden token input element. Returns an instance of Spatie\Html\Elements\Input.

### Method
- (PHP method)

### Returns
- **Input** - An instance of Spatie\Html\Elements\Input.
```

--------------------------------

### select($name = null, $options = [], $value = null): Select

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/html-builder.md

Creates a select element. Returns an instance of Spatie\Html\Elements\Select.

```APIDOC
## select($name = null, $options = [], $value = null): Select

### Description
Creates a select element. Returns an instance of Spatie\Html\Elements\Select.

### Method
- (PHP method)

### Parameters
- **$name** (string|null) - Optional - The name attribute.
- **$options** (array) - Optional - The options for the select.
- **$value** (mixed|null) - Optional - The selected value.

### Returns
- **Select** - An instance of Spatie\Html\Elements\Select.
```

--------------------------------

### Option element methods

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/element-classes.md

Methods available on the Option element class for setting attributes.

```APIDOC
## Option element methods

### Description
Methods available on the Option element class for setting attributes.

### Methods
- `function disabled($disabled = true)` - Sets the disabled attribute.
- `function selected()` - Sets the selected attribute.
- `function selectedIf(bool $condition)` - Sets the selected attribute if the condition is true.
- `function unselected()` - Removes the selected attribute.
- `function value(?string $value)` - Sets the value attribute.
```

--------------------------------

### div($contents = null): Div

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/html-builder.md

Creates a div element. Returns an instance of Spatie\Html\Elements\Div.

```APIDOC
## div($contents = null): Div

### Description
Creates a div element. Returns an instance of Spatie\Html\Elements\Div.

### Method
- (PHP method)

### Parameters
- **$contents** (mixed|null) - Optional - The contents of the div.

### Returns
- **Div** - An instance of Spatie\Html\Elements\Div.
```

--------------------------------

### label($contents = null, $for = null): Label

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/html-builder.md

Creates a label element. Returns an instance of Spatie\Html\Elements\Label.

```APIDOC
## label($contents = null, $for = null): Label

### Description
Creates a label element. Returns an instance of Spatie\Html\Elements\Label.

### Method
- (PHP method)

### Parameters
- **$contents** (mixed|null) - Optional - The contents of the label.
- **$for** (string|null) - Optional - The for attribute.

### Returns
- **Label** - An instance of Spatie\Html\Elements\Label.
```

--------------------------------

### Re-register the custom Html class in AppServiceProvider

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/extending.md

In the AppServiceProvider, bind the custom HtmlExtended class to the Html contract using the singleton method. This ensures the extended class is used throughout the application.

```php
<?php

namespace App\Providers;

use App\Helpers\HtmlExtended;
use Illuminate\Support\ServiceProvider;
use Spatie\Html\Html;

class AppServiceProvider extends ServiceProvider
{
    /**
     * Register any application services.
     */
    public function register(): void
    {
        $this->app->singleton(Html::class, HtmlExtended::class);
    }
}
```

--------------------------------

### range($name = '', $value = '', $min = null, $max = null, $step = null): Input

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/html-builder.md

Creates a range input element. Returns an instance of Spatie\Html\Elements\Input.

```APIDOC
## range($name = '', $value = '', $min = null, $max = null, $step = null): Input

### Description
Creates a range input element. Returns an instance of Spatie\Html\Elements\Input.

### Method
- (PHP method)

### Parameters
- **$name** (string) - Optional - The name attribute (default: '').
- **$value** (string) - Optional - The value attribute (default: '').
- **$min** (mixed|null) - Optional - The minimum value.
- **$max** (mixed|null) - Optional - The maximum value.
- **$step** (mixed|null) - Optional - The step value.

### Returns
- **Input** - An instance of Spatie\Html\Elements\Input.
```

--------------------------------

### Using classIf and attributeIf methods

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/element-methods.md

All element methods can be called with the suffix 'If' to execute only when the first parameter is true. The classIf method adds a class conditionally, and attributeIf sets an attribute conditionally.

```php
echo Div::classIf(true, 'row');
// "<div class="row"></div>"
echo Div::classIf(false, 'row');
// "<div></div>"
echo Div::attributeIf(50 > 100, 'data-custom', 'Attribute value');
// "<div></div>"
```

--------------------------------

### A element methods

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/element-classes.md

Methods available on the A element class for setting attributes.

```APIDOC
## A element methods

### Description
Methods available on the A element class for setting attributes.

### Methods
- `function href(?string $href)` - Sets the href attribute.
- `function target(string $target)` - Sets the target attribute.
```

--------------------------------

### number($name = null, $value = null, $min = null, $max = null, $step = null): Input

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/html-builder.md

Creates a number input element. Returns an instance of Spatie\Html\Elements\Input.

```APIDOC
## number($name = null, $value = null, $min = null, $max = null, $step = null): Input

### Description
Creates a number input element. Returns an instance of Spatie\Html\Elements\Input.

### Method
- (PHP method)

### Parameters
- **$name** (string|null) - Optional - The name attribute.
- **$value** (mixed|null) - Optional - The value attribute.
- **$min** (mixed|null) - Optional - The minimum value.
- **$max** (mixed|null) - Optional - The maximum value.
- **$step** (mixed|null) - Optional - The step value.

### Returns
- **Input** - An instance of Spatie\Html\Elements\Input.
```

--------------------------------

### data() method

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/element-methods.md

Adds a data-* attribute to the element.

```php
echo Div::data('btn', 123);
// "<div data-btn="123"></div>"
```

--------------------------------

### Img element methods

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/element-classes.md

Methods available on the Img element class for setting attributes.

```APIDOC
## Img element methods

### Description
Methods available on the Img element class for setting attributes.

### Methods
- `function alt(?string $alt)` - Sets the alt attribute.
- `function src(?string $src)` - Sets the src attribute.
```

--------------------------------

### Button element methods

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/element-classes.md

Methods available on the Button element class for setting attributes.

```APIDOC
## Button element methods

### Description
Methods available on the Button element class for setting attributes.

### Methods
- `function disabled($disabled = true)` - Sets the disabled attribute.
- `function name(?string $name)` - Sets the name attribute.
- `function type(?string $type)` - Sets the type attribute.
- `function value(?string $value)` - Sets the value attribute.
```

--------------------------------

### Optgroup element methods

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/element-classes.md

Methods available on the Optgroup element class for setting attributes.

```APIDOC
## Optgroup element methods

### Description
Methods available on the Optgroup element class for setting attributes.

### Methods
- `function disabled($disabled = true)` - Sets the disabled attribute.
- `function label(?string $label)` - Sets the label attribute.
```

--------------------------------

### Build a basic form with email input

Source: https://github.com/spatie/laravel-html/blob/main/docs/introduction.md

Builds a form with PUT method and an email input. The form automatically includes hidden _method and _token fields. The email field is automatically filled with old input if available.

```php
{{ html()->form('PUT', '/post')->open() }}

{{ html()->email('email')->placeholder('Your e-mail address') }}

{{ html()->form()->close() }}
```

```html
<form method="POST" action="/post">
    <input type="hidden" name="_method" id="_method" value="PUT">
    <input type="hidden" name="_token" id="_token" value="csrf_token_will_be_here">
    <input type="email" name="email" id="email" placeholder="Your e-mail address">
</form>
```

--------------------------------

### text($name = null, $value = null): Input

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/html-builder.md

Creates a text input element. Returns an instance of Spatie\Html\Elements\Input.

```APIDOC
## text($name = null, $value = null): Input

### Description
Creates a text input element. Returns an instance of Spatie\Html\Elements\Input.

### Method
- (PHP method)

### Parameters
- **$name** (string|null) - Optional - The name attribute.
- **$value** (string|null) - Optional - The value attribute.

### Returns
- **Input** - An instance of Spatie\Html\Elements\Input.
```

--------------------------------

### input($type = null, $name = null, $value = null): Input

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/html-builder.md

Creates a generic input element. Returns an instance of Spatie\Html\Elements\Input.

```APIDOC
## input($type = null, $name = null, $value = null): Input

### Description
Creates a generic input element. Returns an instance of Spatie\Html\Elements\Input.

### Method
- (PHP method)

### Parameters
- **$type** (string|null) - Optional - The type attribute.
- **$name** (string|null) - Optional - The name attribute.
- **$value** (string|null) - Optional - The value attribute.

### Returns
- **Input** - An instance of Spatie\Html\Elements\Input.
```

--------------------------------

### Using html()->class() to render a class attribute

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/the-class-helper.md

Renders a class attribute with classes toggled based on array values. Non-associative values are always added; associative keys are added only if the value is truthy (non-strict).

```html
<div {{ html()->class(['foo', 'bar' => true, 'baz' => false]) }}>
```

```html
<div class="foo bar">
```

--------------------------------

### Form element methods

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/element-classes.md

Methods available on the Form element class for setting attributes.

```APIDOC
## Form element methods

### Description
Methods available on the Form element class for setting attributes.

### Methods
- `function acceptsFiles()` - Sets the enctype attribute to multipart/form-data.
- `function action(?string $action)` - Sets the action attribute.
- `function autocomplete(bool|string $autocomplete = true)` - Sets the autocomplete attribute.
- `function method(?string $method)` - Sets the method attribute.
- `function name(?string $name)` - Sets the name attribute.
- `function novalidate($novalidate = true)` - Sets the novalidate attribute.
- `function target(string $target)` - Sets the target attribute.
```

--------------------------------

### date($name = '', $value = null, $format = true): Input

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/html-builder.md

Creates a date input element. Returns an instance of Spatie\Html\Elements\Input.

```APIDOC
## date($name = '', $value = null, $format = true): Input

### Description
Creates a date input element. Returns an instance of Spatie\Html\Elements\Input.

### Method
- (PHP method)

### Parameters
- **$name** (string) - Optional - The name attribute (default: '').
- **$value** (mixed|null) - Optional - The value attribute.
- **$format** (bool) - Optional - Whether to format the value (default: true).

### Returns
- **Input** - An instance of Spatie\Html\Elements\Input.
```

--------------------------------

### search($name = null, $value = null): Input

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/html-builder.md

Creates a search input element. Returns an instance of Spatie\Html\Elements\Input.

```APIDOC
## search($name = null, $value = null): Input

### Description
Creates a search input element. Returns an instance of Spatie\Html\Elements\Input.

### Method
- (PHP method)

### Parameters
- **$name** (string|null) - Optional - The name attribute.
- **$value** (string|null) - Optional - The value attribute.

### Returns
- **Input** - An instance of Spatie\Html\Elements\Input.
```

--------------------------------

### time($name = '', $value = null, $format = true): Input

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/html-builder.md

Creates a time input element. Returns an instance of Spatie\Html\Elements\Input.

```APIDOC
## time($name = '', $value = null, $format = true): Input

### Description
Creates a time input element. Returns an instance of Spatie\Html\Elements\Input.

### Method
- (PHP method)

### Parameters
- **$name** (string) - Optional - The name attribute (default: '').
- **$value** (mixed|null) - Optional - The value attribute.
- **$format** (bool) - Optional - Whether to format the value (default: true).

### Returns
- **Input** - An instance of Spatie\Html\Elements\Input.
```

--------------------------------

### Label element methods

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/element-classes.md

Methods available on the Label element class for setting attributes.

```APIDOC
## Label element methods

### Description
Methods available on the Label element class for setting attributes.

### Methods
- `function for(?string $for)` - Sets the for attribute.
```

--------------------------------

### prependChild() and prependChildren()

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/element-methods.md

Prepends one or more child elements before the existing children on the element. Optionally accepts a mapper function as the second argument.

```APIDOC
## prependChild() / prependChildren()

### Description
Prepends one or more child-elements before the existing children on the element. A mapper function can be provided as the second argument.

### Method
prependChild() / prependChildren()

### Parameters
- **children** (mixed) - Required - The child element(s) to prepend.
- **mapper** (callable) - Optional - A function called for each child to be prepended.

### Example
```php
$paragraphOne = P::text('First');
$paragraphTwo = P::text('Second');
$divElement = Div::child($paragraphTwo)
                 ->preprendChild($paragraphOne);
// <div><p>First</p><p>Second</p></div>
```
```

--------------------------------

### button($text = null, $type = 'button'): Button

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/html-builder.md

Creates a button element. Returns an instance of Spatie\Html\Elements\Button.

```APIDOC
## button($text = null, $type = 'button'): Button

### Description
Creates a button element. Returns an instance of Spatie\Html\Elements\Button.

### Method
- (PHP method)

### Parameters
- **$text** (string|null) - Optional - The text content of the button.
- **$type** (string) - Optional - The type attribute of the button (default: 'button').

### Returns
- **Button** - An instance of Spatie\Html\Elements\Button.
```

--------------------------------

### submit($text = null): Button

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/html-builder.md

Creates a submit button element. Returns an instance of Spatie\Html\Elements\Button.

```APIDOC
## submit($text = null): Button

### Description
Creates a submit button element. Returns an instance of Spatie\Html\Elements\Button.

### Method
- (PHP method)

### Parameters
- **$text** (string|null) - Optional - The text content of the button.

### Returns
- **Button** - An instance of Spatie\Html\Elements\Button.
```

--------------------------------

### Open and close a form with form() and close()

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/html-builder.md

The form() method returns a Form element with _token and _method hidden fields by default. Use open() and close() to generate the form tags; the output shows the rendered HTML with the specified method and action.

```html
{{ html()->form('PUT', '/update-url')->open() }}

    {{ html()->text('username') }}

{{ html()->form()->close() }}

<!-- This will output the following HTML code: -->

<form method="POST" action="/update-url">
    <input type="hidden" name="_token" value="ABC123">
    <input type="hidden" name="_method" value="PUT">
    <input type="text" name="username">
</form>
```

--------------------------------

### Fieldset element methods

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/element-classes.md

Methods available on the Fieldset element class for setting attributes.

```APIDOC
## Fieldset element methods

### Description
Methods available on the Fieldset element class for setting attributes.

### Methods
- `function disabled($disabled = true)` - Sets the disabled attribute.
- `function legend(?string $contents)` - Sets the legend content.
```

--------------------------------

### Textarea element methods

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/element-classes.md

Methods available on the Textarea element class for setting attributes.

```APIDOC
## Textarea element methods

### Description
Methods available on the Textarea element class for setting attributes.

### Methods
- `function autocomplete(bool|string $autocomplete = true)` - Sets the autocomplete attribute.
- `function autofocus()` - Sets the autofocus attribute.
- `function cols(int $cols)` - Sets the cols attribute.
- `function disabled(?$disabled)` - Sets the disabled attribute.
- `function isReadonly(?$readonly)` - Sets the readonly attribute.
- `function maxlength(int $maxlength)` - Sets the maxlength attribute.
- `function minlength(int $minlength)` - Sets the minlength attribute.
- `function name(?string $name)` - Sets the name attribute.
- `function placeholder(?string $placeholder)` - Sets the placeholder attribute.
- `function required()` - Sets the required attribute.
- `function required(?$required)` - Sets the required attribute.
- `function rows(int $rows)` - Sets the rows attribute.
- `function value(?string $value)` - Sets the value attribute.
```

--------------------------------

### Element::withTag

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/element-classes.md

Creates a generic HTML element with the specified tag name. This is a static method on the Spatie\Html\Elements\Element class.

```APIDOC
## Element::withTag

### Description
Creates a generic HTML element with the specified tag name. This is a static method on the Spatie\Html\Elements\Element class.

### Method
Static method

### Signature
`public static function withTag(string $tag): Element`

### Parameters
- **$tag** (string) - Required - The HTML tag name for the element.

### Return Value
Returns an instance of `Spatie\Html\Elements\Element`.

### Example
```php
$element = Element::withTag('p');
```
```

--------------------------------

### password($name = null): Input

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/html-builder.md

Creates a password input element. Returns an instance of Spatie\Html\Elements\Input.

```APIDOC
## password($name = null): Input

### Description
Creates a password input element. Returns an instance of Spatie\Html\Elements\Input.

### Method
- (PHP method)

### Parameters
- **$name** (string|null) - Optional - The name attribute.

### Returns
- **Input** - An instance of Spatie\Html\Elements\Input.
```

--------------------------------

### datetime($name = '', $value = null, $format = true): Input

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/html-builder.md

Creates a datetime input element. Returns an instance of Spatie\Html\Elements\Input.

```APIDOC
## datetime($name = '', $value = null, $format = true): Input

### Description
Creates a datetime input element. Returns an instance of Spatie\Html\Elements\Input.

### Method
- (PHP method)

### Parameters
- **$name** (string) - Optional - The name attribute (default: '').
- **$value** (mixed|null) - Optional - The value attribute.
- **$format** (bool) - Optional - Whether to format the value (default: true).

### Returns
- **Input** - An instance of Spatie\Html\Elements\Input.
```

--------------------------------

### route($route, $parameters = [])

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/html-builder.md

Chained to form() to set the action URI using Laravel's route() helper.

```APIDOC
## route($route, $parameters = [])

### Description
Chained to form() to set the action URI using Laravel's route() helper.

### Method
- (PHP method)

### Parameters
- **$route** (string) - Required - The route name.
- **$parameters** (array) - Optional - Parameters for the route.

### Example
```html
{{ html()->form('PUT')->route('item.update') }}
```
```

--------------------------------

### children() with mapper function

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/element-methods.md

Provides a mapper function that is called for each child to generate elements from an array of strings.

```php
$content = ['First paragraph', 'Second paragraph', 'Third paragraph'];
echo Div::children($content, function ($content) {
    return P::text($content); // A new `<p>` element will be created for each string and added as a child of `<div>`
});
// "<div><p>...</p><p>...</p><p>...</p></div>"
```

--------------------------------

### form($method = 'POST', $action = null): Form

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/html-builder.md

Creates a form element with _token and _method hidden fields by default. Returns an instance of Spatie\Html\Elements\Form.

```APIDOC
## form($method = 'POST', $action = null): Form

### Description
Creates a form element with _token and _method hidden fields by default. Returns an instance of Spatie\Html\Elements\Form.

### Method
- (PHP method)

### Parameters
- **$method** (string) - Optional - The HTTP method for the form (default: 'POST').
- **$action** (string|null) - Optional - The action URI for the form.

### Returns
- **Form** - An instance of Spatie\Html\Elements\Form.

### Example
```html
{{ html()->form('PUT', '/update-url')->open() }}
    {{ html()->text('username') }}
{{ html()->form()->close() }}
```
```

--------------------------------

### email($name = null, $value = null): Input

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/html-builder.md

Creates an email input element. Returns an instance of Spatie\Html\Elements\Input.

```APIDOC
## email($name = null, $value = null): Input

### Description
Creates an email input element. Returns an instance of Spatie\Html\Elements\Input.

### Method
- (PHP method)

### Parameters
- **$name** (string|null) - Optional - The name attribute.
- **$value** (string|null) - Optional - The value attribute.

### Returns
- **Input** - An instance of Spatie\Html\Elements\Input.
```

--------------------------------

### modelForm($model, $method = 'POST', $action = null)

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/html-builder.md

Opens a form coupled to a model. Under the hood uses model() and form().

```APIDOC
## modelForm($model, $method = 'POST', $action = null)

### Description
Opens a form coupled to a model. Under the hood uses model() and form().

### Method
- (PHP method)

### Parameters
- **$model** (mixed) - Required - The model to couple to.
- **$method** (string) - Optional - The HTTP method for the form (default: 'POST').
- **$action** (string|null) - Optional - The action URI for the form.

### Example
```html
{{ html()->modelForm($user, 'PUT', '/update-url')->open() }}
    {{ html()->text('name') }}
    {{ html()->email('email')}}
{{ html()->closeModelForm() }}
```
```

--------------------------------

### close()

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/element-methods.md

Returns the element's closing tag as an Illuminate\Support\HtmlString, unless the element is a void element like <br>.

```APIDOC
## close()

### Description
Returns the element's closing tag as an `Illuminate\Support\HtmlString`. Returns an empty string for void elements like `<br>`.

### Method
close()

### Returns
- **HtmlString** - The closing tag.

### Example
```php
echo Div::child(P::text('First child'))->close();
// "</div>"
```
```

--------------------------------

### html()->class()

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/the-class-helper.md

Renders a class attribute based on an array or Collection, toggling classes depending on the truthiness of values. Non-associative values are always added, while associative keys are added only if their value evaluates to true (non-strict).

```APIDOC
## html()->class()

### Description
Renders a `class` attribute similar to Vue.js' `:class` property. It expects an array (or a `Collection`) and toggles classes based on the values.

### Method
`class`

### Parameters
- **classes** (array|Collection) - Required - An array or Collection where non-associative values are always added, and associative keys are added only if their value evaluates to true (non-strict).

### Request Example
```html
<div {{ html()->class(['foo', 'bar' => true, 'baz' => false]) }}>
```

### Response
#### Success Response
Renders a `class` attribute with the appropriate classes.

#### Response Example
```html
<div class="foo bar">
```
```

--------------------------------

### data()

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/element-methods.md

Adds a data-* attribute to the element.

```APIDOC
## data()

### Description
Adds a data-* attribute to the element.

### Method
`data`

### Parameters
- **name** (string) - Required - The data attribute name (without the 'data-' prefix).
- **value** (mixed) - Required - The attribute value.

### Return Value
Returns the element instance for chaining.

### Example
```php
echo Div::data('btn', 123);
// "<div data-btn="123"></div>"
```
```

--------------------------------

### class() method

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/element-methods.md

Adds a CSS class to the element, resulting in a class attribute in the rendered HTML.

```php
echo Div::class('btn');
// "<div class="btn"></div>"
```

--------------------------------

### class()

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/element-methods.md

Adds a CSS class to the element.

```APIDOC
## class()

### Description
Adds a CSS class to the element.

### Method
`class`

### Parameters
- **class** (string) - Required - The class name to add.

### Return Value
Returns the element instance for chaining.

### Example
```php
echo Div::class('btn');
// "<div class="btn"></div>"
```
```

--------------------------------

### attributes()

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/element-methods.md

Sets multiple attributes from an array or collection. This method is part of the Spatie Laravel HTML package and can be chained fluently.

```APIDOC
## attributes()

### Description
Sets multiple attributes from an array or collection.

### Method
attributes()

### Parameters
- **attributes** (array|Collection) - Required - An associative array or collection of attribute names and values.

### Request Example
```php
echo Div::attributes(['data-id' => '123', 'data-username' => 'John']);
```

### Response
#### Success Response
```html
<div data-id="123" data-username="John"></div>
```
```

--------------------------------

### span($contents = null): Span

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/html-builder.md

Creates a span element. Returns an instance of Spatie\Html\Elements\Span.

```APIDOC
## span($contents = null): Span

### Description
Creates a span element. Returns an instance of Spatie\Html\Elements\Span.

### Method
- (PHP method)

### Parameters
- **$contents** (mixed|null) - Optional - The contents of the span.

### Returns
- **Span** - An instance of Spatie\Html\Elements\Span.
```

--------------------------------

### option($text = null, $value = null, $selected = false): Option

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/html-builder.md

Creates an option element. Returns an instance of Spatie\Html\Elements\Option.

```APIDOC
## option($text = null, $value = null, $selected = false): Option

### Description
Creates an option element. Returns an instance of Spatie\Html\Elements\Option.

### Method
- (PHP method)

### Parameters
- **$text** (string|null) - Optional - The text content of the option.
- **$value** (string|null) - Optional - The value attribute.
- **$selected** (bool) - Optional - Whether the option is selected (default: false).

### Returns
- **Option** - An instance of Spatie\Html\Elements\Option.
```

--------------------------------

### multiselect($name = null, $options = [], $value = null): Select

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/html-builder.md

Creates a multi-select element. Returns an instance of Spatie\Html\Elements\Select.

```APIDOC
## multiselect($name = null, $options = [], $value = null): Select

### Description
Creates a multi-select element. Returns an instance of Spatie\Html\Elements\Select.

### Method
- (PHP method)

### Parameters
- **$name** (string|null) - Optional - The name attribute.
- **$options** (array) - Optional - The options for the select.
- **$value** (mixed|null) - Optional - The selected value(s).

### Returns
- **Select** - An instance of Spatie\Html\Elements\Select.
```

--------------------------------

### fieldset($legend = null): Fieldset

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/html-builder.md

Creates a fieldset element. Returns an instance of Spatie\Html\Elements\Fieldset.

```APIDOC
## fieldset($legend = null): Fieldset

### Description
Creates a fieldset element. Returns an instance of Spatie\Html\Elements\Fieldset.

### Method
- (PHP method)

### Parameters
- **$legend** (string|null) - Optional - The legend text.

### Returns
- **Fieldset** - An instance of Spatie\Html\Elements\Fieldset.
```

--------------------------------

### attribute()

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/element-methods.md

Sets an attribute on the element. This method is part of the Spatie Laravel HTML package and can be chained fluently.

```APIDOC
## attribute()

### Description
Sets an attribute on the element.

### Method
attribute()

### Parameters
- **name** (string) - Required - The attribute name.
- **value** (string) - Required - The attribute value.

### Request Example
```php
echo Div::attribute('data-custom', 'Attribute value');
```

### Response
#### Success Response
```html
<div data-custom="Attribute value"></div>
```
```

--------------------------------

### id() method

Source: https://github.com/spatie/laravel-html/blob/main/docs/general-usage/element-methods.md

Sets the id attribute, overwriting any previously set id.

```php
echo Div::id('btn-123');
// "<div id="btn-123"></div>"
```
Tokens:
Raw