Skip to content

Commit 5eb719a

Browse files
committed
docs: add readme
1 parent eb07f78 commit 5eb719a

1 file changed

Lines changed: 20 additions & 4 deletions

File tree

templates/twig-component/README.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
1-
# HTML Component Bundle
1+
# HTML5 Elements as Twig Components
22

3-
Symfony UX Twig Components for all HTML5 elements with ARIA support.
3+
Symfony UX Twig Components for all HTML5 elements with ARIA support, Enum validation for consistency and enforcing valid HTML5. Classes and templates as generated from the HTML5 specifications. This bundle is part of the [Extended HTMLDocument](https://github.com/vardumper/extended-htmldocument) library built ontop of PHP's DOM\HTMLDocument.
4+
5+
## Requirements
6+
* PHP 8.4 – the underlying Extended HTMLDocument library is built upon PHPs DOM\HTMLDocument which is available since PHP 8.4+
7+
8+
Since only the Enums are used for attribute validation here, adding support for older PHP versions could be done easily if it's needed or requested.
49

510
## Installation
611

@@ -22,7 +27,7 @@ return [
2227
];
2328
```
2429

25-
Next, configure tell Symfony where to find your component atoms by adding this path to `config/packages/twig_component.yaml`.
30+
Next, tell Symfony that Twig Components can be found in a new path. Edit `config/packages/twig_component.yaml` and add the following:
2631

2732
```yaml
2833
# config/packages/twig_component.yaml
@@ -62,4 +67,15 @@ Use any HTML element as a Twig Component:
6267
Components are organized by type:
6368
- `Block` - Block-level elements (div, section, article, etc.)
6469
- `Inline` - Inline elements (span, a, strong, etc.)
65-
- `Void` - Self-closing elements (img, input, br, etc.)
70+
- `Void` - Self-closing elements (img, input, br, etc.)
71+
72+
73+
## Read More
74+
* [Extended HTMLDocument Documentation](https://vardumper.github.io/extended-htmldocument/)
75+
* [Extended HTMLDocument Github Repository](https://github.com/vardumper/extended-htmldocument)
76+
* [Twig Components](https://symfony.com/bundles/ux-twig-component/current/index.html)
77+
* [Symfony UX](https://ux.symfony.com/)
78+
79+
## Issues & Bugs
80+
81+
Please report issues in this packages home at [Extended HTMLDocument](https://github.com/vardumper/extended-htmldocument)

0 commit comments

Comments
 (0)