module CLI::UI
Constants
- SpinGroup
Convenience accessor to
CLI::UI::Spinner::SpinGroup
- VERSION
Public Class Methods
Check whether colour is enabled in Formatter
output. By default, colour is enabled when STDOUT is a TTY; that is, when output has not been redirected to another program or to a file.
# File lib/cli/ui.rb, line 202 def self.enable_color? @enable_color end
Convenience Method to format text using CLI::UI::Formatter.format
Check CLI::UI::Formatter::SGR_MAP
for available formatting options
Attributes¶ ↑
-
input
- input to format
Options¶ ↑
-
enable_color
- should color be used? default to true unless output is redirected.
# File lib/cli/ui.rb, line 113 def self.fmt(input, enable_color: enable_color?) CLI::UI::Formatter.new(input).format(enable_color: enable_color) end
Set the default frame style. Convenience method for setting the default frame style with CLI::UI::Frame.frame_style=
Raises ArgumentError if frame_style
is not valid
Attributes¶ ↑
-
symbol
- the default frame style to use for frames
# File lib/cli/ui.rb, line 227 def self.frame_style=(frame_style) Frame.frame_style = frame_style.to_sym end
Duplicate output to a file path
Attributes¶ ↑
-
path
- path to duplicate output to
# File lib/cli/ui.rb, line 171 def self.log_output_to(path) if CLI::UI::StdoutRouter.duplicate_output_to raise 'multiple logs not allowed' end CLI::UI::StdoutRouter.duplicate_output_to = File.open(path, 'w') yield ensure if (file_descriptor = CLI::UI::StdoutRouter.duplicate_output_to) file_descriptor.close CLI::UI::StdoutRouter.duplicate_output_to = nil end end
Color
resolution using CLI::UI::Color.lookup
Will lookup using Color.lookup
unless it's already a CLI::UI::Color
(or nil)
Attributes¶ ↑
-
input
- color to resolve
# File lib/cli/ui.rb, line 39 def self.resolve_color(input) case input when CLI::UI::Color, nil input else CLI::UI::Color.lookup(input) end end
Frame
style resolution using CLI::UI::Frame::FrameStyle.lookup
. Will lookup using FrameStyle.lookup
unless it's already a CLI::UI::Frame::FrameStyle(or nil)
Attributes¶ ↑
-
input
- frame style to resolve
# File lib/cli/ui.rb, line 54 def self.resolve_style(input) case input when CLI::UI::Frame::FrameStyle, nil input else CLI::UI::Frame::FrameStyle.lookup(input) end end
Convenience Method to resolve text using CLI::UI::Formatter.format
Check CLI::UI::Formatter::SGR_MAP
for available formatting options
Attributes¶ ↑
-
input
- input to format -
truncate_to
- number of characters to truncate the string to (or nil)
# File lib/cli/ui.rb, line 92 def self.resolve_text(input, truncate_to: nil) return input if input.nil? formatted = CLI::UI::Formatter.new(input).format return formatted unless truncate_to CLI::UI::Truncater.call(formatted, truncate_to) end
Convenience Method to override frame color using CLI::UI::Frame.with_frame_color
Attributes¶ ↑
-
color
- color to override to -
block
- block forFrame.with_frame_color_override
# File lib/cli/ui.rb, line 161 def self.with_frame_color(color, &block) CLI::UI::Frame.with_frame_color_override(color, &block) end
# File lib/cli/ui.rb, line 117 def self.wrap(input) CLI::UI::Wrap.new(input).wrap end