html_attributes.md

HTML атрибуты

Данный trait используется для организации работы с HTML атрибутами в классах. Это может пригодится, если вы создаете например класс, который на выходе будет преобразован в HTML и необходимо дать пользователю возможность указать css классы, идентификатор и другие атрибуты для элемента.

Допустим у нас есть класс TableColumn, который преобразуется в <td>{{ $value }}</td> и вы хотите дать пользователю возможность указывать атрибуты, чтобы на выходе получить <td class="bg-primary" id="row-3" data-value="test"></test>

Для этого классу необходимо подключить данный trait

<?php

namespace SleepingOwl\Admin\Display;

use KodiComponents\Support\HtmlAttributes;
use Illuminate\Contracts\Support\Arrayable;
use Illuminate\Contracts\Support\Renderable;

class TableColumn implements Arrayable, Renderable
{
    use HtmlAttributes;
    
    public function toArray()
    {
        return [
            'value' => 'test',
            'attributes' => $this->htmlAttributesToString(),
        ];
    }

    public function render()
    {
        return view(
            'table_column',
            $this->toArray()
        );
    }
}

<td {{ $attributes }}>{{ $value }}</td>

И теперь можно данному классу можно назначать атрибуты

API

setHtmlAttribute

Указание HTML атрибута

$column->setHtmlAttribute('class', 'bg-primary');
$column->setHtmlAttribute('class', 'text-right');
$column->setHtmlAttribute('id', 'row-3');
$column->setHtmlAttribute('data-value', 'test');

// Или в виде массива

$column->setHtmlAttributes([
   'class' => ['bg-primary', 'text-right'],
   'id' => 'row-3',
   'data-value' => 'test'
]);

// return <td class="bg-primary text-right" id="row-3" data-value="test">test</td>

replaceHtmlAttribute

Переопределение класса

$column->replaceHtmlAttribute('class', 'new-class');

// return <td class="new-class" id="row-3" data-value="test">test</td>

hasClassProperty

Проверка на существование класса

$column->setHtmlAttribute('class', 'new-class');
$column->hasClassProperty('new-class'); // return true

hasHtmlAttribute

Проверка на существование атрибута

$column->setHtmlAttribute('data-value', 'test');
$column->hasHtmlAttribute('data-value'); // return true

removeHtmlAttribute

Удаление атрибута

$column->removeHtmlAttribute('data-value');

clearHtmlAttributes

Удаление всех атрибутов

$column->clearHtmlAttributes();

htmlAttributesToString

Преобразование атрибутов в строку

$column->htmlAttributesToString();
// return "class="new-class" id="row-3" data-value="test""