Inline

zio.blocks.docs.Inline
See theInline companion trait
object Inline

Attributes

Companion
trait
Source
Inline.scala
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Inline.type

Members list

Type members

Classlikes

final case class Autolink(url: String, isEmail: Boolean) extends Inline

An autolink ( or ).

An autolink ( or ).

Value parameters

isEmail

Whether this is an email autolink

url

The URL or email address

Attributes

Source
Inline.scala
Supertypes
trait Inline
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class Code(value: String) extends Inline

Inline code span (code).

Inline code span (code).

Value parameters

value

The code content

Attributes

Source
Inline.scala
Supertypes
trait Inline
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class Emphasis(content: Chunk[Inline]) extends Inline

Emphasized text (text or text).

Emphasized text (text or text).

Value parameters

content

The inline elements to emphasize

Attributes

Source
Inline.scala
Supertypes
trait Inline
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case object HardBreak extends Inline

A hard line break (two spaces or backslash before newline).

A hard line break (two spaces or backslash before newline).

Attributes

Source
Inline.scala
Supertypes
trait Singleton
trait Product
trait Mirror
trait Inline
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
HardBreak.type
final case class HtmlInline(content: String) extends Inline

Raw HTML inline content.

Raw HTML inline content.

Value parameters

content

The HTML content

Attributes

Source
Inline.scala
Supertypes
trait Inline
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class Image(alt: String, url: String, title: Option[String]) extends Inline

An image.

An image.

Value parameters

alt

The alt text

title

Optional image title

url

The image URL

Attributes

Source
Inline.scala
Supertypes
trait Inline
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class Link(text: Chunk[Inline], url: String, title: Option[String]) extends Inline

A hyperlink.

A hyperlink.

Value parameters

text

The link text

title

Optional link title

url

The link URL

Attributes

Source
Inline.scala
Supertypes
trait Inline
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case object SoftBreak extends Inline

A soft line break (single newline).

A soft line break (single newline).

Attributes

Source
Inline.scala
Supertypes
trait Singleton
trait Product
trait Mirror
trait Inline
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
SoftBreak.type
final case class Strikethrough(content: Chunk[Inline]) extends Inline

Strikethrough text (text).

Strikethrough text (text).

Value parameters

content

The inline elements to strike through

Attributes

Source
Inline.scala
Supertypes
trait Inline
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class Strong(content: Chunk[Inline]) extends Inline

Strong/bold text (text or text).

Strong/bold text (text or text).

Value parameters

content

The inline elements to make strong

Attributes

Source
Inline.scala
Supertypes
trait Inline
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
final case class Text(value: String) extends Inline

Plain text content.

Plain text content.

Value parameters

value

The text string

Attributes

Source
Inline.scala
Supertypes
trait Inline
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Inherited and Abstract types

type MirroredElemLabels <: Tuple

The names of the product elements.

The names of the product elements.

Attributes

Inherited from:
Mirror
Source
Mirror.scala
type MirroredLabel <: String

The name of the type.

The name of the type.

Attributes

Inherited from:
Mirror
Source
Mirror.scala