class Opal::UI::Link

Overview

Renders an OSC 8 clickable terminal hyperlink element for terminal UIs.

Defined in:

opal/ui/components/link.cr

Constructors

Instance Method Summary

Instance methods inherited from class Opal::UI::Element

add_class(name : String) : self add_class, children : Array(Element) children, classes : Set(String) classes, classes=(classes : Set(String)) classes=, has_class?(name : String) : Bool has_class?, id : String | Nil id, id=(id : String | Nil) id=, preferred_print_size(available_w : Int32) : Tuple(Int32, Int32) preferred_print_size, preferred_size(available_w : Int32, available_h : Int32) : Tuple(Int32, Int32) preferred_size, print(io : IO = STDOUT, width : Int32 | Nil = nil, color : Bool | Nil = nil, theme : Theme | Nil = nil) : Nil print, query(selector : String) : Array(Element)
query(klass : T.class) : Array(T) forall T
query
, query_one(selector : String) : Element
query_one(klass : T.class) : T forall T
query_one
, query_one?(selector : String) : Element | Nil
query_one?(klass : T.class) : T | Nil forall T
query_one?
, remove_class(name : String) : self remove_class, render(buffer : Buffer, x : Int32, y : Int32, width : Int32, height : Int32) : Nil render, render_print(buffer : Buffer, width : Int32, height : Int32) : Nil render_print, to_print_s(width : Int32 | Nil = nil, color : Bool | Nil = nil, theme : Theme | Nil = nil) : String to_print_s, to_string(width : Int32 | Nil = nil, color : Bool | Nil = nil, theme : Theme | Nil = nil) : String to_string

Instance methods inherited from module Opal::UI::Themable

current_theme : Theme current_theme, style(&block : self -> Nil) : self style, theme : Theme | Nil theme, theme=(theme : Theme | Nil) theme=, with_theme(new_theme : Theme | Symbol | String) : self with_theme

Constructor Detail

def self.github(repo : String, kind : Symbol | String, number : Int32 | String, label : String | Nil = nil, id : String | Nil = nil, fg : Color | Symbol | String = :cyan, bg : Color | Symbol | String = Color.none, bold : Bool = false, dim : Bool = false, italic : Bool = false, underline : Bool = true, icon : String | Nil = nil) : Link #

Creates a Link element pointing to a GitHub RFC/Discussion, Issue, or Pull Request.


[View source]
def self.issue(repo : String, number : Int32 | String, label : String | Nil = nil, fg : Color | Symbol | String = :cyan, bold : Bool = false, underline : Bool = true) : Link #

[View source]
def self.new(url : String, label : String | Nil = nil, id : String | Nil = nil, fg : Color | Symbol | String = :cyan, bg : Color | Symbol | String = Color.none, bold : Bool = false, dim : Bool = false, italic : Bool = false, underline : Bool = true, icon : String | Nil = nil) #

[View source]
def self.pr(repo : String, number : Int32 | String, label : String | Nil = nil, fg : Color | Symbol | String = :cyan, bold : Bool = false, underline : Bool = true) : Link #

[View source]
def self.rfc(repo : String, number : Int32 | String, label : String | Nil = nil, fg : Color | Symbol | String = :cyan, bold : Bool = false, underline : Bool = true) : Link #

[View source]

Instance Method Detail

def bg : Color #

[View source]
def bg=(bg : Color) #

[View source]
def bold=(bold : Bool) #

[View source]
def bold? : Bool #

[View source]
def dim=(dim : Bool) #

[View source]
def dim? : Bool #

[View source]
def display_text : String #

[View source]
def fg : Color #

[View source]
def fg=(fg : Color) #

[View source]
def icon : String | Nil #

[View source]
def icon=(icon : String | Nil) #

[View source]
def italic=(italic : Bool) #

[View source]
def italic? : Bool #

[View source]
def label : String #

[View source]
def label=(label : String) #

[View source]
def link_id : String | Nil #

[View source]
def link_id=(link_id : String | Nil) #

[View source]
def preferred_size(available_w : Int32, available_h : Int32) : Tuple(Int32, Int32) #

[View source]
def render(buffer : Buffer, x : Int32, y : Int32, width : Int32, height : Int32) : Nil #

[View source]
def to_osc8 : String #

[View source]
def underline=(underline : Bool) #

[View source]
def underline? : Bool #

[View source]
def url : String #

[View source]
def url=(url : String) #

[View source]