https://github.com/ui-awesome/html-interop
UI Awesome HTML Common Interfaces for PHP.
https://github.com/ui-awesome/html-interop
List: html-interop
html-interop php ui-awesome
Last synced: about 2 months ago
JSON representation
UI Awesome HTML Common Interfaces for PHP.
- Host: GitHub
- URL: https://github.com/ui-awesome/html-interop
- Owner: ui-awesome
- License: mit
- Created: 2024-03-05T08:18:40.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-09T11:31:23.000Z (about 2 years ago)
- Last Synced: 2025-02-07T08:02:01.261Z (about 1 year ago)
- Topics: html-interop, php, ui-awesome
- Language: PHP
- Homepage:
- Size: 15.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Html interop
Common interfaces and type-safe enums for HTML tag interoperability
Provides standardized contracts and tag collections for block, inline, list, root, table, and void elements.
## Features
### Installation
```bash
composer require ui-awesome/html-interop:^0.3
```
### Quick start
#### Using block-level HTML tags
Access standardized block-level tag names through the `Block` enum.
```php
value;
// 'div'
echo Block::ARTICLE->value;
// 'article'
echo Block::SECTION->value;
// 'section'
```
#### Using inline-level HTML tags
Access standardized inline-level tag names through the `Inline` enum.
```php
value;
// 'span'
echo Inline::STRONG->value;
// 'strong'
echo Inline::A->value;
// 'a'
```
#### Using void (self-closing) HTML tags
Access standardized void element tag names through the `Voids` enum.
```php
value;
// 'img'
echo Voids::INPUT->value;
// 'input'
echo Voids::BR->value;
// 'br'
```
#### Using specialized HTML tag collections
Use specialized enums for list, root, and table elements.
```php
value;
// 'ul'
echo Lists::OL->value;
// 'ol'
echo Lists::LI->value;
// 'li'
// Root elements
echo Root::HTML->value;
// 'html'
echo Root::HEAD->value;
// 'head'
echo Root::BODY->value;
// 'body'
// Table elements
echo Table::TABLE->value;
// 'table'
echo Table::THEAD->value;
// 'thead'
echo Table::TR->value;
// 'tr'
echo Table::TD->value;
// 'td'
```
#### Type safety with interfaces
Use the provided interfaces to ensure type safety in your tag rendering implementations.
```php
%s%s>', $tag->value, $content, $tag->value);
}
echo renderBlock(Block::DIV, 'Content');
//
Content
echo renderBlock(Block::ARTICLE, 'Article content');
// Article content
```
#### Filtering and iterating tags
Leverage PHP 8.1+ enum features for filtering and tag operations.
```php
str_starts_with($tag->name, 'H'),
);
foreach ($headings as $heading) {
echo $heading->value . PHP_EOL;
}
// h1
// h2
// h3
// h4
// h5
// h6
// Get all block tag names
$tagNames = array_map(fn (Block $tag) => $tag->value, Block::cases());
```
#### Extensibility
Create custom tag collections by implementing the core interfaces backed by string enums.
- `\UIAwesome\Html\Interop\BlockInterface`: For container elements that have content and a closing tag.
- `\UIAwesome\Html\Interop\InlineInterface`: For text-level elements.
- `\UIAwesome\Html\Interop\VoidInterface`: For self-closing elements (no closing tag).
You can create custom enums for your specific domain (for example, SVG, MathML, or Web Components) and use them across multiple packages.
```php
value}>$content{$tag->value}>";
}
echo renderAnyBlock(SvgTag::G, '...');
// ...
```
## Documentation
For detailed configuration options and advanced usage.
- 🧪 [Testing Guide](docs/testing.md)
- 🛠️ [Development Guide](docs/development.md)
## Package information
[](https://www.php.net/releases/8.1/en.php)
[](https://packagist.org/packages/ui-awesome/html-interop)
[](https://packagist.org/packages/ui-awesome/html-interop)
## Quality code
[](https://github.com/ui-awesome/html-interop/actions/workflows/static.yml)
[](https://github.com/ui-awesome/html-interop/actions/workflows/linter.yml)
[](https://github.styleci.io/repos/767397797?branch=main)
## Our social networks
[](https://x.com/Terabytesoftw)
## License
[](LICENSE)