ThemeLink

sealed trait ThemeLink extends SpanResolver

A Helium link type available for navigation bars and the landing page.

trait SpanResolver
trait Unresolved
trait Span
class Element
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
class IconLink
class ImageLink
class TextLink

Type members

Types

type Self <: ThemeLink

Value members

Abstract methods

def target: Target

The target of the link, either internal or external.

The target of the link, either internal or external.

Concrete methods

def resolve(cursor: DocumentCursor): Span
def unresolvedMessage: String

Inherited methods

def canEqual(that: Any): Boolean
Inherited from
Equals
def hasId: Boolean

Indicates whether this element has an id assigned.

Indicates whether this element has an id assigned.

Inherited from
Element
def hasStyle(name: String): Boolean

Indicates whether this element has the specified style assigned.

Indicates whether this element has the specified style assigned.

Inherited from
Element
def mergeOptions(opt: Options): Self

Returns a new instance of this element with its options merged with the specified options.

Returns a new instance of this element with its options merged with the specified options.

Inherited from
Element
def modifyOptions(f: Options => Options): Self

Returns a new instance of this element with the new options obtained from applying the specified function to the existing value.

Returns a new instance of this element with the new options obtained from applying the specified function to the existing value.

Inherited from
Element
def options: Options
Inherited from
Element
def productArity: Int
Inherited from
Product
def productElement(n: Int): Any
Inherited from
Product
def productElementName(n: Int): String
Inherited from
Product
def productElementNames: Iterator[String]
Inherited from
Product
def productIterator: Iterator[Any]
Inherited from
Product
def productPrefix: String
Inherited from
Product
def withId(id: String): Self

Returns a new instance of this element with its id set to the specified value, overriding any existing value.

Returns a new instance of this element with its id set to the specified value, overriding any existing value.

Inherited from
Element
def withOptions(options: Options): Self

Returns a new instance of this element with the specified options replacing the current value.

Returns a new instance of this element with the specified options replacing the current value.

Inherited from
Element
def withStyle(name: String): Self

Returns a new instance of this element with the specified style added to its existing styles.

Returns a new instance of this element with the specified style added to its existing styles.

Inherited from
Element
def withStyles(styles: Iterable[String]): Self

Returns a new instance of this element with the specified styles added to its existing styles.

Returns a new instance of this element with the specified styles added to its existing styles.

Inherited from
Element
def withStyles(style: String, styles: String*): Self

Returns a new instance of this element with the specified styles added to its existing styles.

Returns a new instance of this element with the specified styles added to its existing styles.

Inherited from
Element

Returns a new instance of this element without its id.

Returns a new instance of this element without its id.

Inherited from
Element

Concrete fields

val source: SourceFragment