class Opal::UI::MarkdownElement

Overview

Markdown Element / Viewer for use inside UI trees with interactive scrolling

Defined in:

opal/ui/markdown/renderer.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.new(content : String, width : Int32 = 80, scrollable : Bool = true, auto_scroll : Bool = false, scroll_speed : Float64 = 1.0) #

[View source]

Instance Method Detail

def auto_scroll=(auto_scroll : Bool) #

[View source]
def auto_scroll? : Bool #

[View source]
def content : String #

[View source]
def content=(new_content : String) #

[View source]
def handle_key(key : Terminal::KeyEvent) : Bool #

[View source]
def handle_mouse(event : Terminal::MouseEvent) : Bool #

[View source]
def lines : Array(String) #

[View source]
def page_down(lines_count : Int32 | Nil = nil) : Nil #

[View source]
def page_up(lines_count : Int32 | Nil = nil) : 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 rendered : String #

[View source]
def scroll_down(lines_count : Int32 = 1) : Nil #

[View source]
def scroll_offset : Int32 #

[View source]
def scroll_offset=(scroll_offset : Int32) #

[View source]
def scroll_speed : Float64 #

[View source]
def scroll_speed=(scroll_speed : Float64) #

[View source]
def scroll_to_bottom : Nil #

[View source]
def scroll_to_top : Nil #

[View source]
def scroll_up(lines_count : Int32 = 1) : Nil #

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

[View source]
def scrollable? : Bool #

[View source]
def set_content(new_content : String, width : Int32 = 80) #

[View source]
def tick(dt : Float64 = 0.0166) : Nil #

[View source]
def visible_height : Int32 #

[View source]
def visible_height=(visible_height : Int32) #

[View source]