tyrian
API
Generated with
tyrian/tyrian

tyrian

package tyrian

Members list

Concise view

Type members

Classlikes

object Aria extends AriaAttributes

Object used to provide Aria attribute syntax import tyrian.Aria.*

Object used to provide Aria attribute syntax import tyrian.Aria.*

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type
Aria.type
trait AriaAttributes

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Aria.type
sealed trait Attr[+M]

HTML attribute

HTML attribute

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Attribute
object EmptyAttribute.type
class Event[E, M]
trait Property
final case class Attribute(name: String, value: String) extends Attr[Nothing]

Attribute of an HTML tag

Attribute of an HTML tag

Attributes are like properties, but can be removed. This is important for attributes like disabled, hidden, selected where there is no value, they are present and therefore set, or absent and unset.

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait Attr[Nothing]
class Object
trait Matchable
class Any
object Attribute

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
object CSS

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type
CSS.type
sealed trait Cmd[+F[_], +Msg]

A command describes some side-effect to perform.

A command describes some side-effect to perform.

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Batch[F, Msg]
class Combine[F, Msg]
class Emit[Msg]
object None.type
class Run[F, A, Msg]
class SideEffect[F]
object Cmd

Attributes

Companion:
trait
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
Cmd.type
sealed trait Elem[+M]

An HTML element can be a tag or a text node

An HTML element can be a tag or a text node

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait Html[M]
class RawTag[M]
class Tag[M]
class Text
case object EmptyAttribute extends Attr[Nothing]

An attribute of an HTML tag that does not exist, used as a "do not render" placeholder

An attribute of an HTML tag that does not exist, used as a "do not render" placeholder

Attributes

Graph
Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
trait Attr[Nothing]
class Object
trait Matchable
class Any
Self type
final case class Event[E <: Event, M](name: String, msg: E => M, preventDefault: Boolean, stopPropagation: Boolean, stopImmediatePropagation: Boolean) extends Attr[M]

Event handler

Event handler

Attributes

msg

Message to produce when the event is triggered

name

Event name (e.g. "click")

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait Attr[M]
class Object
trait Matchable
class Any
object Event

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Event.type
object HotReload

A very simple mechanism to allow automatic loading and saving of your applications model to local storage. Uses:

A very simple mechanism to allow automatic loading and saving of your applications model to local storage. Uses:

  • During development, allows you to carry on where you left off between site rebuilds.
  • Acts as a user session, to remember where a website/app visitor/user was when they left.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type
sealed trait Html[+M] extends Elem[M]

Base class for HTML tags

Base class for HTML tags

Attributes

Companion:
object
Graph
Supertypes
trait Elem[M]
class Object
trait Matchable
class Any
Known subtypes
class RawTag[M]
class Tag[M]
object Html extends HtmlTags with HtmlAttributes

Object used to provide Html syntax import tyrian.Html.*

Object used to provide Html syntax import tyrian.Html.*

Attributes

Companion:
trait
Graph
Supertypes
trait Sum
trait Mirror
trait HtmlTags
class Object
trait Matchable
class Any
Self type
Html.type
trait HtmlAttributes

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Html.type
trait HtmlTags

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Html.type
final case class NamedAttribute(name: String) extends Attr[Nothing]

An attribute of an HTML tag that only has a name, no value

An attribute of an HTML tag that only has a name, no value

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait Attr[Nothing]
class Object
trait Matchable
class Any
object Navigation

Provides simple routing based on url hash (anchor), such as: http://mysite.com/#page1

Provides simple routing based on url hash (anchor), such as: http://mysite.com/#page1

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type
sealed trait Property extends Attr[Nothing]

Attributes

Companion:
object
Graph
Supertypes
trait Attr[Nothing]
class Object
trait Matchable
class Any
Known subtypes
object Property

Attributes

Companion:
trait
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class PropertyBoolean(name: String, value: Boolean) extends Property

Property of a DOM node instance

Property of a DOM node instance

Properties are a type of attribute that can only be set, not removed.

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait Property
trait Attr[Nothing]
class Object
trait Matchable
class Any
final case class PropertyString(name: String, value: String) extends Property

Property of a DOM node instance

Property of a DOM node instance

Properties are a type of attribute that can only be set, not removed.

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait Property
trait Attr[Nothing]
class Object
trait Matchable
class Any
final case class RawTag[+M](name: String, attributes: List[Attr[M]], innerHTML: String) extends Html[M]

An HTML tag with raw HTML rendered inside. Beware that the inner HTML is not validated to be correct, nor does it get modified as a response to messages in any way.

An HTML tag with raw HTML rendered inside. Beware that the inner HTML is not validated to be correct, nor does it get modified as a response to messages in any way.

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait Html[M]
trait Elem[M]
class Object
trait Matchable
class Any
object SVG extends SVGTags with SVGAttributes

Object used to provide SVG syntax import tyrian.SVG.*

Object used to provide SVG syntax import tyrian.SVG.*

Attributes

Graph
Supertypes
trait SVGTags
class Object
trait Matchable
class Any
Self type
SVG.type
trait SVGAttributes

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object SVG.type
trait SVGTags

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object SVG.type
object Style

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type
Style.type
sealed trait Sub[+F[_], +Msg]

A subscription describes a resource that an application is interested in.

A subscription describes a resource that an application is interested in.

Examples:

  • a timeout notifies its subscribers when it expires,
  • a video being played notifies its subscribers with subtitles.

Attributes

Msg

Type of message produced by the resource

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Batch[F, Msg]
class Combine[F, Msg]
object None.type
class Observe[F, A, Msg]
object Sub

Attributes

Companion:
trait
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Sub.type
final case class Tag[+M](name: String, attributes: List[Attr[M]], children: List[Elem[M]]) extends Html[M]

An HTML tag

An HTML tag

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait Html[M]
trait Elem[M]
class Object
trait Matchable
class Any
final case class Text(value: String) extends Elem[Nothing]

A text node

A text node

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait Elem[Nothing]
class Object
trait Matchable
class Any
object Tyrian

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type
Tyrian.type
trait TyrianAppF[F[_], Msg, Model]

The TyrianApp trait can be extended to conveniently prompt you for all the methods needed for a Tyrian app, as well as providing a number of standard app launching methods.

The TyrianApp trait can be extended to conveniently prompt you for all the methods needed for a Tyrian app, as well as providing a number of standard app launching methods.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
object syntax

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type
syntax.type

Types

opaque type Style
Generated with