PHP Classes

File: docs/README.md

Recommend this page to a friend!
  Classes of Juan Camacho   Hypertool   docs/README.md   Download  
File: docs/README.md
Role: Documentation
Content type: text/markdown
Description: Documentation
Class: Hypertool
Compose and generate HTML pages from objects
Author: By
Last change:
Date: 18 days ago
Size: 5,927 bytes
 

Contents

Class file image Download

Hypertool HTML Generator - Documentation

License: MIT <!-- Adjust path if LICENSE is in root --> HTMX Hyperscript GitHub Repo <!-- Update link -->

Welcome to the official documentation for the Hypertool HTML Generator library!

This library provides a powerful, flexible, and fluent PHP interface for generating HTML, with first-class support for modern frontend techniques using HTMX and Hyperscript.

? Getting Started

New to the library? Here's how to get up and running quickly:

  1. Installation: Follow the Composer installation instructions in the main project README.
  2. Basic Usage: Check out the basic usage examples to see how to create elements.
  3. Framework Integration: See examples for HTMX & Hyperscript and the Automated Script Injection system.
  4. Run Examples: Explore the runnable code examples in the ../examples/ directory.

? Core Class Documentation

Dive deeper into the main components of the library:

  • HtmlElement: The core class for creating and manipulating all HTML elements. Learn about its API, attribute setters, child management, and HTMX/Hyperscript integration.
  • ScriptManager: Understand how to use the automated system for injecting `htmx.js` and `hyperscript.js` conditionally and efficiently into your layouts.

? Key Features

  • ? Full HTML Coverage: Classes and factories for all HTML5 & deprecated elements.
  • ? Fluent Interface: Chain methods for cleaner code (`->setId()->setClass()->...`).
  • ? HTMX & Hyperscript Ready: Dedicated setters for `hx-*` and `_` attributes.
  • ?? Smart Script Loading: Automated, conditional, environment-aware script injection via `ScriptManager`.
  • ? Composer Ready: Easily integrate into your projects with PSR-4 autoloading.
  • ? Well Documented: Comprehensive class documentation and usage examples.

? Contributing

Found a bug or have an idea? We welcome contributions!

? Useful Links

License: MIT <!-- Adjust path if LICENSE is in root --> HTMX Hyperscript GitHub Repo <!-- Update link -->

Welcome to the official documentation for the Hypertool HTML Generator library!

This library provides a powerful, flexible, and fluent PHP interface for generating HTML, with first-class support for modern frontend techniques using HTMX and Hyperscript.

? Getting Started

New to the library? Here's how to get up and running quickly:

  1. Installation: Follow the Composer installation instructions in the main project README.
  2. Basic Usage: Check out the basic usage examples to see how to create elements.
  3. Framework Integration: See examples for HTMX & Hyperscript and the Automated Script Injection system.
  4. Run Examples: Explore the runnable code examples in the ../examples/ directory.

? Core Class Documentation

Dive deeper into the main components of the library:

  • HtmlElement: The core class for creating and manipulating all HTML elements. Learn about its API, attribute setters, child management, and HTMX/Hyperscript integration.
  • ScriptManager: Understand how to use the automated system for injecting `htmx.js` and `hyperscript.js` conditionally and efficiently into your layouts.

? Key Features

  • ? Full HTML Coverage: Classes and factories for all HTML5 & deprecated elements.
  • ? Fluent Interface: Chain methods for cleaner code (`->setId()->setClass()->...`).
  • ? HTMX & Hyperscript Ready: Dedicated setters for `hx-*` and `_` attributes.
  • ?? Smart Script Loading: Automated, conditional, environment-aware script injection via `ScriptManager`.
  • ? Composer Ready: Easily integrate into your projects with PSR-4 autoloading.
  • ? Well Documented: Comprehensive class documentation and usage examples.

? Contributing

Found a bug or have an idea? We welcome contributions!

? Useful Links