class
Opal::UI::ColorPicker
- Opal::UI::ColorPicker
- Opal::UI::Control
- Opal::UI::Element
- Reference
- Object
Overview
Interactive TrueColor 24-bit color picker supporting 8 color spaces (RGB, HSL, HSV, LAB, Oklab, XYZ, CMYK, HEX), embedded 2D target slicing, alpha transparency, live color harmonies, swatches, and select button.
Defined in:
opal/ui/components/color_picker.crConstant Summary
-
DEFAULT_PALETTE =
[Color.hex("#F38BA8"), Color.hex("#FAB387"), Color.hex("#F9E2AF"), Color.hex("#A6E3A1"), Color.hex("#94E2D5"), Color.hex("#74C7EC"), Color.hex("#89B4FA"), Color.hex("#CBA6F7"), Color.hex("#BD93F9"), Color.hex("#FF79C6"), Color.hex("#50FA7B"), Color.hex("#88C0D0"), Color.hex("#81A1C1"), Color.hex("#D08770"), Color.hex("#EBCB8B"), Color.hex("#FFFFFF")] -
Curated designer palette (Catppuccin Mocha, Dracula, TokyoNight, Nord)
Constructors
Instance Method Summary
- #active_channel : Symbol
- #active_channel=(active_channel : Symbol)
- #adjust_active(delta : Int32) : Nil
- #allowed_modes : Array(ColorMode)
- #allowed_modes=(allowed_modes : Array(ColorMode))
-
#alpha : Float64
Alpha channel [0.0..1.0]
-
#alpha=(alpha : Float64)
Alpha channel [0.0..1.0]
- #b : Int32
- #b=(b : Int32)
- #color : Color
- #color=(c : Color) : Nil
- #confirmed? : Bool
-
#cycle_mode : Nil
Cycles to the next color editing mode
- #g : Int32
- #g=(g : Int32)
-
#handle_key(key : Terminal::KeyEvent) : Bool
Default key event handler.
-
#handle_mouse(event : Terminal::MouseEvent) : Bool
Default mouse event handler.
-
#harmonies : Hash(Symbol, Array(Color))
Computes color harmonies (Complementary, Analogous, Triadic)
- #hex_code : String
- #last_blue_y : Int32
- #last_blue_y=(last_blue_y : Int32)
- #last_green_y : Int32
- #last_green_y=(last_green_y : Int32)
- #last_h : Int32
- #last_h=(last_h : Int32)
- #last_preset_count : Int32
- #last_preset_count=(last_preset_count : Int32)
- #last_preset_start_x : Int32
- #last_preset_start_x=(last_preset_start_x : Int32)
- #last_preset_y : Int32
- #last_preset_y=(last_preset_y : Int32)
- #last_red_y : Int32
- #last_red_y=(last_red_y : Int32)
- #last_select_btn_w : Int32
- #last_select_btn_w=(last_select_btn_w : Int32)
- #last_select_btn_x : Int32
- #last_select_btn_x=(last_select_btn_x : Int32)
- #last_select_btn_y : Int32
- #last_select_btn_y=(last_select_btn_y : Int32)
- #last_slider_x : Int32
- #last_slider_x=(last_slider_x : Int32)
- #last_track_w : Int32
- #last_track_w=(last_track_w : Int32)
- #last_w : Int32
- #last_w=(last_w : Int32)
-
#last_x : Int32
Rendering layout cache
-
#last_x=(last_x : Int32)
Rendering layout cache
- #last_y : Int32
- #last_y=(last_y : Int32)
- #layout : ColorPickerLayout
- #layout=(layout : ColorPickerLayout)
- #luminance : Float64
- #mode : ColorMode
- #mode=(mode : ColorMode)
- #next_channel : Nil
-
#on_change : Proc(Color, Nil) | Nil
Callbacks
-
#on_change=(on_change : Proc(Color, Nil) | Nil)
Callbacks
- #on_confirm : Proc(Color, Nil) | Nil
- #on_confirm=(on_confirm : Proc(Color, Nil) | Nil)
- #palette_cursor : Int32
- #palette_cursor=(palette_cursor : Int32)
- #preferred_size(available_w : Int32, available_h : Int32) : Tuple(Int32, Int32)
- #preset_swatches : Array(Color)
- #preset_swatches=(preset_swatches : Array(Color))
- #prev_channel : Nil
-
#r : Int32
sRGB base channels
-
#r=(r : Int32)
sRGB base channels
- #render(buffer : Buffer, x : Int32, y : Int32, width : Int32, height : Int32) : Nil
- #render(buffer : Buffer) : Nil
- #select_preset(idx : Int32) : Nil
- #show_alpha=(show_alpha : Bool)
- #show_alpha? : Bool
-
#show_harmonies=(show_harmonies : Bool)
UI Options
-
#show_harmonies? : Bool
UI Options
- #show_select_button=(show_select_button : Bool)
- #show_select_button? : Bool
- #show_target_selector=(show_target_selector : Bool)
- #show_target_selector? : Bool
-
#target_selector : TargetSelector2D
Embedded 2D target selector for 2D color plane slicing
-
#target_selector=(target_selector : TargetSelector2D)
Embedded 2D target selector for 2D color plane slicing
Constructor methods inherited from class Opal::UI::Control
new
new
Instance methods inherited from module Opal::UI::InputHookable
custom_inputs=(custom_inputs : Bool)
custom_inputs=,
custom_inputs? : Bool
custom_inputs?,
default_input_proc : Proc(InputEvent, Bool) | Nil
default_input_proc,
default_input_proc=(default_input_proc : Proc(InputEvent, Bool) | Nil)
default_input_proc=,
fallback_to_defaults!(enabled : Bool = true) : self
fallback_to_defaults!,
fallback_to_defaults=(fallback_to_defaults : Bool)
fallback_to_defaults=,
fallback_to_defaults? : Bool
fallback_to_defaults?,
focus : self
focus,
focused=(focused : Bool)
focused=,
focused? : Bool
focused?,
handle_default_input(event : InputEvent) : Bool
handle_default_input,
handle_input(event : InputEvent) : Bool
handle_input,
handle_key(key : Terminal::KeyEvent) : Bool
handle_key,
handle_mouse(event : Terminal::MouseEvent) : Bool
handle_mouse,
input_hook : Proc(InputEvent, Bool) | Nil
input_hook,
input_hook=(input_hook : Proc(InputEvent, Bool) | Nil)
input_hook=,
on_input(&block : self, InputEvent -> Bool) : self
on_input,
puppet(&block : self, InputEvent -> Bool) : self
puppet,
reset_inputs : self
reset_inputs,
setup_default_inputs : Nil
setup_default_inputs,
unfocus : self
unfocus,
use_custom_inputs!(enabled : Bool = true) : self
use_custom_inputs!
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(initial_color : Color = Color.hex("#89B4FA"), active_channel : Symbol = :red, presets : Array(Color) | Nil = nil, mode : ColorMode = ColorMode::RGB, layout : ColorPickerLayout = ColorPickerLayout::Studio, show_alpha : Bool = false, show_harmonies : Bool = true, show_select_button : Bool = false)
#
Instance Method Detail
def handle_key(key : Terminal::KeyEvent) : Bool
#
Description copied from module Opal::UI::InputHookable
Default key event handler. Override in subclasses if not using @default_input_proc.
def handle_mouse(event : Terminal::MouseEvent) : Bool
#
Description copied from module Opal::UI::InputHookable
Default mouse event handler. Override in subclasses if not using @default_input_proc.
Computes color harmonies (Complementary, Analogous, Triadic)
def target_selector=(target_selector : TargetSelector2D)
#
Embedded 2D target selector for 2D color plane slicing