zio.blocks.html

package zio.blocks.html

Members list

Type members

Classlikes

Key for single-valued HTML attributes. Use := to set the value.

Attributes

Source: AttributeKey.scala
Supertypes: class Object

trait Matchable

class Any

This object was generated by sbt-buildinfo.

Attributes

Source: BuildInfo.scala
Supertypes: trait Singleton

trait Product

trait Mirror

trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Self type: BuildInfo.type

A sealed ADT representing CSS content.

Variants:

Css.Rule — a single CSS rule: selector { property: value; ... }
Css.Sheet — multiple rules
Css.Raw — raw CSS string (for media queries, keyframes, etc.)
Css.Comment — CSS comment: /* text */

Rendering:

render produces minified CSS
render(indent) produces pretty-printed CSS with the specified indentation

Attributes

Companion: object
Source: Css.scala
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Known subtypes: class Comment

class Raw

class Rule

class Sheet

Attributes

Companion: trait
Source: Css.scala
Supertypes: trait Sum

trait Mirror

class Object

trait Matchable

class Any
Self type: Css.type

Attributes

Companion: trait
Source: ToCss.scala
Supertypes: trait Sum

trait Mirror

class Object

trait Matchable

class Any
Self type: CssColor.type

A CSS color value (hex, RGB, HSL, or named color).

Attributes

Companion: object
Source: ToCss.scala
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Known subtypes: class Hex

class Hsl

class Named

class Rgb

class Rgba

A CSS length value with a numeric value and unit (e.g., 10px, 2em, 50%).

Attributes

Companion: object
Source: ToCss.scala
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: ToCss.scala
Supertypes: trait Product

trait Mirror

class Object

trait Matchable

class Any
Self type: CssLength.type

Attributes

Source: CssSelectable.scala
Supertypes: class Object

trait Matchable

class Any
Known subtypes: trait CssSelector

class AdjacentSibling

class And

class Attribute

class Child

class Class

class Descendant

class Element

class GeneralSibling

class Id

class Not

class Or

class PseudoClass

class PseudoElement

class Raw

object Universal

trait Void

class VoidGeneric

trait Element

trait Cell

trait Td

class TdElement

trait Th

class ThElement

class Generic

trait Li

class LiElement

class OptElement

class OptgroupElement

class Script

trait SelectChild

trait Opt

trait Optgroup

class Style

trait Tr

class TrElement
Show all

A sealed ADT representing CSS selectors with type-safe composition.

Selectors can be combined using operators:

> — child combinator
>> — descendant combinator
+ — adjacent sibling
~ — general sibling
& — concatenation (and)
| — grouping (or)

Values in attribute selectors are escaped to prevent CSS injection. Use CssSelector.Raw(string) for selectors not expressible via the ADT.

Attributes

Companion: object
Source: CssSelector.scala
Supertypes: trait Serializable

trait Product

trait Equals

trait CssSelectable

class Object

trait Matchable

class Any
Show all
Known subtypes: class AdjacentSibling

class And

class Attribute

class Child

class Class

class Descendant

class Element

class GeneralSibling

class Id

class Not

class Or

class PseudoClass

class PseudoElement

class Raw

object Universal
Show all

Attributes

Companion: trait
Source: CssSelector.scala
Supertypes: trait Sum

trait Mirror

class Object

trait Matchable

class Any
Self type: CssSelector.type

Attributes

Companion: trait
Source: Dom.scala
Supertypes: trait Sum

trait Mirror

class Object

trait Matchable

class Any
Self type: Dom.type

A sealed algebraic data type (ADT) representing an HTML document node.

The Dom trait models HTML as an abstract syntax tree where each node is either:

Text content (automatically HTML-escaped during rendering)
An empty node (renders to nothing)
An Element with a tag, attributes, and child nodes

===Rendering=== Text content is HTML-escaped by default to prevent injection attacks. However, Script and Style elements intentionally render their children WITHOUT escaping, allowing inline JavaScript and CSS to be rendered as-is.

Use render for minified HTML or render(indent: Int) for pretty-printed output with N spaces per indentation level.

===Tree Operations=== The ADT supports traversal via collect, filter, find, and transform methods for navigating and transforming the tree structure.

Attributes

See also: Dom.Element for element construction

Dom.Text for text content

Dom.Empty for empty nodes
Companion: object
Source: Dom.scala
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Known subtypes: class Doctype

trait Void

class VoidGeneric

trait Element

trait Cell

trait Td

class TdElement

trait Th

class ThElement

class Generic

trait Li

class LiElement

class OptElement

class OptgroupElement

class Script

trait SelectChild

trait Opt

trait Optgroup

class Style

trait Tr

class TrElement

object Empty

class Text
Show all

Represents a deferred modification to a Dom.Element.

DomModifier values describe additions (attributes, children, or nested effects) that are collected during element construction and then applied in batch by ToModifier.buildFromEffects.

Use DomModifier#applyTo for single-effect application to an element.

Attributes

Companion: object
Source: DomModifier.scala
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all
Known subtypes: class AddAttr

class AddChild

class AddChildren

class AddEffects

Attributes

Companion: trait
Source: DomModifier.scala
Supertypes: trait Sum

trait Mirror

class Object

trait Matchable

class Any
Self type: DomModifier.type

Attributes

Source: DomModifier.scala
Supertypes: class Object

trait Matchable

class Any

Attributes

Companion: class
Source: DomSelection.scala
Supertypes: class Object

trait Matchable

class Any
Self type: DomSelection.type

A wrapper around Chunk[Dom] that provides fluent chaining for CSS selector-based DOM navigation and querying operations.

DomSelection enables a fluent API style for navigating through DOM structures:

 dom.select(CssSelector.Element("div")).children.select(CssSelector.Element("p")).texts

The selection can contain zero, one, or multiple DOM nodes, supporting both single-value navigation and multi-value queries.

Attributes

Companion: object
Source: DomSelection.scala
Supertypes: trait Serializable

trait Product

trait Equals

class AnyVal

trait Matchable

class Any
Show all

Attributes

Source: HtmlElements.scala
Supertypes: class Object

trait Matchable

class Any

Internal runtime support for the css, selector, js, and html interpolators.

This object is public only because Scala 2 macro expansion inlines calls at the use site. It is not intended as a stable user-facing API.

Attributes

Source: InterpolatorRuntime.scala
Supertypes: class Object

trait Matchable

class Any
Self type: InterpolatorRuntime.type

A wrapper for raw JavaScript code. Use js"..." to create instances with proper escaping.

Attributes

Companion: object
Source: Js.scala
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Source: Js.scala
Supertypes: class Object

trait Matchable

class Any
Self type: Js.type

Attributes

Source: ToJs.scala
Supertypes: class Object

trait Matchable

class Any
Known subtypes: object ToJs

Key for multi-valued HTML attributes (e.g., class, rel). Use := to override, += to append.

Attributes

Source: MultiAttributeKey.scala
Supertypes: class Object

trait Matchable

class Any

Provides string interpolators for HTML, CSS, JavaScript, and CSS selectors.

Interpolators:

html"..." — produces Dom, position-aware: uses ToAttrValue for =$$value, ToElements for content
css"..." — produces Css, uses ToCss for interpolated values
js"..." — produces Js, uses ToJs for interpolated values (strings are quoted and escaped)
selector"..." — produces CssSelector, uses ToCss for interpolated values

On Scala 3, zero-argument interpolations are constant-folded at compile time.

Attributes

Source: TemplateInterpolators.scala
Supertypes: class Object

trait Matchable

class Any

Attributes

Companion: trait
Source: ToAttrValue.scala
Supertypes: class Object

trait Matchable

class Any
Self type: ToAttrValue.type

Typeclass for converting values to HTML attribute values with proper escaping.

Attributes

Companion: object
Source: ToAttrValue.scala
Supertypes: class Object

trait Matchable

class Any

Attributes

Companion: trait
Source: ToCss.scala
Supertypes: class Object

trait Matchable

class Any
Self type: ToCss.type

Typeclass for converting values to CSS strings for use in css"..." and selector"..." interpolators.

Attributes

Companion: object
Source: ToCss.scala
Supertypes: class Object

trait Matchable

class Any

Typeclass for values that can be converted to a Dom node.

Similar to ToCss and ToJs, ToDom provides a uniform way to convert Scala values into DOM representations. Primitive types are converted to Dom.Text nodes, while Dom values pass through unchanged.

Type parameters

A: the input type to convert

Attributes

Companion: object
Source: ToDom.scala
Supertypes: class Object

trait Matchable

class Any

Attributes

Companion: trait
Source: ToDom.scala
Supertypes: class Object

trait Matchable

class Any
Self type: ToDom.type

Attributes

Companion: trait
Source: ToElements.scala
Supertypes: class Object

trait Matchable

class Any
Self type: ToElements.type

Typeclass for converting values to sequences of DOM elements.

Attributes

Companion: object
Source: ToElements.scala
Supertypes: class Object

trait Matchable

class Any

Attributes

Companion: trait
Source: ToJs.scala
Supertypes: trait LowPriorityToJs

class Object

trait Matchable

class Any
Self type: ToJs.type

Typeclass for values that can be safely interpolated into JavaScript via js"...".

This is a '''templating''' typeclass, not a code generator. It converts Scala values into JavaScript '''expressions''' (value literals). Every JavaScript expression is also a valid statement, so ToJs output works in all template contexts: inline event handlers, script content, and variable assignments. For JavaScript control flow (if/for/while), use Js("...") directly.

Instance behavior:

String is quoted with " and JS-escaped (including `` protection)
Numeric types render as unquoted literals
Boolean renders as true/false
Option renders as the value or null
List/Map render as JSON arrays/objects
Types with a zio.blocks.schema.Schema auto-derive via JSON serialization

Attributes

Companion: object
Source: ToJs.scala
Supertypes: class Object

trait Matchable

class Any

Attributes

Companion: trait
Source: ToModifier.scala
Supertypes: class Object

trait Matchable

class Any
Self type: ToModifier.type

Typeclass for converting values to DomModifier for use in element construction.

Attributes

Companion: object
Source: ToModifier.scala
Supertypes: class Object

trait Matchable

class Any

Attributes

Companion: trait
Source: ToText.scala
Supertypes: class Object

trait Matchable

class Any
Self type: ToText.type

Typeclass for converting values to plain text strings.

Attributes

Companion: object
Source: ToText.scala
Supertypes: class Object

trait Matchable

class Any

Value members

Inherited methods

Attributes

Inherited from:: HtmlElements
Source: HtmlElements.scala

Attributes

Inherited from:: HtmlElements
Source: HtmlElements.scala

Attributes

Inherited from:: HtmlElements
Source: HtmlElements.scala

Attributes

Inherited from:: HtmlElements
Source: HtmlElements.scala

Creates a `

element from attributes and children, returningLi`.

The HTML content model of `

` permits flow content, so any modifier values are accepted.

Attributes

Inherited from:: HtmlElements
Source: HtmlElements.scala

Attributes

Inherited from:: HtmlElements
Source: HtmlElements.scala

Creates an `` element from an iterable of `

` children.

Attributes

Inherited from:: HtmlElements
Source: HtmlElements.scala

Creates an `` element from attributes and children, returning Opt.

The HTML content model of `` permits flow content, so any modifier values are accepted.

Attributes

Inherited from:: HtmlElements
Source: HtmlElements.scala

Creates an element from an iterable of children.

Attributes

Inherited from:: HtmlElements
Source: HtmlElements.scala

Alias for opt.

Attributes

Inherited from:: HtmlElements
Source: HtmlElements.scala

Creates a script element from attributes and typed JavaScript fragments.

Pass Dom.Attribute values for element attributes and Js values for inline script bodies. Plain strings are intentionally not accepted. Raw JavaScript is emitted according to the chosen Js constructor, so untrusted input must not be passed to raw JavaScript.

Attributes

Inherited from:: HtmlElements
Source: HtmlElements.scala

Creates a element from an iterable of/`` children.

Attributes

Inherited from:: HtmlElements
Source: HtmlElements.scala

Creates a style element from attributes and typed CSS fragments.

Pass Dom.Attribute values for element attributes and Css values for the stylesheet body. Prefer structured/non-raw Css constructors where possible; raw CSS is emitted according to the chosen Css constructor, so untrusted input must not be passed to raw CSS.