Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yiisoft/html
Handy library to generate HTML
https://github.com/yiisoft/html
hacktoberfest html yii3
Last synced: 2 days ago
JSON representation
Handy library to generate HTML
- Host: GitHub
- URL: https://github.com/yiisoft/html
- Owner: yiisoft
- License: bsd-3-clause
- Created: 2019-07-23T13:07:30.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-09T17:52:31.000Z (6 months ago)
- Last Synced: 2024-04-14T09:45:20.695Z (6 months ago)
- Topics: hacktoberfest, html, yii3
- Language: PHP
- Homepage: https://www.yiiframework.com/
- Size: 535 KB
- Stars: 53
- Watchers: 20
- Forks: 18
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
Yii HTML
[](https://packagist.org/packages/yiisoft/html)
[](https://packagist.org/packages/yiisoft/html)
[](https://github.com/yiisoft/html/actions/workflows/build.yml)
[](https://codecov.io/gh/yiisoft/html)
[](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/html/master)
[](https://github.com/yiisoft/html/actions?query=workflow%3A%22static+analysis%22)
[](https://shepherd.dev/github/yiisoft/html)
[](https://shepherd.dev/github/yiisoft/html)
The package provides various tools to help with dynamic server-side generation of HTML:
- Tag classes `A`, `Address`, `Article`, `Aside`, `Audio`, `B`, `Body`, `Br`, `Button`, `Caption`, `Col`, `Colgroup`,
`Datalist`, `Div`, `Em`, `Fieldset`, `Footer`, `Form`, `H1`, `H2`, `H3`, `H4`, `H5`, `H6`, `Header`, `Hr`, `Hgroup`,
`Html`, `I`, `Img`, `Input` (and specialized `Checkbox`, `Radio`, `Range`, `File`), `Label`, `Legend`, `Li`, `Link`,
`Meta`, `Nav`, `Noscript`, `Ol`, `Optgroup`, `Option`, `P`, `Picture`, `Script`, `Section`, `Select`, `Small`,
`Source`, `Span`, `Strong`, `Style`, `Table`, `Tbody`, `Td`, `Textarea`, `Tfoot`, `Th`, `Thead`, `Title`, `Tr`,
`Track`, `Ul`, `Video`.
- `CustomTag` class that helps to generate custom tag with any attributes.
- HTML widgets `ButtonGroup`, `CheckboxList` and `RadioList`.
- All tags content is automatically HTML-encoded. There is `NoEncode` class designed to wrap content that should not be encoded.
- `Html` helper that has static methods to generate HTML, create tags and HTML widget objects.
Note that for simple static-HTML cases, it is preferred to use HTML directly.
## Requirements
- PHP 8.0 or higher.
## Installation
The package could be installed with [Composer](https://getcomposer.org):
```shell
composer require yiisoft/html
```
## General usage
```php
= 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:
```php
echo \Yiisoft\Html\Tag\Div::tag()
->content(
\Yiisoft\Html\Tag\A::tag()
->mailto('[email protected]')
->content('contact us')
->render()
)
->encode(false)
->id('ContactEmail')
->class('red');
```
... will generate the following HTML:
```html
```
### Generating custom tags
To generate custom tags, use the `CustomTag` class. For example, the following code:
```php
echo \Yiisoft\Html\Tag\CustomTag::name('b')
->content('text')
->attribute('title', 'Important');
```
... will generate the following HTML:
```html
text
```
### Encoding tags content
By default, stringable objects that implement `\Yiisoft\Html\NoEncodeStringableInterface` are not encoded,
everything else is encoded.
To change this behavior use `encode()` method passing one of the following values:
- `null`: default behavior;
- `true`: any content is encoded;
- `false`: nothing is encoded.
> Note: all bundled tags and widgets implement `\Yiisoft\Html\NoEncodeStringableInterface` interface and are not encoded
> by default when passed as content. Their own content is encoded.
Examples:
```php
// <i>hello</i>
echo Html::b('hello');
// hello
echo Html::b('hello')->encode(false);
// hello
echo Html::b(Html::i('hello'));
// <i>hello</i>
echo Html::b(Html::i('hello'))->encode(true);
```
In order to mark a string as "do not encode" you can use `\Yiisoft\Html\NoEncode` class:
```php
// hello
echo Html::b(NoEncode::string('hello'));
```
## 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.
### `ButtonGroup`
Represents a group of buttons.
```php
echo \Yiisoft\Html\Widget\ButtonGroup::create()
->buttons(
\Yiisoft\Html\Html::resetButton('Reset Data'),
\Yiisoft\Html\Html::resetButton('Send'),
)
->containerAttributes(['class' => 'actions'])
->buttonAttributes(['form' => 'CreatePost']);
```
Result will be:
```html
Reset Data
Send
```
### `CheckboxList`
Represents a list of checkboxes.
```php
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:
```html
One
Two
Five
```
### `RadioList`
Represents a list of radio buttons.
```php
echo \Yiisoft\Html\Widget\RadioList\RadioList::create('count')
->items([1 => 'One', 2 => 'Two', 5 => 'Five'])
->uncheckValue(0)
->value(2)
->containerAttributes(['id' => 'main']);
```
Result will be:
```html
One
Two
Five
```
## `Html` helper usage
`Html` helper methods are static so usage is:
```php
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
- b
- div
- em
- i
- hr
- meta
- p
- br
- script
- noscript
- span
- strong
- small
- style
- title
#### Media tags
- img
- picture
- audio
- video
- track
- source
#### Heading tags
- h1
- h2
- h3
- h4
- h5
- h6
#### Section tags
- html
- body
- article
- section
- nav
- aside
- hgroup
- header
- footer
- address
#### List tags
- ul
- ol
- li
#### Hyperlink tags
- a
- mailto
#### Link tags
- link
- cssFile
- javaScriptFile
#### Form tags
- button
- buttonInput
- checkbox
- file
- datalist
- fieldset
- fileInput
- form
- hiddenInput
- input
- label
- legend
- 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
## Documentation
- [Internals](docs/internals.md)
If you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place for
that. You may also check out other [Yii Community Resources](https://www.yiiframework.com/community).
## License
The Yii HTML is free software. It is released under the terms of the BSD License.
Please see [`LICENSE`](./LICENSE.md) for more information.
Maintained by [Yii Software](https://www.yiiframework.com/).
## Support the project
[](https://opencollective.com/yiisoft)
## Follow updates
[](https://www.yiiframework.com/)
[](https://twitter.com/yiiframework)
[](https://t.me/yii3en)
[](https://www.facebook.com/groups/yiitalk)
[](https://yiiframework.com/go/slack)