|
| 1 | +<!DOCTYPE html> |
| 2 | +<!-- |
| 3 | +
|
| 4 | + Copyright 2023 Red Hat |
| 5 | +
|
| 6 | + Licensed under the Apache License, Version 2.0 (the "License"); |
| 7 | + you may not use this file except in compliance with the License. |
| 8 | + You may obtain a copy of the License at |
| 9 | +
|
| 10 | + https://www.apache.org/licenses/LICENSE-2.0 |
| 11 | +
|
| 12 | + Unless required by applicable law or agreed to in writing, software |
| 13 | + distributed under the License is distributed on an "AS IS" BASIS, |
| 14 | + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 15 | + See the License for the specific language governing permissions and |
| 16 | + limitations under the License. |
| 17 | +
|
| 18 | +--> |
| 19 | +<html lang="en"> |
| 20 | +<head> |
| 21 | + <meta charset="UTF-8"> |
| 22 | +</head> |
| 23 | +<body> |
| 24 | +Elemento is a modern, type-safe Java library for building web user interfaces using |
| 25 | +<a href="https://www.gwtproject.org/">GWT</a> and <a href="https://github.com/google/j2cl">J2CL</a>. |
| 26 | +It provides a fluent builder API that makes creating and manipulating DOM elements natural and intuitive, |
| 27 | +eliminating the verbosity of traditional DOM manipulation. |
| 28 | + |
| 29 | +<h2>Overview</h2> |
| 30 | + |
| 31 | +<p>Elemento simplifies web development by offering:</p> |
| 32 | +<ul> |
| 33 | + <li><b>Fluent Builder API</b>: Create complex DOM hierarchies with clean, readable code</li> |
| 34 | + <li><b>Type Safety</b>: Leverage Java's type system to catch errors at compile time</li> |
| 35 | + <li><b>Modular Architecture</b>: Choose only the modules you need for your application</li> |
| 36 | + <li><b>Modern Web Standards</b>: Support for Custom Elements, SVG, MathML, and more</li> |
| 37 | + <li><b>Developer Friendly</b>: Intuitive APIs that reduce boilerplate and improve productivity</li> |
| 38 | +</ul> |
| 39 | + |
| 40 | +<h2>Modules</h2> |
| 41 | + |
| 42 | +<p><img src="doc-files/dependency-graph.png" alt="Elemento Module Dependencies"/></p> |
| 43 | + |
| 44 | +<p>Elemento is structured as a set of modules with <b>elemento-core</b> at the foundation. The core module provides |
| 45 | + the essential builder API for creating and manipulating HTML elements, event handling, type-safe CSS selectors, |
| 46 | + and utilities for DOM traversal and manipulation.</p> |
| 47 | + |
| 48 | +<p>Additional optional modules build on top of the core: <b>elemento-router</b> for single-page application routing, |
| 49 | + <b>elemento-flow</b> for asynchronous task control flow, <b>elemento-logger</b> for lightweight logging, |
| 50 | + <b>elemento-intl</b> for internationalization support, <b>elemento-svg</b> for SVG element creation, |
| 51 | + and <b>elemento-mathml</b> for mathematical notation. Each module can be used independently based on your |
| 52 | + application's needs.</p> |
| 53 | + |
| 54 | +</body> |
| 55 | +</html> |
0 commit comments