ButtonLink

laika.helium.config.ButtonLink
See theButtonLink companion object
sealed abstract case class ButtonLink(target: Target, text: String, icon: Option[Icon], options: Options) extends SingleTargetLink

A link consisting of text and an optional icon, by default rendered in a rounded rectangle.

Attributes

Companion:
object
Graph
Supertypes
trait SpanResolver
trait Span
trait ThemeLink
trait Unresolved
class Element
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Members list

Concise view

Type members

Types

Value members

Concrete methods

def withOptions(newOptions: Options): ButtonLink

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.

Attributes

Inherited methods

def hasId: Boolean

Indicates whether this element has an id assigned.

Indicates whether this element has an id assigned.

Attributes

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.

Attributes

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.

Attributes

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.

Attributes

Inherited from:
Element
def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
def resolve(cursor: DocumentCursor): Span

Attributes

Inherited from:
SingleTargetLink
def runsIn(phase: RewritePhase): Boolean

Attributes

Inherited from:
ThemeLink
def unresolvedMessage: String

An error message to display when this element remains unresolved until after the final AST transformation step.

An error message to display when this element remains unresolved until after the final AST transformation step.

Attributes

Inherited from:
ThemeLink
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.

Attributes

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.

Attributes

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.

Attributes

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.

Attributes

Inherited from:
Element
def withoutId: Self

Returns a new instance of this element without its id.

Returns a new instance of this element without its id.

Attributes

Inherited from:
Element

Inherited fields

val source: SourceFragment

The fragment from the input source that produced this element. Can be used to report the line of the error or to render a fallback that simply renders back the consumed input.

The fragment from the input source that produced this element. Can be used to report the line of the error or to render a fallback that simply renders back the consumed input.

Attributes

Inherited from:
ThemeLink