{"id":19300565,"url":"https://github.com/stefanwimmer128/html-builder","last_synced_at":"2025-10-30T03:02:44.463Z","repository":{"id":57059449,"uuid":"300853165","full_name":"stefanwimmer128/html-builder","owner":"stefanwimmer128","description":"[Mirror for https://git.stefanwimmer128.eu/stefanwimmer128/rss-builder] A fully extensible HTML-Builder supporting emmet input","archived":false,"fork":false,"pushed_at":"2022-09-11T18:20:47.000Z","size":78,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-05T22:43:38.216Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://packagist.org/packages/stefanwimmer128/html-builder","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stefanwimmer128.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-10-03T10:25:07.000Z","updated_at":"2022-09-11T17:50:38.000Z","dependencies_parsed_at":"2022-08-24T14:53:27.943Z","dependency_job_id":null,"html_url":"https://github.com/stefanwimmer128/html-builder","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stefanwimmer128%2Fhtml-builder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stefanwimmer128%2Fhtml-builder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stefanwimmer128%2Fhtml-builder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stefanwimmer128%2Fhtml-builder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stefanwimmer128","download_url":"https://codeload.github.com/stefanwimmer128/html-builder/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240402387,"owners_count":19795721,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-09T23:15:12.626Z","updated_at":"2025-10-30T03:02:39.445Z","avatar_url":"https://github.com/stefanwimmer128.png","language":"PHP","readme":"# stefanwimmer128/html-builder\n\nA fully extensible HTML-Builder supporting emmet input\n\n- [Installation](#installation)\n- [Example](#example)\n- [Special Elements](#special-elements)\n- [API Documentation](#api-documentation)\n- [Writing extensions](#writing-extensions)\n\n## [Installation](#installation)\n\n```shell script\ncomposer require stefanwimmer128/html-builder\n```\n\n## [Example](#example)\n\n```php\nuse function Stefanwimmer128\\HtmlBuilder\\render;\nuse function Stefanwimmer128\\HtmlBuilder\\h;\nuse function Stefanwimmer128\\HtmlBuilder\\capture;\nuse function Stefanwimmer128\\HtmlBuilder\\map;\n\n$test = '\u003cp\u003eTEST\u003c/p\u003e';\n\n$values = [\n    'a' =\u003e 0,\n    'b' =\u003e 1,\n    'c' =\u003e 2,\n];\n\nrender(h('xml[version=\"1.0\" standalone=yes]', [], [\n   h('doctype', 'html', [\n       h('html[lang=en]', [], [\n           h('head \u003e title{Hello World!}'),\n           h('body', [], [\n               h('.container.container-content#container-content-main', [], [\n                   h('a[href=\"#\"][disabled]', 'LINK'),\n                   '\u003cp\u003eTEST\u003c/p\u003e',\n                   capture('printf', '%s', $test)\n               ]),\n               h('comment', 'COMMENT'),\n               h('p', ['data-values' =\u003e json_encode($values, JSON_THROW_ON_ERROR)], [\n                   h('b', 'LIST:'),\n                   h('br'),\n                   map($values, fn($value, $key) =\u003e h('span', ['data-key' =\u003e $key], $value))\n               ])\n           ])\n       ])\n   ])\n]));\n```\n\n```html\n\u003c?xml version=\"1.0\" standalone=\"yes\" ?\u003e\u003c!DOCTYPE html\u003e\u003chtml lang=\"en\"\u003e\u003chead\u003e\u003ctitle\u003eHello World!\u003c/title\u003e\u003c/head\u003e\u003cbody\u003e\u003cdiv class=\"container container-content\" id=\"container-content-main\"\u003e\u003ca href=\"#\" disabled\u003eLINK\u003c/a\u003e\u0026lt;p\u0026gt;TEST\u0026lt;/p\u0026gt;\u003cp\u003eTEST\u003c/p\u003e\u003c/div\u003e\u003c!-- COMMENT --\u003e\u003cp data-values=\"{\u0026quot;a\u0026quot;:0,\u0026quot;b\u0026quot;:1,\u0026quot;c\u0026quot;:2}\"\u003e\u003cb\u003eLIST:\u003c/b\u003e\u003cbr /\u003e\u003cspan data-key=\"a\"\u003e0\u003c/span\u003e\u003cspan data-key=\"b\"\u003e1\u003c/span\u003e\u003cspan data-key=\"c\"\u003e2\u003c/span\u003e\u003c/p\u003e\u003c/body\u003e\u003c/html\u003e\n```\n\n## [Special Elements](#special-elements)\n\n- [`comment`](#comment)\n- [`doctype`](#doctype)\n- [`lorem` / `lipsum`](#lorem--lipsum)\n- [`xml`](#xml)\n\nThe following elements are special.\n\nThus, if you want to use the keywords as simple tags, you will have to use the special `tag` function:\n\n```php\nuse function Stefanwimmer128\\HtmlBuilder\\render;\nuse function Stefanwimmer128\\HtmlBuilder\\h;\nuse function Stefanwimmer128\\HtmlBuilder\\tag;\n\nrender(h('comment', 'Test'));\nrender(tag('comment', 'Test'));\n```\n\n```html\n\u003c!-- Test --\u003e\n\u003ccomment\u003eTest\u003c/comment\u003e\n```\n\n### [`comment`](#comment)\n\nGenerate HTML comment. Any string(s) or `HtmlElement`(s) can be used as children.\n\n```php\nuse function Stefanwimmer128\\HtmlBuilder\\render;\nuse function Stefanwimmer128\\HtmlBuilder\\h;\n\nrender(h('comment', 'Test'));\n```\n\n```html\n\u003c!-- Test --\u003e\n```\n\n### [`doctype`](#doctype)\n\nGenerate HTML doctype. Can receive children, that will be rendered after tag.\n\n```php\nuse function Stefanwimmer128\\HtmlBuilder\\render;\nuse function Stefanwimmer128\\HtmlBuilder\\h;\n\nrender(h('doctype', 'html', ...$children));\n```\n\n```html\n\u003c!DOCTYPE html\u003e...children...\n```\n\n### [`lorem` / `lipsum`](#lorem--lipsum)\n\nGenerates lorem ipsum text (default: 30 words).\n\nTo set the number of words to generate append it to the tag: `lorem20` generates 20 words, `lipsum40` generates 40 words.\n\n```php\nuse function Stefanwimmer128\\HtmlBuilder\\render;\nuse function Stefanwimmer128\\HtmlBuilder\\h;\n\nrender(h('lorem50'));\n```\n\nGenerates 50 words of lorem ipsum.\n\n### [`xml`](#xml)\n\nCreate XML header. Works pretty similar to a html tag.\n\n```php\nuse function Stefanwimmer128\\HtmlBuilder\\render;\nuse function Stefanwimmer128\\HtmlBuilder\\h;\n\nrender(h('xml[version=\"1.0\"]', [], ...$children));\n```\n\n```html\n\u003c?xml version=\"1.0\" ?\u003e...children...\n```\n\n## [API Documentation](#api-documentation)\n\n- [`h(string $input, ...$args): HtmlElement`](#hstring-input-args-htmlelement) Create element from input using parser (default: Emmet)\n- [`tag(string $tag = 'div', ...$args): HtmlTag`](#tagstring-tag--div-args-htmltag) Create tag element\n- [`text(string $text): HtmlText`](#textstring-text-htmltext) Create text element\n- [`raw(string $value): RawString`](#rawstring-value-rawstring) Create raw string\n- [`capture(callable $callable, ...$args): RawString`](#capturecallable-callable-args-rawstring) Captures output (echo) and returns it as raw string\n- [`map(array $array, callable $callable): array`](#maparray-array-callable-callable-array) array_map with keys\n- [`render(...$elements): string`](#renderelements-string) Render elements as HTML\n\n### [`h(string $input, ...$args): HtmlElement`](#hstring-input-args-htmlelement)\n\nCreate element from input using parser (default: Emmet)\n\nAlso works like [`tag()`](#tagstring-tag--div-args-htmltag).\n\n```php\nuse function Stefanwimmer128\\HtmlBuilder\\render;\nuse function Stefanwimmer128\\HtmlBuilder\\h;\n\nrender(h('table[border=0] \u003e thead \u003e .row \u003e .col', 'Content'));\nrender(h('div', [], 'Some text \u003cb\u003ewith html\u003c/b\u003e'));\n```\n\n```html\n\u003ctable border=\"0\"\u003e\u003cthead\u003e\u003ctr class=\"row\"\u003e\u003ctd class=\"col\"\u003eContent\u003c/td\u003e\u003c/tr\u003e\u003c/thead\u003e\u003c/table\u003e\n\u003cdiv\u003eSome text \u0026lt;p\u0026gt;with html\u0026lt;/b\u0026gt;\u003c/div\u003e\n```\n\n### [`tag(string $tag = 'div', ...$args): HtmlTag`](#tagstring-tag--div-args-htmltag)\n\nCreate tag element\n\n```php\nuse function Stefanwimmer128\\HtmlBuilder\\render;\nuse function Stefanwimmer128\\HtmlBuilder\\tag;\n\nrender(tag('div', ['class' =\u003e 'container'], [\n    'Text',\n    tag('p', 'Some text \u003cb\u003ewith html\u003c/b\u003e')\n]));\n```\n\n```html\n\u003cdiv class=\"container\"\u003eText\u003cp\u003eSome text \u0026lt;p\u0026gt;with html\u0026lt;/b\u0026gt;\u003c/p\u003e\u003c/div\u003e\n```\n\n### [`text(string $text): HtmlText`](#textstring-text-htmltext)\n\nCreate text element\n\nThis is automatically applied to strings that are passed as children to [`h()`](#hstring-input-args-htmlelement) or [`tag()`](#tagstring-tag--div-args-htmltag).\n\n```php\nuse function Stefanwimmer128\\HtmlBuilder\\render;\nuse function Stefanwimmer128\\HtmlBuilder\\text;\n\nrender(text('Some text \u003cb\u003ewith html\u003c/b\u003e'));\n```\n\n```html\nSome text \u0026lt;p\u0026gt;with html\u0026lt;/b\u0026gt;\n```\n\n### [`raw(string $value): RawString`](#rawstring-value-rawstring)\n\nCreate raw string\n\n```php\nuse function Stefanwimmer128\\HtmlBuilder\\render;\nuse function Stefanwimmer128\\HtmlBuilder\\raw;\n\nrender(raw('Some text \u003cb\u003ewith html\u003c/b\u003e'));\n```\n\n```html\nSome text \u003cb\u003ewith html\u003c/b\u003e\n```\n\n### [`capture(callable $callable, ...$args): RawString`](#capturecallable-callable-args-rawstring)\n\nCaptures output (echo) and returns it as raw string\n\nUseful with functions that instead of returning the markup directly output it (eg. Wordpress).\n\n```php\nuse function Stefanwimmer128\\HtmlBuilder\\render;\nuse function Stefanwimmer128\\HtmlBuilder\\tag;\nuse function Stefanwimmer128\\HtmlBuilder\\capture;\n\nrender(tag('div', [], capture('the_widget', 'widget')));\n```\n\n```html\n\u003cdiv\u003e...widget markup...\u003c/div\u003e\n```\n\n### [`map(array $array, callable $callable): array`](#maparray-array-callable-callable-array)\n\narray_map with keys\n\n```php\nuse function Stefanwimmer128\\HtmlBuilder\\render;\nuse function Stefanwimmer128\\HtmlBuilder\\tag;\nuse function Stefanwimmer128\\HtmlBuilder\\map;\n\n$values = [\n    'key0' =\u003e 'value0',\n    'key1' =\u003e 'value1',\n];\n\nrender(tag('ul', [], map($values, fn($value, $key) =\u003e tag('li', ['id' =\u003e $key], $value))));\n```\n\n```html\n\u003cul\u003e\u003cli id=\"key0\"\u003evalue0\u003c/li\u003e\u003cli id=\"key1\"\u003evalue1\u003c/li\u003e\u003c/ul\u003e\n```\n\n### [`render(...$elements): string`](#renderelements-string)\n\nRender elements as HTML\n\nSee all the above.\n\n## [Writing extensions](#writing-extensions)\n\n- [Creating a custom element](#creating-a-custom-element)\n- [Creating a custom parser](#creating-a-custom-parser)\n\n### [Creating a custom element](#creating-a-custom-element)\n\nAny custom element must extend `\\Stefanwimmer128\\HtmlBuilder\\HtmlElement`.\n\nFirst you create your element class:\n\n```php\nuse Stefanwimmer128\\HtmlBuilder\\HtmlElement;\n\nclass CustomElement extends HtmlElement {\n    private string $someData;\n    \n    public function __construct(string $someData) {\n        $this-\u003esomeData = $someData;\n    }\n    \n    public function render(): string {\n        return sprintf('(%s)', $this-\u003esomeData);\n    }\n}\n```\n\nIf your element is tag-like, you might want to extend `\\Stefanwimmer128\\HtmlBuilder\\HtmlTag`:\n\n```php\nuse Stefanwimmer128\\HtmlBuilder\\HtmlTag;\n\nclass CustomElement extends HtmlTag {\n    public function __construct(...$args) {\n        parent::__construct('custom', ...$args);\n    }\n    \n    public function render(): string {\n        return sprintf('(%s)%s', $this-\u003erenderAttributes(), $this-\u003erenderChildren());\n    }\n}\n```\n\nIf your custom element should receive parsed information, your element must implement `\\Stefanwimmer128\\HtmlBuilder\\Parser\\ParserCompatibleElement`.\n\nAfter which you have to register your element, by putting this code before your usage of the element:\n\n```php\nuse Stefanwimmer128\\HtmlBuilder\\HtmlElement;\n\nHtmlElement::$ELEMENTS['custom'] = CustomElement::class;\n```\n\n### [Creating a custom parser](#creating-a-custom-parser)\n\nAny parser must extend `\\Stefanwimmer128\\HtmlBuilder\\Parser\\AbstractParser`.\n\nSince creating a custom parser is very much tied to what you want to parse, please orientate yourself using the included `\\Stefanwimmer128\\HtmlBuilder\\Parser\\Emmet\\EmmetParser`.\n\n```php\nuse Stefanwimmer128\\HtmlBuilder\\Parser\\AbstractParser;\n\nclass CustomParser extends AbstractParser {\n    public function __construct(string $input) {\n        // your parsing logic goes here\n    }\n    \n    public function getTag(): string {\n        // return tag here\n    }\n    \n    public function getAttributes(): array {\n        // return attributes here\n    }\n    \n    public function getClasses(): array {\n        // return classes here\n    }\n    \n    public function getId(): ?string {\n        // return id here if provided or null\n    }\n    \n    public function getText() : ?string {\n        // return text here if provided or null\n    }\n    \n    public function getChild() : ?AbstractParser {\n        // return child here if provided or null\n    }\n    \n    public function isSelfclosing() : ?bool{\n        // return whether tag self-closes if provided or null\n    }\n}\n```\n\nAfter which you can set your parser by:\n\n```php\nuse Stefanwimmer128\\HtmlBuilder\\Parser\\AbstractParser;\n\nAbstractParser::$DEFAULT_PARSER = CustomParser::class;\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstefanwimmer128%2Fhtml-builder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstefanwimmer128%2Fhtml-builder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstefanwimmer128%2Fhtml-builder/lists"}