brigid

A library for constructing type-safe and (mostly) spec-compliant HTML.

This library is in active development; the API is not yet stable.

TODO

1. Change HTML entities to an ADT. Change the ChildHTML constructor to accept this, and add use ToText and ToBytes. Decide between either an entity combinator and the ADT exposed, or combinator functions that do this.

TODO (HTML)

1. For each of global, HTMX, event listeners, arias, and scoped attributes:
   1. Make constructors for Attribute GADT.
   2. Make render functions.
   3. Modify ValidElementsFor.
   4. Modify the attribute selector functions in HTML.Types.QuerySelector to take their appropriate types.
2. Add relevant type class instances (Bounded, Enum, Eq, Ord, Show, etc) and from/to text functions to applicable types.
3. Consider a contenteditable/inputmode dual attribute type for the Safe module.
4. Add safe builder functions for any HTML elements with complex conditions for its permitted content, such as what was done with Brigid.HTML.Elements.Safe.Table. Go through the entire list of elements again to determine what qualifies for this.
5. Add support for the SVG tag. Add render tests once SVG is ready for prime time.
6. Add support for MathML. Add render tests once MathML is ready for prime time.
7. Look into safely constructing Shadow DOM elements.
8. Consider Default type class that returns the default value for a given type or attribute.
9. Review common classes (Id, Class, Name, etc) and maybe make smart constructors that prevent users from creating them with invalid characters, rather than escaping them after the fact.
10. Consider writing Aeson instances for common types.
11. Give ChildHTML and Attribute an NFData instance - this seems to be required for benchmarking.
12. Make type synonyms for Shrubbery union member constraints.
13. Maybe member for members of Shrubbery union member constraints causes compile issues when Nothing is passed, because it can't determine what the union member should be. These unions should include None as an option, and that can be used for Nothing instead.

TODO (XML)

1. Add support for XML. Add render tests once XML is ready for prime time.
2. Add function to produce an XML WSDL from a provided Brigid XML structure?

TODO (HXML)

1. For each attribute:
   1. Make constructors for Attribute GADT.
   2. Make render functions.
   3. Modify ValidElementsFor.
2. Add safe builder functions for any HXML elements with complex conditions for its permitted content. Go through the entire list of elements again to determine what qualifies for this.
3. Consider Default type class that returns the default value for a given type or attribute.
4. Audit all tags in both renders for self-closing correctness. HXML uses strict XML, so elements with no children must render as <tag/>, never <tag></tag>. Several tags currently use buildClosingOrContentTag incorrectly.
5. Add render tests for HXML elements and attributes (analogous to test/HTML/Render/Elements.hs and test/HTML/Render/Attributes.hs).

Possible optimizations

1. Parallel rendering for DOMs branches with more than 3 children.