HxSwap

zio.http.htmx.HxSwap
See theHxSwap companion object
sealed trait HxSwap extends Product, Serializable

Typed representation of an hx-swap value.

Start from one of the predefined strategies such as HxSwap.InnerHTML or HxSwap.AfterEnd, then add modifiers like swap, settle, transition, scroll, show, ignoreTitle, and focusScroll.

Attributes

Companion
object
Source
HxSwap.scala
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
class Value

Members list

Value members

Concrete methods

def focusScroll(enabled: Boolean): HxSwap

Sets focusScroll:true or focusScroll:false.

Sets focusScroll:true or focusScroll:false.

Attributes

Source
HxSwap.scala

Enables ignoreTitle:true.

Enables ignoreTitle:true.

Attributes

Source
HxSwap.scala
def render: String

Renders this swap strategy into the literal hx-swap attribute value.

Renders this swap strategy into the literal hx-swap attribute value.

Attributes

Source
HxSwap.scala
def scroll(position: ScrollPosition): HxSwap

Adds a scroll: modifier.

Adds a scroll: modifier.

Attributes

Source
HxSwap.scala
def settle(duration: FiniteDuration): HxSwap

Adds a settle: delay modifier.

Adds a settle: delay modifier.

Attributes

Source
HxSwap.scala
def show(position: ShowPosition): HxSwap

Adds a show: modifier.

Adds a show: modifier.

Attributes

Source
HxSwap.scala
def swap(duration: FiniteDuration): HxSwap

Adds a swap: delay modifier.

Adds a swap: delay modifier.

Attributes

Source
HxSwap.scala

Enables transition:true.

Enables transition:true.

Attributes

Source
HxSwap.scala

Inherited methods

def productElementName(n: Int): String

The name of the n^th^ element of this product, 0-based. In the default implementation, an empty string.

The name of the n^th^ element of this product, 0-based. In the default implementation, an empty string.

Value parameters

n

the index of the element name to return

Attributes

Returns

the name of the specified element

Throws
IndexOutOfBoundsException

if the n is out of range(n < 0 || n >= productArity).

Inherited from:
Product
Source
Product.scala
def productElementNames: Iterator[String]

An iterator over the names of all the elements of this product.

An iterator over the names of all the elements of this product.

Attributes

Inherited from:
Product
Source
Product.scala
def productIterator: Iterator[Any]

An iterator over all the elements of this product.

An iterator over all the elements of this product.

Attributes

Returns

in the default implementation, an Iterator[Any]

Inherited from:
Product
Source
Product.scala
def productPrefix: String

A string used in the toString methods of derived classes. Implementations may override this method to prepend a string prefix to the result of toString methods.

A string used in the toString methods of derived classes. Implementations may override this method to prepend a string prefix to the result of toString methods.

Attributes

Returns

in the default implementation, the empty string

Inherited from:
Product
Source
Product.scala

Inherited and Abstract methods

def canEqual(that: Any): Boolean

Checks whether this instance can possibly equal that.

Checks whether this instance can possibly equal that.

A method that should be called from every well-designed equals method that is open to be overridden in a subclass. See Programming in Scala, Chapter 28 for discussion and design.

Value parameters

that

the value being probed for possible equality

Attributes

Returns

true if this instance can possibly equal that, otherwise false

Inherited from:
Equals
Source
Equals.scala
def productArity: Int

The size of this product.

The size of this product.

Attributes

Returns

for a product A(x,,1,,, ..., x,,k,,), returns k

Inherited from:
Product
Source
Product.scala
def productElement(n: Int): Any

The n^th^ element of this product, 0-based. In other words, for a product A(x,,1,,, ..., x,,k,,), returns x,,(n+1),, where `0 = productArity).

The n^th^ element of this product, 0-based. In other words, for a product A(x,,1,,, ..., x,,k,,), returns x,,(n+1),, where `0 = productArity).

Attributes

Returns

the element n elements after the first element

Inherited from:
Product
Source
Product.scala