yiisoft/html

Handy library to generate HTML

1.2.0 2021-05-04 16:29 UTC

This package is auto-updated.

Last update: 2021-05-04 16:29:33 UTC


README

68747470733a2f2f796969736f66742e6769746875622e696f2f646f63732f696d616765732f7969695f6c6f676f2e737667

Yii HTML


Latest Stable Version Total Downloads Build Status Scrutinizer Code Quality Code Coverage Mutation testing badge static analysis type-coverage

The package provides:

  • tag classes A, Br, Button, Div, Img, Input (and specialized Checkbox, Radio), Label, Li, Link, Meta, Ol, Optgroup, Option, P, Script, Select, Span, Style, Textarea, Ul, Table, Caption, Colgroup, Col, Thead, Tbody, Tfoot, Tr, Th, Td;
  • CustomTag class that helps to generate custom tag with any attributes;
  • HTML widgets CheckboxList and RadioList;
  • Html helper that has static methods to generate HTML, create tag and HTML widget objects.

Requirements

  • PHP 7.4 or higher.

Installation

composer require yiisoft/html --prefer-dist

General usage

<?php

use Yiisoft\Html\Html;
use Yiisoft\Html\Tag\Meta;

?>

<?= Meta::pragmaDirective('X-UA-Compatible', 'IE=edge') ?>
<?= Meta::data('viewport', 'width=device-width, initial-scale=1') ?>

<?= Html::cssFile(
    'https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css',
    [
        'integrity' => 'sha384-ggOyR0iXCbMQv3Xipma34MD+dH/1fQ784/j6cY/iJTQUOhcWr7x9JvoRxT2MZw1T',
        'crossorigin' => 'anonymous'
    ]
) ?>
<?= Html::cssFile('/css/site.css', ['rel' => 'stylesheet']) ?>

<?= Html::openTag('footer', ['class' => 'footer']) ?>
    <?= Html::openTag('div', ['class' => 'container flex-fill']) ?>
        <?= Html::p('', ['class' => 'float-left']) ?>
        <?= Html::p()->class('float-right')->content(
                'Powered by ',
                Html::a(
                    'Yii Framework',
                    'https://www.yiiframework.com/',
                    ['rel' => 'external']
                )
            ) ?>
    <?= Html::closeTag('div') ?>
<?= Html::closeTag('footer') ?>

Tag objects usage

Tag classes allow working with a tag as an object and then get an HTML code by using render() method or type casting to string. For example, the following code:

echo \Yiisoft\Html\Tag\Div::tag()
    ->content(
        \Yiisoft\Html\Tag\A::tag()
            ->mailto('info@example.com')
            ->content('contact us')
            ->render()
    )
    ->encode(false)
    ->id('ContactEmail')
    ->class('red');

... will generate the following HTML:

<div id="ContactEmail" class="red"><a href="mailto:info@example.com">contact us</a></div>

Generating custom tags

To generate custom tags, use the CustomTag class. For example, the following code:

echo \Yiisoft\Html\Tag\CustomTag::name('b')
    ->content('text')
    ->attribute('title', 'Important');

... will generate the following HTML:

<b title="Important">text</b>

HTML widgets usage

There are multiple widgets that do not directly represent any HTML tag, but a set of tags. These help to express complex HTML in simple PHP.

CheckboxList

Represents a list of checkboxes.

echo \Yiisoft\Html\Widget\CheckboxList\CheckboxList::create('count')
	->items([1 => 'One', 2 => 'Two', 5 => 'Five'])
	->uncheckValue(0)
	->value(2, 5)
	->containerAttributes(['id' => 'main']);

Result will be:

<input type="hidden" name="count" value="0">
<div id="main">
<label><input type="checkbox" name="count[]" value="1"> One</label>
<label><input type="checkbox" name="count[]" value="2" checked> Two</label>
<label><input type="checkbox" name="count[]" value="5" checked> Five</label>
</div>

RadioList

Represents a list of radio buttons.

echo \Yiisoft\Html\Widget\RadioList\RadioList::create('count')
    ->items([1 => 'One', 2 => 'Two', 5 => 'Five'])
    ->uncheckValue(0)
    ->value(2)
    ->containerAttributes(['id' => 'main'])
    ->render();

Result will be:

<input type="hidden" name="test" value="0">
<div id="main">
<label><input type="radio" name="test" value="1"> One</label>
<label><input type="radio" name="test" value="2" checked> Two</label>
<label><input type="radio" name="test" value="5"> Five</label>
</div>

Html helper usage

Html helper methods are static so usage is:

echo \Yiisoft\Html\Html::a('Yii Framework', 'https://www.yiiframework.com/');

Overall the helper has the following method groups.

Creating tag objects

Custom tags

  • tag
  • normalTag
  • voidTag

Base tags

  • div
  • img
  • meta
  • p
  • br
  • script
  • span
  • style

List tags

  • ul
  • ol
  • li

Hyperlink tags

  • a
  • mailto

Link tags

  • link
  • cssFile
  • javaScriptFile

Form tags

  • button
  • buttonInput
  • checkbox
  • fileInput
  • hiddenInput
  • input
  • label
  • optgroup
  • option
  • passwordInput
  • radio
  • resetButton
  • resetInput
  • select
  • submitButton
  • submitInput
  • textInput
  • textarea

Table tags

  • table
  • caption
  • colgroup
  • col
  • thead
  • tbody
  • tfoot
  • tr
  • th
  • td

Generating tag parts

  • openTag
  • closeTag
  • renderTagAttributes

Creating HTML widget objects

  • radioList
  • checkboxList

Working with tag attributes

  • generateId
  • getArrayableName
  • getNonArrayableName
  • normalizeRegexpPattern

Encode and escape special characters

  • encode
  • encodeAttribute
  • encodeUnquotedAttribute
  • escapeJavaScriptStringValue

Working with CSS styles and classes

  • addCssStyle
  • removeCssStyle
  • addCssClass
  • removeCssClass
  • cssStyleFromArray
  • cssStyleToArray

Testing

Unit testing

The package is tested with PHPUnit. To run tests:

./vendor/bin/phpunit

Mutation testing

The package tests are checked with Infection mutation framework with Infection Static Analysis Plugin. To run it:

./vendor/bin/roave-infection-static-analysis-plugin

Static analysis

The code is statically analyzed with Psalm. To run static analysis:

./vendor/bin/psalm

License

The Yii HTML is free software. It is released under the terms of the BSD License. Please see LICENSE for more information.

Maintained by Yii Software.

Support the project

Open Collective

Follow updates

Official website Twitter Telegram Facebook Slack