Functions
template<class T , class... Args>
std::shared_ptr< T >	Make (Args &&... args)

Component	operator\| (Component component, ComponentDecorator decorator)

Component	operator\| (Component component, ElementDecorator decorator)

Component &	operator\|= (Component &component, ComponentDecorator decorator)

Component &	operator\|= (Component &component, ElementDecorator decorator)

Component	Button (ButtonOption option)
	Draw a button. Execute a function when clicked. More...

Component	Button (ConstStringRef label, std::function< void()> on_click, ButtonOption option)
	Draw a button. Execute a function when clicked. More...

Component	Checkbox (CheckboxOption options)

Component	Checkbox (ConstStringRef label, bool *checked, CheckboxOption option)
	Draw checkable element. More...

Component	Input (InputOption option)
	An input box for editing text. More...

Component	Input (StringRef content, InputOption option)
	An input box for editing text. More...

Component	Input (StringRef content, StringRef placeholder, InputOption option)
	An input box for editing text. More...

Component	Menu (MenuOption option)
	A list of text. The focused element is selected. More...

Component	Menu (ConstStringListRef entries, int *selected, MenuOption option)
	A list of text. The focused element is selected. More...

Component	MenuEntry (MenuEntryOption option)
	A specific menu entry. They can be put into a Container::Vertical to form a menu. More...

Component	MenuEntry (ConstStringRef label, MenuEntryOption option)
	A specific menu entry. They can be put into a Container::Vertical to form a menu. More...

Component	Radiobox (RadioboxOption option)
	A list of element, where only one can be selected. More...

Component	Radiobox (ConstStringListRef entries, int *selected, RadioboxOption option)
	A list of element, where only one can be selected. More...

Component	Dropdown (ConstStringListRef entries, int *selected)
	A dropdown menu. More...

Component	Toggle (ConstStringListRef entries, int *selected)
	An horizontal list of elements. The user can navigate through them. More...

template<typename T >
Component	Slider (SliderOption< T > options)
	A slider in any direction. More...

Component	Slider (ConstStringRef label, Ref< int > value, ConstRef< int > min, ConstRef< int > max, ConstRef< int > increment)
	An horizontal slider. More...

Component	Slider (ConstStringRef label, Ref< float > value, ConstRef< float > min=0.f, ConstRef< float > max=100.f, ConstRef< float > increment=5.f)

Component	Slider (ConstStringRef label, Ref< long > value, ConstRef< long > min=0l, ConstRef< long > max=100l, ConstRef< long > increment=5l)

Component	ResizableSplit (ResizableSplitOption options)
	A split in between two components. More...

Component	ResizableSplitLeft (Component main, Component back, int *main_size)
	An horizontal split in between two components, configurable using the mouse. More...

Component	ResizableSplitRight (Component main, Component back, int *main_size)
	An horizontal split in between two components, configurable using the mouse. More...

Component	ResizableSplitTop (Component main, Component back, int *main_size)
	An vertical split in between two components, configurable using the mouse. More...

Component	ResizableSplitBottom (Component main, Component back, int *main_size)
	An vertical split in between two components, configurable using the mouse. More...

Component	Renderer (Component child, std::function< Element()> render)
	Return a new Component, similar to \|child\|, but using \|render\| as the Component::Render() event. More...

Component	Renderer (std::function< Element()> render)
	Return a component, using \|render\| to render its interface. More...

Component	Renderer (std::function< Element(bool)> render)
	Return a focusable component, using \|render\| to render its interface. More...

ComponentDecorator	Renderer (ElementDecorator decorator)
	Decorate a component, by decorating what it renders. More...

Component	CatchEvent (Component child, std::function< bool(Event)>)

ComponentDecorator	CatchEvent (std::function< bool(Event)> on_event)
	Decorate a component, using \|on_event\| to catch events. This function must returns true when the event has been handled, false otherwise. More...

Component	Maybe (Component child, const bool *show)
	Decorate a component \|child\|. It is shown only when \|show\| is true. More...

Component	Maybe (Component child, std::function< bool()> show)
	Decorate a component \|child\|. It is shown only when \|show\| returns true. More...

ComponentDecorator	Maybe (const bool *show)
	Decorate a component. It is shown only when \|show\| is true. More...

ComponentDecorator	Maybe (std::function< bool()> show)
	Decorate a component. It is shown only when the \|show\| function returns true. More...

Component	Modal (Component main, Component modal, const bool *show_modal)

ComponentDecorator	Modal (Component modal, const bool *show_modal)

Component	Collapsible (ConstStringRef label, Component child, Ref< bool > show=false)

Component	Hoverable (Component component, bool *hover)
	Wrap a component. Gives the ability to know if it is hovered by the mouse. More...

Component	Hoverable (Component component, std::function< void()> on_enter, std::function< void()> on_leave)
	Wrap a component. Uses callbacks. More...

Component	Hoverable (Component component, std::function< void(bool)> on_change)
	Wrap a component. Gives the ability to know if it is hovered by the mouse. More...

ComponentDecorator	Hoverable (bool *hover)
	Wrap a component. Gives the ability to know if it is hovered by the mouse. More...

ComponentDecorator	Hoverable (std::function< void()> on_enter, std::function< void()> on_leave)

ComponentDecorator	Hoverable (std::function< void(bool)> on_change)
	Wrap a component. Gives the ability to know if it is hovered by the mouse. More...

Component	Window (WindowOptions option)
	A draggeable / resizeable window. To use multiple of them, they must be stacked using `Container::Stacked({...})` component;. More...

template<class T >
Receiver< T >	MakeReceiver ()

Element	text (std::wstring text)
	Display a piece of unicode text. More...

Element	vtext (std::wstring text)
	Display a piece unicode text vertically. More...

Elements	paragraph (std::wstring text)

Element	operator\| (Element element, Decorator decorator)
	From an element, apply a decorator. More...

Element &	operator\|= (Element &e, Decorator d)
	Apply a decorator to an element. More...

Elements	operator\| (Elements elements, Decorator decorator)
	From a set of element, apply a decorator to every elements. More...

Decorator	operator\| (Decorator a, Decorator b)
	Compose two decorator into one. More...

Element	text (std::string text)
	Display a piece of UTF8 encoded unicode text. More...

Element	vtext (std::string text)
	Display a piece of unicode text vertically. More...

Element	separator ()
	Draw a vertical or horizontal separation in between two other elements. More...

Element	separatorLight ()
	Draw a vertical or horizontal separation in between two other elements, using the LIGHT style. More...

Element	separatorDashed ()
	Draw a vertical or horizontal separation in between two other elements, using the DASHED style. More...

Element	separatorHeavy ()
	Draw a vertical or horizontal separation in between two other elements, using the HEAVY style. More...

Element	separatorDouble ()
	Draw a vertical or horizontal separation in between two other elements, using the DOUBLE style. More...

Element	separatorEmpty ()
	Draw a vertical or horizontal separation in between two other elements, using the EMPTY style. More...

Element	separatorStyled (BorderStyle style)
	Draw a vertical or horizontal separation in between two other elements. More...

Element	separator (Pixel pixel)
	Draw a separator in between two element filled with a given pixel. More...

Element	separatorCharacter (std::string value)
	Draw a vertical or horizontal separation in between two other elements. More...

Element	separatorHSelector (float left, float right, Color unselected_color, Color selected_color)
	Draw an horizontal bar, with the area in between left/right colored differently. More...

Element	separatorVSelector (float up, float down, Color unselected_color, Color selected_color)
	Draw an vertical bar, with the area in between up/downcolored differently. More...

Element	gauge (float progress)
	Draw a high definition progress bar. More...

Element	gaugeLeft (float progress)
	Draw a high definition progress bar progressing from right to left. More...

Element	gaugeRight (float progress)
	Draw a high definition progress bar progressing from left to right. More...

Element	gaugeUp (float progress)
	Draw a high definition progress bar progressing from bottom to top. More...

Element	gaugeDown (float progress)
	Draw a high definition progress bar progressing from top to bottom. More...

Element	gaugeDirection (float progress, Direction direction)
	Draw a high definition progress bar progressing in specified direction. More...

Element	border (Element child)
	Draw a border around the element. More...

Element	borderLight (Element child)
	Draw a dashed border around the element. More...

Element	borderDashed (Element child)
	Draw a light border around the element. More...

Element	borderHeavy (Element child)
	Draw a heavy border around the element. More...

Element	borderDouble (Element child)
	Draw a double border around the element. More...

Element	borderRounded (Element child)
	Draw a rounded border around the element. More...

Element	borderEmpty (Element child)
	Draw an empty border around the element. More...

Decorator	borderStyled (BorderStyle style)
	Same as border but with different styles. More...

Decorator	borderStyled (BorderStyle style, Color foreground_color)
	Same as border but with a foreground color and a different style. More...

Decorator	borderStyled (Color foreground_color)
	Same as border but with a foreground color. More...

Decorator	borderWith (const Pixel &pixel)
	Same as border but with a constant Pixel around the element. More...

Element	window (Element title, Element content)
	Draw window with a title and a border around the element. More...

Element	spinner (int charset_index, size_t image_index)
	Useful to represent the effect of time and/or events. This display an ASCII art "video". More...

Element	paragraph (const std::string &the_text)
	Return an element drawing the paragraph on multiple lines. More...

Element	paragraphAlignLeft (const std::string &the_text)
	Return an element drawing the paragraph on multiple lines, aligned on the left. More...

Element	paragraphAlignRight (const std::string &the_text)
	Return an element drawing the paragraph on multiple lines, aligned on the right. More...

Element	paragraphAlignCenter (const std::string &the_text)
	Return an element drawing the paragraph on multiple lines, aligned on the center. More...

Element	paragraphAlignJustify (const std::string &the_text)
	Return an element drawing the paragraph on multiple lines, aligned using a justified alignment. the center. More...

Element	graph (GraphFunction graph_function)
	Draw a graph using a GraphFunction. More...

Element	emptyElement ()

Element	canvas (ConstRef< Canvas > canvas)
	Produce an element from a Canvas, or a reference to a Canvas. More...

Element	canvas (int width, int height, std::function< void(Canvas &)> fn)
	Produce an element drawing a canvas of requested size. More...

Element	canvas (std::function< void(Canvas &)> fn)
	Produce an element drawing a canvas. More...

Element	bold (Element child)
	Use a bold font, for elements with more emphasis. More...

Element	dim (Element child)
	Use a light font, for elements with less emphasis. More...

Element	inverted (Element child)
	Add a filter that will invert the foreground and the background colors. More...

Element	underlined (Element child)
	Make the underlined element to be underlined. More...

Element	underlinedDouble (Element child)
	Apply a underlinedDouble to text. More...

Element	blink (Element child)
	The text drawn alternates in between visible and hidden. More...

Element	strikethrough (Element child)
	Apply a strikethrough to text. More...

Decorator	color (Color c)
	Decorate using a foreground color. More...

Decorator	bgcolor (Color color)
	Decorate using a background color. More...

Decorator	color (const LinearGradient &gradient)
	Decorate using a linear-gradient effect on the foreground color. More...

Decorator	bgcolor (const LinearGradient &gradient)
	Decorate using a linear-gradient effect on the background color. More...

Element	color (Color color, Element child)
	Set the foreground color of an element. More...

Element	bgcolor (Color color, Element child)
	Set the background color of an element. More...

Element	color (const LinearGradient &gradient, Element child)
	Set the foreground color of an element with linear-gradient effect. More...

Element	bgcolor (const LinearGradient &gradient, Element child)
	Set the background color of an element with linear-gradient effect. More...

Decorator	focusPosition (int x, int y)
	Used inside a `frame`, this force the view to be scrolled toward a a given position. The position is expressed in the numbers of cells. More...

Decorator	focusPositionRelative (float x, float y)
	Used inside a `frame`, this force the view to be scrolled toward a a given position. The position is expressed in proportion of the requested size. More...

Element	automerge (Element child)
	Enable character to be automatically merged with others nearby. More...

Decorator	hyperlink (std::string link)
	Decorate using an hyperlink. The link will be opened when the user click on it. This is supported only on a limited set of terminal emulator. List: https://github.com/Alhadis/OSC8-Adoption/. More...

Element	hyperlink (std::string link, Element child)
	Make the rendered area clickable using a web browser. The link will be opened when the user click on it. This is supported only on a limited set of terminal emulator. List: https://github.com/Alhadis/OSC8-Adoption/. More...

Element	hbox (Elements children)
	A container displaying elements horizontally one by one. More...

Element	vbox (Elements children)
	A container displaying elements vertically one by one. More...

Element	dbox (Elements children_)
	Stack several element on top of each other. More...

Element	flexbox (Elements, FlexboxConfig config=FlexboxConfig())

Element	gridbox (std::vector< Elements > lines)
	A container displaying a grid of elements. More...

Element	hflow (Elements)

Element	vflow (Elements)

Element	flex (Element child)
	Make a child element to expand proportionnally to the space left in a container. More...

Element	flex_grow (Element child)
	Expand if possible. More...

Element	flex_shrink (Element child)
	Minimize if needed. More...

Element	xflex (Element child)
	Expand/Minimize if possible/needed on the X axis. More...

Element	xflex_grow (Element child)
	Expand if possible on the X axis. More...

Element	xflex_shrink (Element child)
	Minimize if needed on the X axis. More...

Element	yflex (Element child)
	Expand/Minimize if possible/needed on the Y axis. More...

Element	yflex_grow (Element child)
	Expand if possible on the Y axis. More...

Element	yflex_shrink (Element child)
	Minimize if needed on the Y axis. More...

Element	notflex (Element child)
	Make the element not flexible. More...

Element	filler ()
	An element that will take expand proportionnally to the space left in a container. More...

Decorator	size (WidthOrHeight direction, Constraint constraint, int value)
	Apply a constraint on the size of an element. More...

Element	frame (Element child)
	Allow an element to be displayed inside a 'virtual' area. It size can be larger than its container. In this case only a smaller portion is displayed. The view is scrollable to make the focused element visible. More...

Element	xframe (Element child)
	Same as `frame`, but only on the x-axis. More...

Element	yframe (Element child)
	Same as `frame`, but only on the y-axis. More...

Element	focus (Element child)
	Set the `child` to be the one in focus globally. More...

Element	select (Element child)
	Set the `child` to be the one selected among its siblings. More...

Element	focusCursorBlock (Element child)
	Same as `focus`, but set the cursor shape to be a still block. More...

Element	focusCursorBlockBlinking (Element child)
	Same as `focus`, but set the cursor shape to be a blinking block. More...

Element	focusCursorBar (Element child)
	Same as `focus`, but set the cursor shape to be a still block. More...

Element	focusCursorBarBlinking (Element child)
	Same as `focus`, but set the cursor shape to be a blinking bar. More...

Element	focusCursorUnderline (Element child)
	Same as `focus`, but set the cursor shape to be a still underline. More...

Element	focusCursorUnderlineBlinking (Element child)
	Same as `focus`, but set the cursor shape to be a blinking underline. More...

Element	vscroll_indicator (Element child)
	Display a vertical scrollbar to the right. colors. More...

Element	hscroll_indicator (Element child)
	Display an horizontal scrollbar to the bottom. colors. More...

Decorator	reflect (Box &box)

Element	clear_under (Element element)
	Before drawing \|child\|, clear the pixels below. This is useful in. More...

Element	hcenter (Element child)
	Center an element horizontally. More...

Element	vcenter (Element child)
	Center an element vertically. More...

Element	center (Element child)
	Center an element horizontally and vertically. More...

Element	align_right (Element child)
	Align an element on the right side. More...

Element	nothing (Element element)
	A decoration doing absolutely nothing. More...

void	Render (Screen &screen, const Element &element)
	Display an element on a ftxui::Screen. More...

void	Render (Screen &screen, Node *node)
	Display an element on a ftxui::Screen. More...

Color	operator""_rgb (unsigned long long int combined)
	Creates a color from a combined hex RGB representation, e.g. 0x808000_rgb. More...

ColorInfo	GetColorInfo (Color::Palette256 index)

ColorInfo	GetColorInfo (Color::Palette16 index)

int	wchar_width (wchar_t)

int	wstring_width (const std::wstring &)

std::string	to_string (const std::wstring &s)
	Convert a UTF8 std::string into a std::wstring. More...

std::wstring	to_wstring (const std::string &s)
	Convert a std::wstring into a UTF8 std::string. More...

template<typename T >
std::wstring	to_wstring (T s)

int	string_width (const std::string &)

std::vector< std::string >	Utf8ToGlyphs (const std::string &input)

std::vector< int >	CellToGlyphIndex (const std::string &input)

Component	CatchEvent (Component child, std::function< bool(Event event)> on_event)
	Return a component, using \|on_event\| to catch events. This function must returns true when the event has been handled, false otherwise. More...

template Component	Slider (SliderOption< int8_t >)

template Component	Slider (SliderOption< int16_t >)

template Component	Slider (SliderOption< int32_t >)

template Component	Slider (SliderOption< int64_t >)

template Component	Slider (SliderOption< uint8_t >)

template Component	Slider (SliderOption< uint16_t >)

template Component	Slider (SliderOption< uint32_t >)

template Component	Slider (SliderOption< uint64_t >)

template Component	Slider (SliderOption< float >)

template Component	Slider (SliderOption< double >)

bool	EatCodePoint (const std::string &input, size_t start, size_t end, uint32_t ucs)

bool	EatCodePoint (const std::wstring &input, size_t start, size_t end, uint32_t ucs)

bool	IsCombining (uint32_t ucs)

bool	IsFullWidth (uint32_t ucs)

bool	IsControl (uint32_t ucs)

WordBreakProperty	CodepointToWordBreakProperty (uint32_t codepoint)

size_t	GlyphPrevious (const std::string &input, size_t start)

size_t	GlyphNext (const std::string &input, size_t start)

size_t	GlyphIterate (const std::string &input, int glyph_offset, size_t start)

int	GlyphCount (const std::string &input)

std::vector< WordBreakProperty >	Utf8ToWordBreakProperty (const std::string &input)

bool	IsWordBreakingCharacter (const std::string &input, size_t glyph_index)

Enumerations
enum class	Direction { Up = 0 , Down = 1 , Left = 2 , Right = 3 }

enum	BorderStyle { LIGHT , DASHED , HEAVY , DOUBLE , ROUNDED , EMPTY }

enum	WidthOrHeight { WIDTH , HEIGHT }

enum	Constraint { LESS_THAN , EQUAL , GREATER_THAN }

enum class	WordBreakProperty : int8_t { ALetter , CR , Double_Quote , Extend , ExtendNumLet , Format , Hebrew_Letter , Katakana , LF , MidLetter , MidNum , MidNumLet , Newline , Numeric , Regional_Indicator , Single_Quote , WSegSpace , ZWJ }

Typedefs
using	CapturedMouse = std::unique_ptr< CapturedMouseInterface >

using	ComponentDecorator = std::function< Component(Component)>

using	ElementDecorator = std::function< Element(Element)>

using	Component = std::shared_ptr< ComponentBase >

using	Components = std::vector< Component >

template<class T >
using	Sender = std::unique_ptr< SenderImpl< T > >

template<class T >
using	Receiver = std::unique_ptr< ReceiverImpl< T > >

using	Closure = std::function< void()>

using	Task = std::variant< Event, Closure, AnimationTask >

using	Element = std::shared_ptr< Node >

using	Elements = std::vector< Element >

using	Decorator = std::function< Element(Element)>

using	GraphFunction = std::function< std::vector< int >(int, int)>

Data Structures
struct	AnimatedColorOption
	Option about a potentially animated color. More...

struct	AnimatedColorsOption

class	AnimationTask

class	AutoReset
	Assign a value to a variable, reset its old value when going out of scope. More...

struct	Box

struct	ButtonOption
	Option for the AnimatedButton component. More...

struct	Canvas

class	CapturedMouseInterface

struct	CheckboxOption
	Option for the Checkbox component. More...

class	Color
	A class representing terminal colors. More...

struct	ColorInfo

class	ComponentBase
	It implement rendering itself as ftxui::Element. It implement keyboard navigation by responding to ftxui::Event. More...

class	ConstRef
	An adapter. Own or reference an immutable object. More...

class	ConstStringListRef
	An adapter. Reference a list of strings. More...

class	ConstStringRef
	An adapter. Own or reference a constant string. For convenience, this class convert multiple immutable string toward a shared representation. More...

struct	Dimensions

struct	EntryState
	arguments for \|ButtonOption::transform\|, \|CheckboxOption::transform\|, \|Radiobox::transform\|, \|MenuEntryOption::transform\|, \|MenuOption::transform\|. More...

struct	Event
	Represent an event. It can be key press event, a terminal resize, or more ... More...

struct	FlexboxConfig

struct	InputOption
	Option for the Input component. More...

struct	InputState
	Used to define style for the Input component. More...

struct	LinearGradient
	A class representing the settings for linear-gradient color effect. More...

class	Loop

struct	MenuEntryOption
	Option for the MenuEntry component. More...

struct	MenuOption
	Option for the Menu component. More...

struct	Mouse
	A mouse event. It contains the coordinate of the mouse, the button pressed and the modifier (shift, ctrl, meta). More...

class	Node

class	NodeDecorator

struct	Pixel
	A unicode character and its associated style. More...

struct	RadioboxOption
	Option for the Radiobox component. More...

class	ReceiverImpl

class	Ref
	An adapter. Own or reference an mutable object. More...

struct	Requirement

struct	ResizableSplitOption

class	Screen
	A rectangular grid of Pixel. More...

class	ScreenInteractive

class	SenderImpl

struct	SliderOption

class	StringRef
	An adapter. Own or reference a constant string. For convenience, this class convert multiple mutable string toward a shared representation. More...

class	Table

class	TableSelection

class	TerminalInputParser

struct	UnderlineOption

struct	WindowOptions

struct	WindowRenderState

Namespaces
namespace	animation

namespace	box_helper

namespace	Container

namespace	Dimension
	Define how the Screen's dimensions should look like.

namespace	flexbox_helper

namespace	literals

namespace	Terminal

namespace	util

Variables
const std::map< std::string, std::string >	g_uniformize

const std::array< ColorInfo, 256 >	palette256

Data Structure Documentation

◆ ftxui::AnimatedColorsOption

struct ftxui::AnimatedColorsOption

Definition at line 70 of file component_options.hpp.

Data Fields
AnimatedColorOption	background
AnimatedColorOption	foreground

◆ ftxui::AnimationTask

class ftxui::AnimationTask

Definition at line 12 of file task.hpp.

◆ ftxui::ColorInfo

struct ftxui::ColorInfo

Definition at line 12 of file color_info.hpp.

Data Fields
const char *	name
uint8_t	index_256
uint8_t	index_16
uint8_t	red
uint8_t	green
uint8_t	blue
uint8_t	hue
uint8_t	saturation
uint8_t	value

◆ ftxui::Dimensions

struct ftxui::Dimensions

Definition at line 8 of file terminal.hpp.

Data Fields
int	dimx
int	dimy

◆ ftxui::EntryState

struct ftxui::EntryState

arguments for |ButtonOption::transform|, |CheckboxOption::transform|, |Radiobox::transform|, |MenuEntryOption::transform|, |MenuOption::transform|.

Examples: examples/component/button.cpp, examples/component/menu_entries.cpp, and examples/component/menu_style.cpp.

Definition at line 24 of file component_options.hpp.

Data Fields
string	label	The label to display.
bool	state	The state of the button/checkbox/radiobox.
bool	active	Whether the entry is the active one.
bool	focused	Whether the entry is one focused by the user.

◆ ftxui::InputState

struct ftxui::InputState

Used to define style for the Input component.

Examples: examples/component/input_style.cpp.

Definition at line 152 of file component_options.hpp.

Data Fields
Element	element
bool	hovered	Whether the input is hovered by the mouse.
bool	focused	Whether the input is focused by the user.
bool	is_placeholder	Whether the input is empty and displaying the placeholder.

◆ ftxui::MenuEntryOption

struct ftxui::MenuEntryOption

Option for the MenuEntry component.

Examples: examples/component/menu_entries.cpp, and examples/component/menu_entries_animated.cpp.

Definition at line 77 of file component_options.hpp.

Data Fields
ConstStringRef	label
function< Element(const EntryState &state)>	transform
AnimatedColorsOption	animated_colors

◆ ftxui::ResizableSplitOption

struct ftxui::ResizableSplitOption

Definition at line 210 of file component_options.hpp.

Data Fields
Component	main
Component	back
Ref< Direction >	direction
Ref< int >	main_size
function< Element()>	separator_func

◆ ftxui::SliderOption

struct ftxui::SliderOption

template<typename T>
struct ftxui::SliderOption< T >

Examples: examples/component/slider_direction.cpp.

Definition at line 223 of file component_options.hpp.

Data Fields
Ref< T >	value
ConstRef< T >	min
ConstRef< T >	max
ConstRef< T >	increment
Direction	direction
Color	color_active
Color	color_inactive

◆ ftxui::WindowOptions

struct ftxui::WindowOptions

Definition at line 248 of file component_options.hpp.

Data Fields
Component	inner	The component wrapped by this window.
ConstStringRef	title	The title displayed by this window.
Ref< int >	left	The left side position of the window.
Ref< int >	top	The top side position of the window.
Ref< int >	width	The width of the window.
Ref< int >	height	The height of the window.
Ref< bool >	resize_left	Can the left side be resized?
Ref< bool >	resize_right	Can the right side be resized?
Ref< bool >	resize_top	Can the top side be resized?
Ref< bool >	resize_down	Can the down side be resized?
function< Element(const WindowRenderState &)>	render	An optional function to customize how the window looks like:

◆ ftxui::WindowRenderState

struct ftxui::WindowRenderState

Definition at line 234 of file component_options.hpp.

Data Fields
Element	inner	The element wrapped inside this window.
const string &	title	The title of the window.
bool	active	Whether the window is the active one.
bool	drag	Whether the window is being dragged.
bool	resize	Whether the window is being resized.
bool	hover_left	Whether the resizeable left side is hovered.
bool	hover_right	Whether the resizeable right side is hovered.
bool	hover_top	Whether the resizeable top side is hovered.
bool	hover_down	Whether the resizeable down side is hovered.

Typedef Documentation

◆ CapturedMouse

using CapturedMouse = std::unique_ptr<CapturedMouseInterface>

Definition at line 14 of file captured_mouse.hpp.

◆ ComponentDecorator

using ComponentDecorator = std::function<Component(Component)>

Definition at line 33 of file component.hpp.

◆ ElementDecorator

using ElementDecorator = std::function<Element(Element)>

Definition at line 34 of file component.hpp.

◆ Component

typedef std::shared_ptr< ComponentBase > Component

Definition at line 24 of file component_base.hpp.

◆ Components

using Components = std::vector<Component>

Definition at line 25 of file component_base.hpp.

◆ Sender

using Sender = std::unique_ptr<SenderImpl<T> >

Definition at line 47 of file receiver.hpp.

◆ Receiver

using Receiver = std::unique_ptr<ReceiverImpl<T> >

Definition at line 48 of file receiver.hpp.

◆ Closure

using Closure = std::function<void()>

Definition at line 13 of file task.hpp.

◆ Task

using Task = std::variant<Event, Closure, AnimationTask>

Definition at line 14 of file task.hpp.

◆ Element

typedef std::shared_ptr< Node > Element

Definition at line 23 of file elements.hpp.

◆ Elements

typedef std::vector< Element > Elements

Definition at line 24 of file elements.hpp.

◆ Decorator

using Decorator = std::function<Element(Element)>

Definition at line 25 of file elements.hpp.

◆ GraphFunction

using GraphFunction = std::function<std::vector<int>(int, int)>

Definition at line 26 of file elements.hpp.

Enumeration Type Documentation

◆ Direction

enum class Direction

strong

Enumerator
Up
Down
Left
Right

Definition at line 8 of file direction.hpp.

◆ BorderStyle

enum BorderStyle

Enumerator
LIGHT
DASHED
HEAVY
DOUBLE
ROUNDED
EMPTY

Definition at line 28 of file elements.hpp.

◆ WidthOrHeight

enum WidthOrHeight

Enumerator
WIDTH
HEIGHT

Definition at line 148 of file elements.hpp.

◆ Constraint

enum Constraint

Enumerator
LESS_THAN
EQUAL
GREATER_THAN

Definition at line 149 of file elements.hpp.

◆ WordBreakProperty

enum class WordBreakProperty : int8_t

strong

Enumerator
ALetter
CR
Double_Quote
Extend
ExtendNumLet
Format
Hebrew_Letter
Katakana
LF
MidLetter
MidNum
MidNumLet
Newline
Numeric
Regional_Indicator
Single_Quote
WSegSpace
ZWJ

Definition at line 38 of file string_internal.hpp.

Function Documentation

◆ Make()

std::shared_ptr< T > Make ( Args &&... args )

Definition at line 28 of file component.hpp.

◆ operator|() [1/5]

Component operator\|	(	Component	component,
		ComponentDecorator	decorator
	)

Definition at line 12 of file util.cpp.

◆ operator|() [2/5]

Component operator\|	(	Component	component,
		ElementDecorator	decorator
	)

Definition at line 17 of file util.cpp.

◆ operator|=() [1/3]

Component & operator\|=	(	Component &	component,
		ComponentDecorator	decorator
	)

Definition at line 22 of file util.cpp.

◆ operator|=() [2/3]

Component & operator\|=	(	Component &	component,
		ElementDecorator	decorator
	)

Definition at line 28 of file util.cpp.

◆ Button() [1/2]

Component Button ( ButtonOption option )

Draw a button. Execute a function when clicked.

Parameters

option Additional optional parameters.

See also: ButtonBase

Example

auto screen = ScreenInteractive::FitComponent();
Component button = Button({
  .label = "Click to quit",
  .on_click = screen.ExitLoopClosure(),
});
screen.Loop(button)

Output

┌─────────────┐
│Click to quit│
└─────────────┘

Examples: examples/component/button.cpp, examples/component/button_animated.cpp, examples/component/button_in_frame.cpp, examples/component/button_style.cpp, examples/component/composition.cpp, examples/component/gallery.cpp, examples/component/modal_dialog.cpp, examples/component/modal_dialog_custom.cpp, examples/component/nested_screen.cpp, examples/component/renderer.cpp, and examples/component/with_restored_io.cpp.

Definition at line 175 of file button.cpp.

◆ Button() [2/2]

Component Button	(	ConstStringRef	label,
		std::function< void()>	on_click,
		ButtonOption	option
	)

Draw a button. Execute a function when clicked.

Parameters

label	The label of the button.
on_click	The action to execute when clicked.
option	Additional optional parameters.

See also: ButtonBase

Example

auto screen = ScreenInteractive::FitComponent();
std::string label = "Click to quit";
Component button = Button(&label, screen.ExitLoopClosure());
screen.Loop(button)

Output

┌─────────────┐
│Click to quit│
└─────────────┘

Definition at line 203 of file button.cpp.

◆ Checkbox() [1/2]

Component Checkbox ( CheckboxOption options )

Examples: examples/component/checkbox_in_frame.cpp, examples/component/flexbox_gallery.cpp, examples/component/gallery.cpp, examples/component/homescreen.cpp, examples/component/maybe.cpp, and examples/component/window.cpp.

◆ Checkbox() [2/2]

Component Checkbox	(	ConstStringRef	label,
		bool *	checked,
		CheckboxOption	option
	)

Draw checkable element.

Parameters

label	The label of the checkbox.
checked	Whether the checkbox is checked or not.
option	Additional optional parameters.

See also: CheckboxBase

Example

auto screen = ScreenInteractive::FitComponent();
std::string label = "Make a sandwidth";
bool checked = false;
Component checkbox = Checkbox(&label, &checked);
screen.Loop(checkbox)

Output

☐ Make a sandwitch

Definition at line 111 of file checkbox.cpp.

◆ Input() [1/3]

Component Input ( InputOption option )

An input box for editing text.

Parameters

option Additional optional parameters.

See also: InputBase

Example

auto screen = ScreenInteractive::FitComponent();
std::string content= "";
std::string placeholder = "placeholder";
Component input = Input({
  .content = &content,
  .placeholder = &placeholder,
})
screen.Loop(input);

Output

placeholder

Examples: examples/component/checkbox.cpp, examples/component/gallery.cpp, examples/component/homescreen.cpp, examples/component/input.cpp, examples/component/input_style.cpp, and examples/component/textarea.cpp.

Definition at line 564 of file input.cpp.

◆ Input() [2/3]

Component Input	(	StringRef	content,
		InputOption	option
	)

An input box for editing text.

Parameters

content	The editable content.
option	Additional optional parameters.

See also: InputBase

Example

auto screen = ScreenInteractive::FitComponent();
std::string content= "";
std::string placeholder = "placeholder";
Component input = Input(content, {
  .placeholder = &placeholder,
  .password = true,
})
screen.Loop(input);

Output

placeholder

Definition at line 592 of file input.cpp.

◆ Input() [3/3]

Component Input	(	StringRef	content,
		StringRef	placeholder,
		InputOption	option
	)

An input box for editing text.

Parameters

content	The editable content.
option	Additional optional parameters.

See also: InputBase

Example

auto screen = ScreenInteractive::FitComponent();
std::string content= "";
std::string placeholder = "placeholder";
Component input = Input(content, placeholder);
screen.Loop(input);

Output

placeholder

Definition at line 618 of file input.cpp.

◆ Menu() [1/2]

Component Menu ( MenuOption option )

A list of text. The focused element is selected.

Parameters

option a structure containing all the paramters.

Example

auto screen = ScreenInteractive::TerminalOutput();
std::vector<std::string> entries = {
    "entry 1",
    "entry 2",
    "entry 3",
};
int selected = 0;
auto menu = Menu({
  .entries = &entries,
  .selected = &selected,
});
screen.Loop(menu);

Output

> entry 1
  entry 2
  entry 3

Examples: examples/component/canvas_animated.cpp, examples/component/gallery.cpp, examples/component/homescreen.cpp, examples/component/menu.cpp, examples/component/menu2.cpp, examples/component/menu_in_frame.cpp, examples/component/menu_in_frame_horizontal.cpp, examples/component/menu_multiple.cpp, examples/component/menu_style.cpp, examples/component/menu_underline_animated_gallery.cpp, and examples/component/tab_vertical.cpp.

Definition at line 513 of file menu.cpp.

◆ Menu() [2/2]

Component Menu	(	ConstStringListRef	entries,
		int *	selected,
		MenuOption	option
	)

A list of text. The focused element is selected.

Parameters

entries	The list of entries in the menu.
selected	The index of the currently selected element.
option	Additional optional parameters.

Example

auto screen = ScreenInteractive::TerminalOutput();
std::vector<std::string> entries = {
    "entry 1",
    "entry 2",
    "entry 3",
};
int selected = 0;
auto menu = Menu(&entries, &selected);
screen.Loop(menu);

Output

> entry 1
  entry 2
  entry 3

Definition at line 544 of file menu.cpp.

◆ MenuEntry() [1/2]

Component MenuEntry ( MenuEntryOption option )

A specific menu entry. They can be put into a Container::Vertical to form a menu.

Parameters

option The parameters.

Example

auto screen = ScreenInteractive::TerminalOutput();
int selected = 0;
auto menu = Container::Vertical({
   MenuEntry({.label = "entry 1"}),
   MenuEntry({.label = "entry 2"}),
   MenuEntry({.label = "entry 3"}),
}, &selected);
screen.Loop(menu);

Output

> entry 1
  entry 2
  entry 3

Examples: examples/component/menu_entries.cpp, and examples/component/menu_entries_animated.cpp.

Definition at line 615 of file menu.cpp.

◆ MenuEntry() [2/2]

Component MenuEntry	(	ConstStringRef	label,
		MenuEntryOption	option
	)

A specific menu entry. They can be put into a Container::Vertical to form a menu.

Parameters

label	The text drawn representing this element.
option	Additional optional parameters.

Example

auto screen = ScreenInteractive::TerminalOutput();
int selected = 0;
auto menu = Container::Vertical({
   MenuEntry("entry 1"),
   MenuEntry("entry 2"),
   MenuEntry("entry 3"),
}, &selected);
screen.Loop(menu);

Output

> entry 1
  entry 2
  entry 3

Definition at line 585 of file menu.cpp.

◆ Radiobox() [1/2]

Component Radiobox ( RadioboxOption option )

A list of element, where only one can be selected.

Parameters

option The parameters

See also: RadioboxBase

Example

auto screen = ScreenInteractive::TerminalOutput();
std::vector<std::string> entries = {
    "entry 1",
    "entry 2",
    "entry 3",
};
int selected = 0;
auto menu = Radiobox({
  .entries = entries,
  .selected = &selected,
});
screen.Loop(menu);

Output

◉ entry 1
○ entry 2
○ entry 3

Examples: examples/component/flexbox_gallery.cpp, examples/component/gallery.cpp, examples/component/homescreen.cpp, examples/component/maybe.cpp, examples/component/radiobox.cpp, examples/component/radiobox_in_frame.cpp, examples/component/tab_horizontal.cpp, and examples/component/tab_vertical.cpp.

Definition at line 207 of file radiobox.cpp.

◆ Radiobox() [2/2]

Component Radiobox	(	ConstStringListRef	entries,
		int *	selected,
		RadioboxOption	option
	)

A list of element, where only one can be selected.

Parameters

entries	The list of entries in the list.
selected	The index of the currently selected element.
option	Additional optional parameters.

See also: RadioboxBase

Example

auto screen = ScreenInteractive::TerminalOutput();
std::vector<std::string> entries = {
    "entry 1",
    "entry 2",
    "entry 3",
};
int selected = 0;
auto menu = Radiobox(&entries, &selected);
screen.Loop(menu);

Output

◉ entry 1
○ entry 2
○ entry 3

Definition at line 239 of file radiobox.cpp.

◆ Dropdown()

Component Dropdown	(	ConstStringListRef	entries,
		int *	selected
	)

A dropdown menu.

Parameters

entries	The list of entries to display.
selected	The index of the selected entry.

Examples: examples/component/dropdown.cpp.

Definition at line 22 of file dropdown.cpp.

◆ Toggle()

Component Toggle	(	ConstStringListRef	entries,
		int *	selected
	)

An horizontal list of elements. The user can navigate through them.

Parameters

entries	The list of selectable entries to display.
selected	Reference the selected entry. See also \|Menu\|.

Examples: examples/component/gallery.cpp, examples/component/menu_style.cpp, examples/component/tab_horizontal.cpp, and examples/component/toggle.cpp.

Definition at line 555 of file menu.cpp.

◆ Slider() [1/14]

Component Slider ( SliderOption< T > options )

A slider in any direction.

Parameters

options The options

Example

auto screen = ScreenInteractive::TerminalOutput();
int value = 50;
auto slider = Slider({
  .value = &value,
  .min = 0,
  .max = 100,
  .increment= 20,
});
screen.Loop(slider);

Examples: examples/component/focus.cpp, examples/component/gallery.cpp, examples/component/linear_gradient_gallery.cpp, examples/component/slider.cpp, examples/component/slider_rgb.cpp, and examples/component/window.cpp.

Definition at line 338 of file slider.cpp.

◆ Slider() [2/14]

Component Slider	(	ConstStringRef	label,
		Ref< int >	value,
		ConstRef< int >	min,
		ConstRef< int >	max,
		ConstRef< int >	increment
	)

An horizontal slider.

Parameters

label	The name of the slider.
value	The current value of the slider.
min	The minimum value.
max	The maximum value.
increment	The increment when used by the cursor.

Example

auto screen = ScreenInteractive::TerminalOutput();
int value = 50;
auto slider = Slider("Value:", &value, 0, 100, 1);
screen.Loop(slider);

Output

Value:[██████████████████████████ ]

Definition at line 281 of file slider.cpp.

◆ Slider() [3/14]

Component Slider	(	ConstStringRef	label,
		Ref< float >	value,
		ConstRef< float >	min = `0.f`,
		ConstRef< float >	max = `100.f`,
		ConstRef< float >	increment = `5.f`
	)

Definition at line 295 of file slider.cpp.

◆ Slider() [4/14]

Component Slider	(	ConstStringRef	label,
		Ref< long >	value,
		ConstRef< long >	min = `0l`,
		ConstRef< long >	max = `100l`,
		ConstRef< long >	increment = `5l`
	)

Definition at line 308 of file slider.cpp.

◆ ResizableSplit()

Component ResizableSplit ( ResizableSplitOption options )

A split in between two components.

Parameters

options all the parameters.

Example

auto left = Renderer([] { return text("Left") | center;});
auto right = Renderer([] { return text("right") | center;});
int left_size = 10;
auto component = ResizableSplit({
  .main = left,
  .back = right,
  .direction = Direction::Left,
  .main_size = &left_size,
  .separator_func = [] { return separatorDouble(); },
});

Output

       ║
left   ║   right
       ║

Definition at line 164 of file resizable_split.cpp.

◆ ResizableSplitLeft()

Component ResizableSplitLeft	(	Component	main,
		Component	back,
		int *	main_size
	)

An horizontal split in between two components, configurable using the mouse.

Parameters

main	The main component of size \|main_size\|, on the left.
back	The back component taking the remaining size, on the right.
main_size	The size of the \|main\| component.

Example

auto screen = ScreenInteractive::Fullscreen();
int left_size = 10;
auto left = Renderer([] { return text("Left") | center;});
auto right = Renderer([] { return text("right") | center;});
auto split = ResizableSplitLeft(left, right, &left_size);
screen.Loop(split);

Output

       │
left   │   right
       │

Examples: examples/component/homescreen.cpp, examples/component/resizable_split.cpp, and examples/component/textarea.cpp.

Definition at line 193 of file resizable_split.cpp.

◆ ResizableSplitRight()

Component ResizableSplitRight	(	Component	main,
		Component	back,
		int *	main_size
	)

An horizontal split in between two components, configurable using the mouse.

Parameters

main	The main component of size \|main_size\|, on the right.
back	The back component taking the remaining size, on the left.
main_size	The size of the \|main\| component.

Example

auto screen = ScreenInteractive::Fullscreen();
int right_size = 10;
auto left = Renderer([] { return text("Left") | center;});
auto right = Renderer([] { return text("right") | center;});
auto split = ResizableSplitRight(right, left, &right_size)
screen.Loop(split);

Output

       │
left   │   right
       │

Examples: examples/component/flexbox_gallery.cpp, and examples/component/resizable_split.cpp.

Definition at line 227 of file resizable_split.cpp.

◆ ResizableSplitTop()

Component ResizableSplitTop	(	Component	main,
		Component	back,
		int *	main_size
	)

An vertical split in between two components, configurable using the mouse.

Parameters

main	The main component of size \|main_size\|, on the top.
back	The back component taking the remaining size, on the bottom.
main_size	The size of the \|main\| component.

Example

auto screen = ScreenInteractive::Fullscreen();
int top_size = 1;
auto top = Renderer([] { return text("Top") | center;});
auto bottom = Renderer([] { return text("Bottom") | center;});
auto split = ResizableSplitTop(top, bottom, &top_size)
screen.Loop(split);

Output

   top
────────────
   bottom

Examples: examples/component/resizable_split.cpp.

Definition at line 261 of file resizable_split.cpp.

◆ ResizableSplitBottom()

Component ResizableSplitBottom	(	Component	main,
		Component	back,
		int *	main_size
	)

An vertical split in between two components, configurable using the mouse.

Parameters

main	The main component of size \|main_size\|, on the bottom.
back	The back component taking the remaining size, on the top.
main_size	The size of the \|main\| component.

Example

auto screen = ScreenInteractive::Fullscreen();
int bottom_size = 1;
auto top = Renderer([] { return text("Top") | center;});
auto bottom = Renderer([] { return text("Bottom") | center;});
auto split = ResizableSplit::Bottom(bottom, top, &bottom_size)
screen.Loop(split);

Output

   top
────────────
   bottom

Examples: examples/component/flexbox_gallery.cpp, and examples/component/resizable_split.cpp.

Definition at line 295 of file resizable_split.cpp.

◆ Renderer() [1/4]

Component Renderer	(	Component	child,
		std::function< Element()>	render
	)

Return a new Component, similar to |child|, but using |render| as the Component::Render() event.

Parameters

child	The component to forward events to.
render	The function drawing the interface.

Example

auto screen = ScreenInteractive::TerminalOutput();
std::string label = "Click to quit";
auto button = Button(&label, screen.ExitLoopClosure());
auto renderer = Renderer(button, [&] {
  return hbox({
    text("A button:"),
    button->Render(),
  });
});
screen.Loop(renderer);

Examples: examples/component/button.cpp, examples/component/button_animated.cpp, examples/component/button_in_frame.cpp, examples/component/button_style.cpp, examples/component/canvas_animated.cpp, examples/component/checkbox.cpp, examples/component/checkbox_in_frame.cpp, examples/component/collapsible.cpp, examples/component/composition.cpp, examples/component/custom_loop.cpp, examples/component/flexbox_gallery.cpp, examples/component/focus.cpp, examples/component/focus_cursor.cpp, examples/component/gallery.cpp, examples/component/homescreen.cpp, examples/component/input.cpp, examples/component/linear_gradient_gallery.cpp, examples/component/maybe.cpp, examples/component/menu2.cpp, examples/component/menu_entries.cpp, examples/component/menu_entries_animated.cpp, examples/component/menu_in_frame.cpp, examples/component/menu_in_frame_horizontal.cpp, examples/component/menu_multiple.cpp, examples/component/menu_style.cpp, examples/component/menu_underline_animated_gallery.cpp, examples/component/modal_dialog.cpp, examples/component/modal_dialog_custom.cpp, examples/component/nested_screen.cpp, examples/component/print_key_press.cpp, examples/component/radiobox_in_frame.cpp, examples/component/renderer.cpp, examples/component/resizable_split.cpp, examples/component/slider_rgb.cpp, examples/component/tab_horizontal.cpp, examples/component/tab_vertical.cpp, examples/component/textarea.cpp, examples/component/toggle.cpp, examples/component/window.cpp, and examples/component/with_restored_io.cpp.

Definition at line 63 of file renderer.cpp.

◆ Renderer() [2/4]

Component Renderer ( std::function< Element()> render )

Return a component, using |render| to render its interface.

Parameters

render The function drawing the interface.

Example

auto screen = ScreenInteractive::TerminalOutput();
auto renderer = Renderer([] {
  return text("My interface");
});
screen.Loop(renderer);

Definition at line 31 of file renderer.cpp.

◆ Renderer() [3/4]

Component Renderer ( std::function< Element(bool)> render )

Return a focusable component, using |render| to render its interface.

Parameters

render The function drawing the interface, taking a boolean telling whether the component is focused or not.

Example

auto screen = ScreenInteractive::TerminalOutput();
auto renderer = Renderer([] (bool focused) {
  if (focused)
    return text("My interface") | inverted;
  else
    return text("My interface");
});
screen.Loop(renderer);

Definition at line 86 of file renderer.cpp.

◆ Renderer() [4/4]

ComponentDecorator Renderer ( ElementDecorator decorator )

Decorate a component, by decorating what it renders.

Parameters

decorator the function modifying the element it renders.

Example

```cpp auto screen = ScreenInteractive::TerminalOutput(); auto renderer = */ // Renderer([] { return text("Hello");) /** | Renderer(bold) | Renderer(inverted); screen.Loop(renderer); ```

Definition at line 127 of file renderer.cpp.

◆ CatchEvent() [1/3]

Component CatchEvent	(	Component	child,
		std::function< bool(Event)>
	)

Examples: examples/component/canvas_animated.cpp, examples/component/custom_loop.cpp, examples/component/input.cpp, and examples/component/print_key_press.cpp.

◆ CatchEvent() [2/3]

ComponentDecorator CatchEvent ( std::function< bool(Event)> on_event )

Decorate a component, using |on_event| to catch events. This function must returns true when the event has been handled, false otherwise.

Parameters

on_event The function drawing the interface.

Example

auto screen = ScreenInteractive::TerminalOutput();
auto renderer = Renderer([] { return text("Hello world"); });
renderer |= CatchEvent([&](Event event) {
  if (event == Event::Character('q')) {
    screen.ExitLoopClosure()();
    return true;
  }
  return false;
});
screen.Loop(renderer);

Definition at line 82 of file catch_event.cpp.

◆ Maybe() [1/4]

Component Maybe	(	Component	child,
		const bool *	show
	)

Decorate a component |child|. It is shown only when |show| is true.

Parameters

child	the compoennt to decorate.
show	a boolean. \|child\| is shown when \|show\| is true.

Example

auto component = Renderer([]{ return text("Hello World!"); });

auto maybe_component = Maybe(component, &show);

ftxui::Maybe

Component Maybe(Component, const bool *show)

Decorate a component |child|. It is shown only when |show| is true.

Definition: maybe.cpp:75

Examples: examples/component/maybe.cpp.

Definition at line 75 of file maybe.cpp.

◆ Maybe() [2/4]

Component Maybe	(	Component	child,
		std::function< bool()>	show
	)

Decorate a component |child|. It is shown only when |show| returns true.

Parameters

child	the compoenent to decorate.
show	a function returning whether \|child\| should shown.

Definition at line 22 of file maybe.cpp.

◆ Maybe() [3/4]

ComponentDecorator Maybe ( const bool * show )

Decorate a component. It is shown only when |show| is true.

Parameters

show	a boolean. \|child\| is shown when \|show\| is true.

Example

auto component = Renderer([]{ return text("Hello World!"); });

auto maybe_component = component | Maybe(&show);

Definition at line 89 of file maybe.cpp.

◆ Maybe() [4/4]

ComponentDecorator Maybe ( std::function< bool()> show )

Decorate a component. It is shown only when the |show| function returns true.

Parameters

show	a function returning whether the decorated component should be shown.

Example

auto component = Renderer([]{ return text("Hello World!"); });

auto maybe_component = component | Maybe([&]{ return counter == 42; });

Definition at line 58 of file maybe.cpp.

◆ Modal() [1/2]

Component Modal	(	Component	main,
		Component	modal,
		const bool *	show_modal
	)

Examples: examples/component/modal_dialog.cpp.

Definition at line 18 of file modal.cpp.

◆ Modal() [2/2]

ComponentDecorator Modal	(	Component	modal,
		const bool *	show_modal
	)

Definition at line 58 of file modal.cpp.

◆ Collapsible()

Component Collapsible	(	ConstStringRef	label,
		Component	child,
		Ref< bool >	show = `false`
	)

Examples: examples/component/collapsible.cpp.

◆ Hoverable() [1/6]

Component Hoverable	(	Component	component,
		bool *	hover
	)

Wrap a component. Gives the ability to know if it is hovered by the mouse.

Parameters

component	The wrapped component.
hover	The value to reflect whether the component is hovered or not.

Example

auto button = Button("exit", screen.ExitLoopClosure());
bool hover = false;
auto button_hover = Hoverable(button, &hover);

Definition at line 44 of file hoverable.cpp.

◆ Hoverable() [2/6]

Component Hoverable	(	Component	component,
		std::function< void()>	on_enter,
		std::function< void()>	on_leave
	)

Wrap a component. Uses callbacks.

Parameters

component	The wrapped component.
on_enter	Callback OnEnter
on_leave	Callback OnLeave

Example

auto button = Button("exit", screen.ExitLoopClosure());
bool hover = false;
auto button_hover = Hoverable(button, &hover);

Definition at line 87 of file hoverable.cpp.

◆ Hoverable() [3/6]

Component Hoverable	(	Component	component,
		std::function< void(bool)>	on_change
	)

Wrap a component. Gives the ability to know if it is hovered by the mouse.

Parameters

on_enter	is called when the mouse hover the component.
on_leave	is called when the mouse leave the component.

Example

```cpp auto button = Button("exit", screen.ExitLoopClosure()); int on_enter_cnt = 0; int on_leave_cnt = 0; button |= Hoverable( [&]{ on_enter_cnt++; }, [&]{ on_leave_cnt++; } */ // ); /// ``` // NOLINTNEXTLINE ComponentDecorator Hoverable(std::function<void()> on_enter, // NOLINTNEXTLINE std::function<void()> on_leave) { return [on_enter, on_leave](Component component) { return Hoverable(std::move(component), on_enter, on_leave); }; }

/** Wrap a component. Gives the ability to know if it is hovered by the mouse.

Parameters

component	the wrapped component.
on_change	is called when the mouse enter or leave the component.

Example

```cpp auto button = Button("exit", screen.ExitLoopClosure()); bool hovered = false; auto button_hoverable = Hoverable(button, ```

Definition at line 189 of file hoverable.cpp.

◆ Hoverable() [4/6]

ComponentDecorator Hoverable ( bool * hover )

Wrap a component. Gives the ability to know if it is hovered by the mouse.

Parameters

hover The value to reflect whether the component is hovered or not.

Example

bool hover = false;
auto button = Button("exit", screen.ExitLoopClosure());
button |= Hoverable(&hover);

Definition at line 142 of file hoverable.cpp.

◆ Hoverable() [5/6]

ComponentDecorator Hoverable	(	std::function< void()>	on_enter,
		std::function< void()>	on_leave
	)

◆ Hoverable() [6/6]

ComponentDecorator Hoverable ( std::function< void(bool)> on_change )

Wrap a component. Gives the ability to know if it is hovered by the mouse.

Parameters

on_change is called when the mouse enter or leave the component.

Example

auto button = Button("exit", screen.ExitLoopClosure());
bool hovered = false;
button |= Hoverable([&](bool hover) { hovered = hover;});

Definition at line 210 of file hoverable.cpp.

◆ Window()

Component Window ( WindowOptions option )

A draggeable / resizeable window. To use multiple of them, they must be stacked using Container::Stacked({...}) component;.

Parameters

option A struct holding every parameters.

See also: Window

Example

auto window_1= Window({
    .inner = DummyWindowContent(),
    .title = "First window",
});
 
auto window_2= Window({
    .inner = DummyWindowContent(),
    .title = "Second window",
});
 
auto container = Container::Stacked({
  window_1,
  window_2,
});

Examples: examples/component/menu_multiple.cpp, and examples/component/window.cpp.

Definition at line 305 of file window.cpp.

◆ MakeReceiver()

Receiver< T > MakeReceiver ( )

Definition at line 134 of file receiver.hpp.

◆ text() [1/2]

Element text ( std::wstring text )

Display a piece of unicode text.

See also: ftxui::to_wstring

Example

Element document = text(L"Hello world!");

ftxui::Element

std::shared_ptr< Node > Element

Definition: elements.hpp:23

Output

Hello world!

Examples: examples/component/button.cpp, examples/component/button_animated.cpp, examples/component/button_in_frame.cpp, examples/component/button_style.cpp, examples/component/collapsible.cpp, examples/component/composition.cpp, examples/component/custom_loop.cpp, examples/component/flexbox_gallery.cpp, examples/component/focus.cpp, examples/component/focus_cursor.cpp, examples/component/gallery.cpp, examples/component/homescreen.cpp, examples/component/input.cpp, examples/component/input_style.cpp, examples/component/linear_gradient_gallery.cpp, examples/component/maybe.cpp, examples/component/menu2.cpp, examples/component/menu_entries.cpp, examples/component/menu_entries_animated.cpp, examples/component/menu_multiple.cpp, examples/component/menu_style.cpp, examples/component/menu_underline_animated_gallery.cpp, examples/component/modal_dialog.cpp, examples/component/modal_dialog_custom.cpp, examples/component/nested_screen.cpp, examples/component/print_key_press.cpp, examples/component/renderer.cpp, examples/component/resizable_split.cpp, examples/component/slider_rgb.cpp, examples/component/textarea.cpp, examples/component/toggle.cpp, examples/component/window.cpp, examples/dom/border.cpp, examples/dom/border_colored.cpp, examples/dom/border_style.cpp, examples/dom/color_gallery.cpp, examples/dom/color_info_palette256.cpp, examples/dom/color_truecolor_HSV.cpp, examples/dom/color_truecolor_RGB.cpp, examples/dom/dbox.cpp, examples/dom/gauge.cpp, examples/dom/gauge_direction.cpp, examples/dom/gridbox.cpp, examples/dom/hflow.cpp, examples/dom/html_like.cpp, examples/dom/linear_gradient.cpp, examples/dom/package_manager.cpp, examples/dom/separator.cpp, examples/dom/separator_style.cpp, examples/dom/size.cpp, examples/dom/spinner.cpp, examples/dom/style_blink.cpp, examples/dom/style_bold.cpp, examples/dom/style_color.cpp, examples/dom/style_dim.cpp, examples/dom/style_gallery.cpp, examples/dom/style_hyperlink.cpp, examples/dom/style_inverted.cpp, examples/dom/style_strikethrough.cpp, examples/dom/style_underlined.cpp, examples/dom/style_underlined_double.cpp, examples/dom/vbox_hbox.cpp, and examples/dom/vflow.cpp.

Definition at line 120 of file text.cpp.

◆ vtext() [1/2]

Element vtext ( std::wstring text )

Display a piece unicode text vertically.

See also: ftxui::to_wstring

Example

Element document = vtext(L"Hello world!");

ftxui::vtext

Element vtext(std::wstring text)

Display a piece unicode text vertically.

Definition: text.cpp:180

Output

H
e
l
l
o
 
w
o
r
l
d
!

Examples: examples/dom/gauge_direction.cpp.

Definition at line 180 of file text.cpp.

◆ paragraph() [1/2]

Elements paragraph ( std::wstring text )

Examples: examples/component/homescreen.cpp, examples/component/with_restored_io.cpp, examples/dom/html_like.cpp, and examples/dom/paragraph.cpp.

◆ operator|() [3/5]

Element operator\|	(	Element	element,
		Decorator	decorator
	)

From an element, apply a decorator.

Returns: the decorated element.

Example

Both of these are equivalent:

bold(text("Hello"));

ftxui::bold

Element bold(Element)

Use a bold font, for elements with more emphasis.

Definition: bold.cpp:33

text("Hello") | bold;

Definition at line 72 of file util.cpp.

◆ operator|=() [3/3]

Element & operator\|=	(	Element &	e,
		Decorator	d
	)

Apply a decorator to an element.

Returns: the decorated element.

Example

Both of these are equivalent:

auto element = text("Hello");

element |= bold;

Definition at line 87 of file util.cpp.

◆ operator|() [4/5]

Elements operator\|	(	Elements	elements,
		Decorator	decorator
	)

From a set of element, apply a decorator to every elements.

Returns: the set of decorated element.

Definition at line 50 of file util.cpp.

◆ operator|() [5/5]

Decorator operator\|	(	Decorator	a,
		Decorator	b
	)

Compose two decorator into one.

Example

auto decorator = bold | blink;

ftxui::blink

Element blink(Element)

The text drawn alternates in between visible and hidden.

Definition: blink.cpp:33

Definition at line 42 of file util.cpp.

◆ text() [2/2]

Element text ( std::string text )

Display a piece of UTF8 encoded unicode text.

See also: ftxui::to_wstring

Example

Element document = text("Hello world!");

Output

Hello world!

Definition at line 101 of file text.cpp.

◆ vtext() [2/2]

Element vtext ( std::string text )

Display a piece of unicode text vertically.

See also: ftxui::to_wstring

Example

Element document = vtext("Hello world!");

Output

H
e
l
l
o
 
w
o
r
l
d
!

Definition at line 150 of file text.cpp.

◆ separator() [1/2]

Element separator ( )

Draw a vertical or horizontal separation in between two other elements.

See also: separator; separatorLight; separatorDashed; separatorDouble; separatorHeavy; separatorEmpty; separatorRounded; separatorStyled; separatorCharacter

Add a visual separation in between two elements.

Example

// Use 'border' as a function...
Element document = vbox({
  text("up"),
  separator(),
  text("down"),
});

Output

up
────
down

Examples: examples/component/button.cpp, examples/component/button_animated.cpp, examples/component/button_in_frame.cpp, examples/component/button_style.cpp, examples/component/canvas_animated.cpp, examples/component/composition.cpp, examples/component/custom_loop.cpp, examples/component/focus.cpp, examples/component/gallery.cpp, examples/component/homescreen.cpp, examples/component/input.cpp, examples/component/input_style.cpp, examples/component/menu2.cpp, examples/component/menu_entries.cpp, examples/component/menu_entries_animated.cpp, examples/component/menu_style.cpp, examples/component/modal_dialog.cpp, examples/component/modal_dialog_custom.cpp, examples/component/nested_screen.cpp, examples/component/slider_rgb.cpp, examples/component/tab_horizontal.cpp, examples/component/tab_vertical.cpp, examples/component/textarea.cpp, examples/dom/border_colored.cpp, examples/dom/color_gallery.cpp, examples/dom/gauge_direction.cpp, examples/dom/graph.cpp, examples/dom/package_manager.cpp, examples/dom/paragraph.cpp, examples/dom/separator.cpp, and examples/dom/spinner.cpp.

Definition at line 132 of file separator.cpp.

◆ separatorLight()

Element separatorLight ( )

Draw a vertical or horizontal separation in between two other elements, using the LIGHT style.

See also: separator; separatorLight; separatorDashed; separatorDouble; separatorHeavy; separatorEmpty; separatorRounded; separatorStyled; separatorCharacter

Add a visual separation in between two elements.

Example

// Use 'border' as a function...
Element document = vbox({
  text("up"),
  separatorLight(),
  text("down"),
});

Output

up
────
down

Examples: examples/dom/separator_style.cpp.

Definition at line 207 of file separator.cpp.

◆ separatorDashed()

Element separatorDashed ( )

Draw a vertical or horizontal separation in between two other elements, using the DASHED style.

See also: separator; separatorLight; separatorDashed; separatorDouble; separatorHeavy; separatorEmpty; separatorRounded; separatorStyled; separatorCharacter

Add a visual separation in between two elements.

Example

// Use 'border' as a function...
Element document = vbox({
  text("up"),
  separatorLight(),
  text("down"),
});

Output

up
╍╍╍╍
down

Examples: examples/dom/separator_style.cpp.

Definition at line 244 of file separator.cpp.

◆ separatorHeavy()

Element separatorHeavy ( )

Draw a vertical or horizontal separation in between two other elements, using the HEAVY style.

See also: separator; separatorLight; separatorDashed; separatorDouble; separatorHeavy; separatorEmpty; separatorRounded; separatorStyled; separatorCharacter

Add a visual separation in between two elements.

Example

// Use 'border' as a function...
Element document = vbox({
  text("up"),
  separatorHeavy(),
  text("down"),
});

Output

up
━━━━
down

Examples: examples/dom/separator_style.cpp.

Definition at line 281 of file separator.cpp.

◆ separatorDouble()

Element separatorDouble ( )

Draw a vertical or horizontal separation in between two other elements, using the DOUBLE style.

See also: separator; separatorLight; separatorDashed; separatorDouble; separatorHeavy; separatorEmpty; separatorRounded; separatorStyled; separatorCharacter

Add a visual separation in between two elements.

Example

// Use 'border' as a function...
Element document = vbox({
  text("up"),
  separatorDouble(),
  text("down"),
});

Output

up
════
down

Examples: examples/dom/separator_style.cpp.

Definition at line 318 of file separator.cpp.

◆ separatorEmpty()

Element separatorEmpty ( )

Draw a vertical or horizontal separation in between two other elements, using the EMPTY style.

See also: separator; separatorLight; separatorDashed; separatorDouble; separatorHeavy; separatorEmpty; separatorRounded; separatorStyled; separatorCharacter

Add a visual separation in between two elements.

Example

// Use 'border' as a function...
Element document = vbox({
  text("up"),
  separator(),
  text("down"),
});

Output

up
 
down

Examples: examples/component/input_style.cpp.

Definition at line 355 of file separator.cpp.

◆ separatorStyled()

Element separatorStyled ( BorderStyle style )

Draw a vertical or horizontal separation in between two other elements.

Parameters

style the style of the separator.

See also: separator; separatorLight; separatorDashed; separatorDouble; separatorHeavy; separatorEmpty; separatorRounded; separatorStyled; separatorCharacter

Add a visual separation in between two elements.

Example

// Use 'border' as a function...
Element document = vbox({
  text("up"),
  separatorStyled(DOUBLE),
  text("down"),
});

Output

up
════
down

Definition at line 170 of file separator.cpp.

◆ separator() [2/2]

Element separator ( Pixel pixel )

Draw a separator in between two element filled with a given pixel.

See also: separator; separatorLight; separatorDashed; separatorHeavy; separatorDouble; separatorStyled

Example

Pixel empty;
Element document = vbox({
  text("Up"),
  separator(empty),
  text("Down"),
})

Output

Up
 
Down

Definition at line 424 of file separator.cpp.

◆ separatorCharacter()

Element separatorCharacter ( std::string value )

Draw a vertical or horizontal separation in between two other elements.

Parameters

value the character to fill the separator area.

See also: separator; separatorLight; separatorDashed; separatorDouble; separatorHeavy; separatorEmpty; separatorRounded; separatorStyled; separatorCharacter

Add a visual separation in between two elements.

Example

// Use 'border' as a function...
Element document = vbox({
  text("up"),
  separator(),
  text("down"),
});

Output

up
────
down

Definition at line 393 of file separator.cpp.

◆ separatorHSelector()

Element separatorHSelector	(	float	left,
		float	right,
		Color	unselected_color,
		Color	selected_color
	)

Draw an horizontal bar, with the area in between left/right colored differently.

Parameters

left	the left limit of the active area.
right	the right limit of the active area.
selected_color	the color of the selected area.
unselected_color	the color of the unselected area.

Example

Element document = separatorHSelector(2,5, Color::White, Color::Blue);

ftxui::Color::White

@ White

Definition: color.hpp:66

ftxui::Color::Blue

@ Blue

Definition: color.hpp:55

ftxui::separatorHSelector

Element separatorHSelector(float left, float right, Color unselected_color, Color selected_color)

Draw an horizontal bar, with the area in between left/right colored differently.

Definition: separator.cpp:440

Definition at line 440 of file separator.cpp.

◆ separatorVSelector()

Element separatorVSelector	(	float	up,
		float	down,
		Color	unselected_color,
		Color	selected_color
	)

Draw an vertical bar, with the area in between up/downcolored differently.

Parameters

up	the left limit of the active area.
down	the right limit of the active area.
selected_color	the color of the selected area.
unselected_color	the color of the unselected area.

Example

Element document = separatorHSelector(2,5, Color::White, Color::Blue);

Definition at line 510 of file separator.cpp.

◆ gauge()

Element gauge ( float progress )

Draw a high definition progress bar.

Parameters

progress The proportion of the area to be filled. Belong to [0,1].

Example

A gauge. It can be used to represent a progress bar.

border(gauge(0.5))

ftxui::gauge

Element gauge(float progress)

Draw a high definition progress bar.

Definition: gauge.cpp:293

ftxui::border

Element border(Element)

Draw a border around the element.

Definition: border.cpp:227

Output

┌──────────────────────────────────────────────────────────────────────────┐
│█████████████████████████████████████                                     │
└──────────────────────────────────────────────────────────────────────────┘

Examples: examples/component/button_animated.cpp, examples/component/homescreen.cpp, examples/component/menu2.cpp, examples/dom/gauge.cpp, and examples/dom/package_manager.cpp.

Definition at line 293 of file gauge.cpp.

◆ gaugeLeft()

Element gaugeLeft ( float progress )

Draw a high definition progress bar progressing from right to left.

Parameters

progress The proportion of the area to be filled. Belong to [0,1].

Example

A gauge. It can be used to represent a progress bar.

border(gaugeLeft(0.5))

ftxui::gaugeLeft

Element gaugeLeft(float progress)

Draw a high definition progress bar progressing from right to left.

Definition: gauge.cpp:213

Output

┌──────────────────────────────────────────────────────────────────────────┐
│                                     █████████████████████████████████████│
└──────────────────────────────────────────────────────────────────────────┘

Examples: examples/dom/gauge_direction.cpp.

Definition at line 213 of file gauge.cpp.

◆ gaugeRight()

Element gaugeRight ( float progress )

Draw a high definition progress bar progressing from left to right.

Parameters

progress The proportion of the area to be filled. Belong to [0,1].

Example

A gauge. It can be used to represent a progress bar.

border(gaugeRight(0.5))

ftxui::gaugeRight

Element gaugeRight(float progress)

Draw a high definition progress bar progressing from left to right.

Definition: gauge.cpp:191

Output

┌──────────────────────────────────────────────────────────────────────────┐
│█████████████████████████████████████                                     │
└──────────────────────────────────────────────────────────────────────────┘

Examples: examples/dom/gauge_direction.cpp.

Definition at line 191 of file gauge.cpp.

◆ gaugeUp()

Element gaugeUp ( float progress )

Draw a high definition progress bar progressing from bottom to top.

Parameters

progress The proportion of the area to be filled. Belong to [0,1].

Example

A gauge. It can be used to represent a progress bar.

border(gaugeUp(0.5))

ftxui::gaugeUp

Element gaugeUp(float progress)

Draw a high definition progress bar progressing from bottom to top.

Definition: gauge.cpp:242

Output

┌─┐
│ │
│ │
│ │
│ │
│█│
│█│
│█│
│█│
└─┘

Examples: examples/dom/gauge_direction.cpp.

Definition at line 242 of file gauge.cpp.

◆ gaugeDown()

Element gaugeDown ( float progress )

Draw a high definition progress bar progressing from top to bottom.

Parameters

progress The proportion of the area to be filled. Belong to [0,1].

Example

A gauge. It can be used to represent a progress bar.

border(gaugeDown(0.5))

ftxui::gaugeDown

Element gaugeDown(float progress)

Draw a high definition progress bar progressing from top to bottom.

Definition: gauge.cpp:271

Output

┌─┐
│█│
│█│
│█│
│█│
│ │
│ │
│ │
│ │
└─┘

Examples: examples/dom/gauge_direction.cpp.

Definition at line 271 of file gauge.cpp.

◆ gaugeDirection()

Element gaugeDirection	(	float	progress,
		Direction	direction
	)

Draw a high definition progress bar progressing in specified direction.

Parameters

progress The proportion of the area to be filled. Belong to [0,1].

Definition at line 169 of file gauge.cpp.

◆ border()

Element border ( Element child )

Draw a border around the element.

See also: border; borderLight; borderDashed; borderDouble; borderHeavy; borderEmpty; borderRounded; borderStyled; borderWith

Add a border around an element

Example

// Use 'border' as a function...
Element document = border(text("The element"));
 
// ...Or as a 'pipe'.
Element document = text("The element") | border;

Output

┌───────────┐
│The element│
└───────────┘

Examples: examples/component/button.cpp, examples/component/button_animated.cpp, examples/component/button_in_frame.cpp, examples/component/button_style.cpp, examples/component/canvas_animated.cpp, examples/component/checkbox.cpp, examples/component/checkbox_in_frame.cpp, examples/component/composition.cpp, examples/component/custom_loop.cpp, examples/component/flexbox_gallery.cpp, examples/component/focus.cpp, examples/component/gallery.cpp, examples/component/homescreen.cpp, examples/component/input.cpp, examples/component/input_style.cpp, examples/component/maybe.cpp, examples/component/menu2.cpp, examples/component/menu_entries.cpp, examples/component/menu_entries_animated.cpp, examples/component/menu_in_frame.cpp, examples/component/menu_style.cpp, examples/component/modal_dialog.cpp, examples/component/modal_dialog_custom.cpp, examples/component/nested_screen.cpp, examples/component/radiobox_in_frame.cpp, examples/component/renderer.cpp, examples/component/resizable_split.cpp, examples/component/slider_rgb.cpp, examples/component/tab_horizontal.cpp, examples/component/tab_vertical.cpp, examples/component/textarea.cpp, examples/component/with_restored_io.cpp, examples/dom/border.cpp, examples/dom/canvas.cpp, examples/dom/color_gallery.cpp, examples/dom/dbox.cpp, examples/dom/gauge_direction.cpp, examples/dom/graph.cpp, examples/dom/gridbox.cpp, examples/dom/hflow.cpp, examples/dom/html_like.cpp, examples/dom/paragraph.cpp, examples/dom/separator.cpp, examples/dom/spinner.cpp, and examples/dom/vflow.cpp.

Definition at line 227 of file border.cpp.

◆ borderLight()

Element borderLight ( Element child )

Draw a dashed border around the element.

See also: border; borderLight; borderDashed; borderDouble; borderHeavy; borderRounded; borderEmpty; borderStyled; borderWith

Add a border around an element

Example

// Use 'borderLight' as a function...
Element document = borderLight(text("The element"));
 
// ...Or as a 'pipe'.
Element document = text("The element") | borderLight;

Output

┌──────────────┐
│The element   │
└──────────────┘

Examples: examples/dom/border_style.cpp, and examples/dom/separator_style.cpp.

Definition at line 335 of file border.cpp.

◆ borderDashed()

Element borderDashed ( Element child )

Draw a light border around the element.

See also: border; borderLight; borderDashed; borderDouble; borderHeavy; borderRounded; borderEmpty; borderStyled; borderWith

Add a border around an element

Example

// Use 'borderDash' as a function...
Element document = borderDash(text("The element"));
 
// ...Or as a 'pipe'.
Element document = text("The element") | borderDAsh;

Output

┏╍╍╍╍╍╍╍╍╍╍╍╍╍╍┓
╏The element   ╏
┗╍╍╍╍╍╍╍╍╍╍╍╍╍╍┛

Examples: examples/dom/border_style.cpp, and examples/dom/separator_style.cpp.

Definition at line 300 of file border.cpp.

◆ borderHeavy()

Element borderHeavy ( Element child )

Draw a heavy border around the element.

See also: border; borderLight; borderDashed; borderDouble; borderHeavy; borderRounded; borderEmpty; borderStyled; borderWith

Add a border around an element

Example

// Use 'borderHeavy' as a function...
Element document = borderHeavy(text("The element"));
 
// ...Or as a 'pipe'.
Element document = text("The element") | borderHeavy;

Output

┏━━━━━━━━━━━━━━┓
┃The element   ┃
┗━━━━━━━━━━━━━━┛

Examples: examples/dom/border_style.cpp, and examples/dom/separator_style.cpp.

Definition at line 370 of file border.cpp.

◆ borderDouble()

Element borderDouble ( Element child )

Draw a double border around the element.

See also: border; borderLight; borderDashed; borderDouble; borderHeavy; borderRounded; borderEmpty; borderStyled; borderWith

Add a border around an element

Example

// Use 'borderDouble' as a function...
Element document = borderDouble(text("The element"));
 
// ...Or as a 'pipe'.
Element document = text("The element") | borderDouble;

Output

╔══════════════╗
║The element   ║
╚══════════════╝

Examples: examples/component/input_style.cpp, examples/component/menu_style.cpp, examples/dom/border_style.cpp, and examples/dom/separator_style.cpp.

Definition at line 405 of file border.cpp.

◆ borderRounded()

Element borderRounded ( Element child )

Draw a rounded border around the element.

See also: border; borderLight; borderDashed; borderDouble; borderHeavy; borderRounded; borderEmpty; borderStyled; borderWith

Add a border around an element

Example

// Use 'borderRounded' as a function...
Element document = borderRounded(text("The element"));
 
// ...Or as a 'pipe'.
Element document = text("The element") | borderRounded;

Output

╭──────────────╮
│The element   │
╰──────────────╯

Examples: examples/component/input_style.cpp, and examples/dom/border_style.cpp.

Definition at line 440 of file border.cpp.

◆ borderEmpty()

Element borderEmpty ( Element child )

Draw an empty border around the element.

See also: border; borderLight; borderDashed; borderDouble; borderHeavy; borderRounded; borderEmpty; borderStyled; borderWith

Add a border around an element

Example

// Use 'borderRounded' as a function...
Element document = borderRounded(text("The element"));
 
// ...Or as a 'pipe'.
Element document = text("The element") | borderRounded;

Output

The element

Examples: examples/component/button.cpp, examples/component/input_style.cpp, examples/component/menu_underline_animated_gallery.cpp, and examples/component/with_restored_io.cpp.

Definition at line 475 of file border.cpp.

◆ borderStyled() [1/3]

Decorator borderStyled ( BorderStyle style )

Same as border but with different styles.

See also: border

Examples: examples/dom/border_colored.cpp.

Definition at line 243 of file border.cpp.

◆ borderStyled() [2/3]

Decorator borderStyled	(	BorderStyle	style,
		Color	foreground_color
	)

Same as border but with a foreground color and a different style.

See also: border

Definition at line 262 of file border.cpp.

◆ borderStyled() [3/3]

Decorator borderStyled ( Color foreground_color )

Same as border but with a foreground color.

See also: border

Definition at line 252 of file border.cpp.

◆ borderWith()

Decorator borderWith ( const Pixel & pixel )

Same as border but with a constant Pixel around the element.

See also: border

Definition at line 234 of file border.cpp.

◆ window()

Element window	(	Element	title,
		Element	content
	)

Draw window with a title and a border around the element.

Parameters

title	The title of the window.
content	The element to be wrapped.

See also: border

Example

Element document = window(text("Title"),
                          text("content")
                   );

Output

┌Title──┐
│content│
└───────┘

Examples: examples/component/flexbox_gallery.cpp, examples/component/homescreen.cpp, examples/component/menu_multiple.cpp, examples/component/print_key_press.cpp, examples/dom/color_truecolor_RGB.cpp, examples/dom/hflow.cpp, examples/dom/package_manager.cpp, examples/dom/size.cpp, and examples/dom/vflow.cpp.

Definition at line 500 of file border.cpp.

◆ spinner()

Element spinner	(	int	charset_index,
		size_t	image_index
	)

Useful to represent the effect of time and/or events. This display an ASCII art "video".

Parameters

charset_index	The type of "video".
image_index	The "frame" of the video. You need to increase this for every "step".

Examples: examples/component/homescreen.cpp, examples/dom/html_like.cpp, and examples/dom/spinner.cpp.

Definition at line 283 of file spinner.cpp.

◆ paragraph() [2/2]

Element paragraph ( const std::string & the_text )

Return an element drawing the paragraph on multiple lines.

See also: flexbox.

Definition at line 28 of file paragraph.cpp.

◆ paragraphAlignLeft()

Element paragraphAlignLeft ( const std::string & the_text )

Return an element drawing the paragraph on multiple lines, aligned on the left.

See also: flexbox.

Examples: examples/component/homescreen.cpp.

Definition at line 36 of file paragraph.cpp.

◆ paragraphAlignRight()

Element paragraphAlignRight ( const std::string & the_text )

Return an element drawing the paragraph on multiple lines, aligned on the right.

See also: flexbox.

Examples: examples/component/homescreen.cpp.

Definition at line 45 of file paragraph.cpp.

◆ paragraphAlignCenter()

Element paragraphAlignCenter ( const std::string & the_text )

Return an element drawing the paragraph on multiple lines, aligned on the center.

See also: flexbox.

Examples: examples/component/homescreen.cpp.

Definition at line 55 of file paragraph.cpp.

◆ paragraphAlignJustify()

Element paragraphAlignJustify ( const std::string & the_text )

Return an element drawing the paragraph on multiple lines, aligned using a justified alignment. the center.

See also: flexbox.

Examples: examples/component/homescreen.cpp.

Definition at line 66 of file paragraph.cpp.

◆ graph()

Element graph ( GraphFunction graph_function )

Draw a graph using a GraphFunction.

Parameters

graph_function the function to be called to get the data.

Examples: examples/component/homescreen.cpp, and examples/dom/graph.cpp.

Definition at line 71 of file graph.cpp.

◆ emptyElement()

Element emptyElement ( )

An element of size 0x0 drawing nothing.

Definition at line 135 of file util.cpp.

◆ canvas() [1/3]

Element canvas ( ConstRef< Canvas > canvas )

Produce an element from a Canvas, or a reference to a Canvas.

Examples: examples/component/canvas_animated.cpp, and examples/dom/canvas.cpp.

Definition at line 852 of file canvas.cpp.

◆ canvas() [2/3]

Element canvas	(	int	width,
		int	height,
		std::function< void(Canvas &)>	fn
	)

Produce an element drawing a canvas of requested size.

Parameters

width	the width of the canvas.
height	the height of the canvas.
fn	a function drawing the canvas.

Definition at line 869 of file canvas.cpp.

◆ canvas() [3/3]

Element canvas ( std::function< void(Canvas &)> fn )

Produce an element drawing a canvas.

Parameters

fn	a function drawing the canvas.

Definition at line 899 of file canvas.cpp.

◆ bold()

Element bold ( Element child )

Use a bold font, for elements with more emphasis.

Examples: examples/component/button.cpp, examples/component/flexbox_gallery.cpp, examples/component/homescreen.cpp, examples/component/menu2.cpp, examples/component/menu_entries.cpp, examples/component/menu_style.cpp, examples/component/modal_dialog_custom.cpp, examples/component/renderer.cpp, examples/dom/hflow.cpp, examples/dom/html_like.cpp, examples/dom/package_manager.cpp, examples/dom/size.cpp, examples/dom/spinner.cpp, examples/dom/style_bold.cpp, examples/dom/style_gallery.cpp, examples/dom/table.cpp, and examples/dom/vflow.cpp.

Definition at line 33 of file bold.cpp.

◆ dim()

Element dim ( Element child )

Use a light font, for elements with less emphasis.

Examples: examples/component/flexbox_gallery.cpp, examples/component/homescreen.cpp, examples/component/input_style.cpp, examples/component/menu_style.cpp, examples/dom/hflow.cpp, examples/dom/html_like.cpp, examples/dom/package_manager.cpp, examples/dom/size.cpp, examples/dom/style_dim.cpp, examples/dom/style_gallery.cpp, and examples/dom/vflow.cpp.

Definition at line 33 of file dim.cpp.

◆ inverted()

Element inverted ( Element child )

Add a filter that will invert the foreground and the background colors.

Examples: examples/component/menu_entries.cpp, examples/component/menu_underline_animated_gallery.cpp, examples/dom/graph.cpp, examples/dom/style_gallery.cpp, and examples/dom/style_inverted.cpp.

Definition at line 34 of file inverted.cpp.

◆ underlined()

Element underlined ( Element child )

Make the underlined element to be underlined.

Examples: examples/dom/html_like.cpp, examples/dom/style_gallery.cpp, and examples/dom/style_underlined.cpp.

Definition at line 33 of file underlined.cpp.

◆ underlinedDouble()

Element underlinedDouble ( Element child )

Apply a underlinedDouble to text.

Examples: examples/dom/style_gallery.cpp, and examples/dom/style_underlined_double.cpp.

Definition at line 17 of file underlined_double.cpp.

◆ blink()

Element blink ( Element child )

The text drawn alternates in between visible and hidden.

Examples: examples/dom/style_blink.cpp, and examples/dom/style_gallery.cpp.

Definition at line 33 of file blink.cpp.

◆ strikethrough()

Element strikethrough ( Element child )

Apply a strikethrough to text.

Examples: examples/dom/style_gallery.cpp, and examples/dom/style_strikethrough.cpp.

Definition at line 17 of file strikethrough.cpp.

◆ color() [1/4]

Decorator color ( Color c )

Decorate using a foreground color.

Parameters

c	The foreground color to be applied.

Returns: The Decorator applying the color.

Example

Element document = text("red") | color(Color::Red);

ftxui::Color::Red

@ Red

Definition: color.hpp:52

ftxui::color

Decorator color(Color)

Decorate using a foreground color.

Definition: color.cpp:110

Examples: examples/component/flexbox_gallery.cpp, examples/component/homescreen.cpp, examples/component/input_style.cpp, examples/component/maybe.cpp, examples/component/menu_entries.cpp, examples/component/menu_style.cpp, examples/component/renderer.cpp, examples/dom/border_colored.cpp, examples/dom/color_gallery.cpp, examples/dom/color_truecolor_HSV.cpp, examples/dom/graph.cpp, examples/dom/html_like.cpp, examples/dom/package_manager.cpp, examples/dom/style_color.cpp, examples/dom/style_gallery.cpp, and examples/dom/table.cpp.

Definition at line 110 of file color.cpp.

◆ bgcolor() [1/4]

Decorator bgcolor ( Color color )

Decorate using a background color.

Parameters

color The background color to be applied.

Returns: The Decorator applying the color.

Example

Element document = text("red") | bgcolor(Color::Red);

ftxui::bgcolor

Decorator bgcolor(Color)

Decorate using a background color.

Definition: color.cpp:124

Examples: examples/component/flexbox_gallery.cpp, examples/component/focus.cpp, examples/component/homescreen.cpp, examples/component/input_style.cpp, examples/component/linear_gradient_gallery.cpp, examples/component/menu_entries_animated.cpp, examples/component/menu_style.cpp, examples/component/slider_rgb.cpp, examples/dom/color_gallery.cpp, examples/dom/color_info_palette256.cpp, examples/dom/color_truecolor_HSV.cpp, examples/dom/color_truecolor_RGB.cpp, examples/dom/linear_gradient.cpp, examples/dom/style_color.cpp, and examples/dom/style_gallery.cpp.

Definition at line 124 of file color.cpp.

◆ color() [2/4]

Decorator color ( const LinearGradient & gradient )

Decorate using a linear-gradient effect on the foreground color.

Parameters

gradient The gradient effect to be applied on the output element.

Returns: The Decorator applying the color.

Example

text("Hello") | color(LinearGradient{0, {Color::Red, Color::Blue}})

ftxui::LinearGradient

A class representing the settings for linear-gradient color effect.

Definition: linear_gradient.hpp:30

Definition at line 278 of file linear_gradient.cpp.

◆ bgcolor() [2/4]

Decorator bgcolor ( const LinearGradient & gradient )

Decorate using a linear-gradient effect on the background color.

Parameters

gradient The gradient effect to be applied on the output element.

Returns: The Decorator applying the color.

Example

text("Hello") | color(LinearGradient{0, {Color::Red, Color::Blue}})

Definition at line 293 of file linear_gradient.cpp.

◆ color() [3/4]

Element color	(	Color	color,
		Element	child
	)

Set the foreground color of an element.

Parameters

color	The color of the output element.
child	The input element.

Returns: The output element colored.

Example

Element document = color(Color::Green, text("Success")),

ftxui::Color::Green

@ Green

Definition: color.hpp:53

Definition at line 81 of file color.cpp.

◆ bgcolor() [3/4]

Element bgcolor	(	Color	color,
		Element	child
	)

Set the background color of an element.

Parameters

color	The color of the output element.
child	The input element.

Returns: The output element colored.

Example

Element document = bgcolor(Color::Green, text("Success")),

Definition at line 96 of file color.cpp.

◆ color() [4/4]

Element color	(	const LinearGradient &	gradient,
		Element	child
	)

Set the foreground color of an element with linear-gradient effect.

Parameters

gradient	The gradient effect to be applied on the output element.
child	The input element.

Returns: The output element colored.

Example

color(LinearGradient{0, {Color::Red, Color::Blue}}, text("Hello"))

Definition at line 247 of file linear_gradient.cpp.

◆ bgcolor() [4/4]

Element bgcolor	(	const LinearGradient &	gradient,
		Element	child
	)

Set the background color of an element with linear-gradient effect.

Parameters

gradient	The gradient effect to be applied on the output element.
child	The input element.

Returns: The output element colored.

Example

bgcolor(LinearGradient{0, {Color::Red, Color::Blue}}, text("Hello"))

Definition at line 263 of file linear_gradient.cpp.

◆ focusPosition()

Decorator focusPosition	(	int	x,
		int	y
	)

Used inside a frame, this force the view to be scrolled toward a a given position. The position is expressed in the numbers of cells.

Example

Element document = huge_document()
  | focusPosition(10, 10)
  | frame;

Definition at line 70 of file focus.cpp.

◆ focusPositionRelative()

Decorator focusPositionRelative	(	float	x,
		float	y
	)

Used inside a frame, this force the view to be scrolled toward a a given position. The position is expressed in proportion of the requested size.

For instance:

(0, 0) means that the view is scrolled toward the upper left.
(1, 0) means that the view is scrolled toward the upper right.
(0, 1) means that the view is scrolled toward the bottom left.

Example

Element document = huge_document()
  | focusPositionRelative(0.f, 1.f)
  | frame;

Examples: examples/component/focus.cpp.

Definition at line 31 of file focus.cpp.

◆ automerge()

Element automerge ( Element child )

Enable character to be automatically merged with others nearby.

Definition at line 17 of file automerge.cpp.

◆ hyperlink() [1/2]

Decorator hyperlink ( std::string link )

Decorate using an hyperlink. The link will be opened when the user click on it. This is supported only on a limited set of terminal emulator. List: https://github.com/Alhadis/OSC8-Adoption/.

Parameters

link	The link to redirect the users to.

Returns: The Decorator applying the hyperlink.

Example

Element document =

text("red") | hyperlink("https://github.com/Arthursonzogni/FTXUI");

ftxui::hyperlink

Decorator hyperlink(std::string link)

Decorate using an hyperlink. The link will be opened when the user click on it. This is supported onl...

Definition: hyperlink.cpp:70

Examples: examples/dom/style_gallery.cpp, and examples/dom/style_hyperlink.cpp.

Definition at line 70 of file hyperlink.cpp.

◆ hyperlink() [2/2]

Element hyperlink	(	std::string	link,
		Element	child
	)

Make the rendered area clickable using a web browser. The link will be opened when the user click on it. This is supported only on a limited set of terminal emulator. List: https://github.com/Alhadis/OSC8-Adoption/.

Parameters

link	The link
child	The input element.

Returns: The output element with the link.

Example

Element document =

hyperlink("https://github.com/ArthurSonzogni/FTXUI", "link");

Definition at line 51 of file hyperlink.cpp.

◆ hbox()

Element hbox ( Elements children )

A container displaying elements horizontally one by one.

Parameters

children The elements in the container

Returns: The container.

Example

hbox({
  text("Left"),
  text("Right"),
});

Examples: examples/component/button_in_frame.cpp, examples/component/canvas_animated.cpp, examples/component/collapsible.cpp, examples/component/flexbox_gallery.cpp, examples/component/focus_cursor.cpp, examples/component/gallery.cpp, examples/component/homescreen.cpp, examples/component/input.cpp, examples/component/input_style.cpp, examples/component/menu2.cpp, examples/component/menu_entries.cpp, examples/component/menu_entries_animated.cpp, examples/component/menu_style.cpp, examples/component/modal_dialog_custom.cpp, examples/component/slider_rgb.cpp, examples/component/tab_vertical.cpp, examples/component/toggle.cpp, examples/component/with_restored_io.cpp, examples/dom/border.cpp, examples/dom/border_colored.cpp, examples/dom/color_gallery.cpp, examples/dom/color_info_palette256.cpp, examples/dom/color_truecolor_HSV.cpp, examples/dom/color_truecolor_RGB.cpp, examples/dom/gauge.cpp, examples/dom/gauge_direction.cpp, examples/dom/graph.cpp, examples/dom/package_manager.cpp, examples/dom/paragraph.cpp, examples/dom/separator.cpp, examples/dom/separator_style.cpp, examples/dom/size.cpp, examples/dom/spinner.cpp, examples/dom/style_blink.cpp, examples/dom/style_bold.cpp, examples/dom/style_color.cpp, examples/dom/style_dim.cpp, examples/dom/style_gallery.cpp, examples/dom/style_hyperlink.cpp, examples/dom/style_inverted.cpp, examples/dom/style_strikethrough.cpp, examples/dom/style_underlined.cpp, examples/dom/style_underlined_double.cpp, and examples/dom/vbox_hbox.cpp.

Definition at line 83 of file hbox.cpp.

◆ vbox()

Element vbox ( Elements children )

A container displaying elements vertically one by one.

Parameters

children The elements in the container

Returns: The container.

Example

vbox({
  text("Up"),
  text("Down"),
});

Examples: examples/component/button.cpp, examples/component/button_animated.cpp, examples/component/button_in_frame.cpp, examples/component/composition.cpp, examples/component/custom_loop.cpp, examples/component/flexbox_gallery.cpp, examples/component/focus.cpp, examples/component/gallery.cpp, examples/component/homescreen.cpp, examples/component/input.cpp, examples/component/input_style.cpp, examples/component/linear_gradient_gallery.cpp, examples/component/menu2.cpp, examples/component/menu_entries.cpp, examples/component/menu_entries_animated.cpp, examples/component/menu_multiple.cpp, examples/component/menu_style.cpp, examples/component/modal_dialog.cpp, examples/component/modal_dialog_custom.cpp, examples/component/nested_screen.cpp, examples/component/print_key_press.cpp, examples/component/slider_rgb.cpp, examples/component/tab_horizontal.cpp, examples/component/textarea.cpp, examples/component/toggle.cpp, examples/component/with_restored_io.cpp, examples/dom/border.cpp, examples/dom/border_colored.cpp, examples/dom/border_style.cpp, examples/dom/color_gallery.cpp, examples/dom/color_info_palette256.cpp, examples/dom/color_truecolor_HSV.cpp, examples/dom/color_truecolor_RGB.cpp, examples/dom/dbox.cpp, examples/dom/gauge_direction.cpp, examples/dom/graph.cpp, examples/dom/html_like.cpp, examples/dom/package_manager.cpp, examples/dom/paragraph.cpp, examples/dom/separator.cpp, examples/dom/separator_style.cpp, examples/dom/spinner.cpp, examples/dom/style_color.cpp, and examples/dom/vbox_hbox.cpp.

Definition at line 83 of file vbox.cpp.

◆ dbox()

Element dbox ( Elements children_ )

Stack several element on top of each other.

Parameters

children_ The input element.

Returns: The right aligned element.

Examples: examples/component/modal_dialog_custom.cpp, and examples/dom/dbox.cpp.

Definition at line 108 of file dbox.cpp.

◆ flexbox()

Element flexbox	(	Elements	,
		FlexboxConfig	config = `FlexboxConfig()`
	)

Examples: examples/component/flexbox_gallery.cpp, and examples/component/homescreen.cpp.

◆ gridbox()

Element gridbox ( std::vector< Elements > lines )

A container displaying a grid of elements.

Parameters

lines A list of lines, each line being a list of elements.

Returns: The container.

Example

auto cell = [](const char* t) { return text(t) | border; };
auto document = gridbox({
  {cell("north-west") , cell("north")  , cell("north-east")} ,
  {cell("west")       , cell("center") , cell("east")}       ,
  {cell("south-west") , cell("south")  , cell("south-east")} ,
});

Output:

╭──────────╮╭──────╮╭──────────╮
│north-west││north ││north-east│
╰──────────╯╰──────╯╰──────────╯
╭──────────╮╭──────╮╭──────────╮
│west      ││center││east      │
╰──────────╯╰──────╯╰──────────╯
╭──────────╮╭──────╮╭──────────╮
│south-west││south ││south-east│
╰──────────╯╰──────╯╰──────────╯

Examples: examples/component/focus.cpp, and examples/dom/gridbox.cpp.

Definition at line 183 of file gridbox.cpp.

◆ hflow()

Element hflow ( Elements )

Examples: examples/component/homescreen.cpp, examples/dom/hflow.cpp, examples/dom/html_like.cpp, and examples/dom/paragraph.cpp.

◆ vflow()

Element vflow ( Elements )

Examples: examples/dom/vflow.cpp.

◆ flex()

Element flex ( Element child )

Make a child element to expand proportionnally to the space left in a container.

Examples:

hbox({
  text("left") | border ,
  text("middle") | border | flex,
  text("right") | border,
});

Output:

┌────┐┌─────────────────────────────────────────────────────────┐┌─────┐
│left││middle                                                   ││right│
└────┘└─────────────────────────────────────────────────────────┘└─────┘

Examples: examples/component/button.cpp, examples/component/flexbox_gallery.cpp, examples/component/focus.cpp, examples/component/homescreen.cpp, examples/component/linear_gradient_gallery.cpp, examples/component/menu_multiple.cpp, examples/component/menu_style.cpp, examples/component/textarea.cpp, examples/dom/gauge.cpp, examples/dom/graph.cpp, and examples/dom/separator.cpp.

Definition at line 123 of file flex.cpp.

◆ flex_grow()

Element flex_grow ( Element child )

Expand if possible.

Examples: examples/component/homescreen.cpp.

Definition at line 141 of file flex.cpp.

◆ flex_shrink()

Element flex_shrink ( Element child )

Minimize if needed.

Definition at line 159 of file flex.cpp.

◆ xflex()

Element xflex ( Element child )

Expand/Minimize if possible/needed on the X axis.

Examples: examples/component/gallery.cpp, and examples/component/slider_rgb.cpp.

Definition at line 129 of file flex.cpp.

◆ xflex_grow()

Element xflex_grow ( Element child )

Expand if possible on the X axis.

Examples: examples/component/flexbox_gallery.cpp.

Definition at line 147 of file flex.cpp.

◆ xflex_shrink()

Element xflex_shrink ( Element child )

Minimize if needed on the X axis.

Definition at line 165 of file flex.cpp.

◆ yflex()

Element yflex ( Element child )

Expand/Minimize if possible/needed on the Y axis.

Definition at line 135 of file flex.cpp.

◆ yflex_grow()

Element yflex_grow ( Element child )

Expand if possible on the Y axis.

Examples: examples/component/flexbox_gallery.cpp.

Definition at line 153 of file flex.cpp.

◆ yflex_shrink()

Element yflex_shrink ( Element child )

Minimize if needed on the Y axis.

Definition at line 171 of file flex.cpp.

◆ notflex()

Element notflex ( Element child )

Make the element not flexible.

Examples: examples/component/flexbox_gallery.cpp.

Definition at line 177 of file flex.cpp.

◆ filler()

Element filler ( )

An element that will take expand proportionnally to the space left in a container.

Examples: examples/component/flexbox_gallery.cpp, examples/component/homescreen.cpp, examples/component/menu_style.cpp, examples/component/modal_dialog_custom.cpp, examples/component/with_restored_io.cpp, examples/dom/gauge_direction.cpp, examples/dom/package_manager.cpp, examples/dom/paragraph.cpp, examples/dom/spinner.cpp, examples/dom/style_color.cpp, and examples/dom/vbox_hbox.cpp.

Definition at line 98 of file flex.cpp.

◆ size()

Decorator size	(	WidthOrHeight	direction,
		Constraint	constraint,
		int	value
	)

Apply a constraint on the size of an element.

Parameters

direction	Whether the WIDTH of the HEIGHT of the element must be constrained.
constraint	The type of constaint.
value	The value.

Definition at line 90 of file size.cpp.

◆ frame()

Element frame ( Element child )

Allow an element to be displayed inside a 'virtual' area. It size can be larger than its container. In this case only a smaller portion is displayed. The view is scrollable to make the focused element visible.

See also: frame; xframe; yframe

Examples: examples/component/button_in_frame.cpp, examples/component/checkbox.cpp, examples/component/checkbox_in_frame.cpp, examples/component/focus.cpp, examples/component/homescreen.cpp, examples/component/menu_entries.cpp, examples/component/menu_entries_animated.cpp, examples/component/menu_in_frame.cpp, examples/component/menu_in_frame_horizontal.cpp, and examples/component/radiobox_in_frame.cpp.

Definition at line 167 of file frame.cpp.

◆ xframe()

Element xframe ( Element child )

Same as frame, but only on the x-axis.

See also: frame; xframe; yframe

Definition at line 175 of file frame.cpp.

◆ yframe()

Element yframe ( Element child )

Same as frame, but only on the y-axis.

See also: frame; xframe; yframe

Examples: examples/component/homescreen.cpp.

Definition at line 183 of file frame.cpp.

◆ focus()

Element focus ( Element child )

Set the child to be the one in focus globally.

Parameters

child The element to be focused.

Examples: examples/component/focus_cursor.cpp.

Definition at line 157 of file frame.cpp.

◆ select()

Element select ( Element child )

Set the child to be the one selected among its siblings.

Parameters

child The element to be selected.

Definition at line 150 of file frame.cpp.

◆ focusCursorBlock()

Element focusCursorBlock ( Element child )

Same as focus, but set the cursor shape to be a still block.

See also: focus; focusCursorBlock; focusCursorBlockBlinking; focusCursorBar; focusCursorBarBlinking; focusCursorUnderline; focusCursorUnderlineBlinking

Examples: examples/component/focus_cursor.cpp.

Definition at line 196 of file frame.cpp.

◆ focusCursorBlockBlinking()

Element focusCursorBlockBlinking ( Element child )

Same as focus, but set the cursor shape to be a blinking block.

See also: focus; focusCursorBlock; focusCursorBlockBlinking; focusCursorBar; focusCursorBarBlinking; focusCursorUnderline; focusCursorUnderlineBlinking

Examples: examples/component/focus_cursor.cpp.

Definition at line 210 of file frame.cpp.

◆ focusCursorBar()

Element focusCursorBar ( Element child )

Same as focus, but set the cursor shape to be a still block.

See also: focus; focusCursorBlock; focusCursorBlockBlinking; focusCursorBar; focusCursorBarBlinking; focusCursorUnderline; focusCursorUnderlineBlinking

Examples: examples/component/focus_cursor.cpp.

Definition at line 224 of file frame.cpp.

◆ focusCursorBarBlinking()

Element focusCursorBarBlinking ( Element child )

Same as focus, but set the cursor shape to be a blinking bar.

See also: focus; focusCursorBlock; focusCursorBlockBlinking; focusCursorBar; focusCursorBarBlinking; focusCursorUnderline; focusCursorUnderlineBlinking

Examples: examples/component/focus_cursor.cpp.

Definition at line 238 of file frame.cpp.

◆ focusCursorUnderline()

Element focusCursorUnderline ( Element child )

Same as focus, but set the cursor shape to be a still underline.

See also: focus; focusCursorBlock; focusCursorBlockBlinking; focusCursorBar; focusCursorBarBlinking; focusCursorUnderline; focusCursorUnderlineBlinking

Examples: examples/component/focus_cursor.cpp.

Definition at line 252 of file frame.cpp.

◆ focusCursorUnderlineBlinking()

Element focusCursorUnderlineBlinking ( Element child )

Same as focus, but set the cursor shape to be a blinking underline.

See also: focus; focusCursorBlock; focusCursorBlockBlinking; focusCursorBar; focusCursorBarBlinking; focusCursorUnderline; focusCursorUnderlineBlinking

Examples: examples/component/focus_cursor.cpp.

Definition at line 266 of file frame.cpp.

◆ vscroll_indicator()

Element vscroll_indicator ( Element child )

Display a vertical scrollbar to the right. colors.

Examples: examples/component/button_in_frame.cpp, examples/component/checkbox.cpp, examples/component/checkbox_in_frame.cpp, examples/component/homescreen.cpp, examples/component/menu_in_frame.cpp, and examples/component/radiobox_in_frame.cpp.

Definition at line 22 of file scroll_indicator.cpp.

◆ hscroll_indicator()

Element hscroll_indicator ( Element child )

Display an horizontal scrollbar to the bottom. colors.

Examples: examples/component/menu_in_frame_horizontal.cpp.

Definition at line 77 of file scroll_indicator.cpp.

◆ reflect()

Decorator reflect ( Box & box )

Definition at line 44 of file reflect.cpp.

◆ clear_under()

Element clear_under ( Element element )

Before drawing |child|, clear the pixels below. This is useful in.

See also: ftxui::dbox

Examples: examples/component/modal_dialog_custom.cpp.

Definition at line 37 of file clear_under.cpp.

◆ hcenter()

Element hcenter ( Element child )

Center an element horizontally.

Parameters

child The decorated element.

Returns: The centered element.

Examples: examples/component/flexbox_gallery.cpp, examples/component/homescreen.cpp, examples/component/menu2.cpp, examples/component/menu_style.cpp, examples/dom/hflow.cpp, examples/dom/size.cpp, and examples/dom/vflow.cpp.

Definition at line 15 of file composite_decorator.cpp.

◆ vcenter()

Element vcenter ( Element child )

Center an element vertically.

Parameters

child The decorated element.

Returns: The centered element.

Definition at line 23 of file composite_decorator.cpp.

◆ center()

Element center ( Element child )

Center an element horizontally and vertically.

Parameters

child The decorated element.

Returns: The centered element.

Examples: examples/component/button.cpp, examples/component/flexbox_gallery.cpp, examples/component/focus.cpp, examples/component/homescreen.cpp, examples/component/input_style.cpp, examples/component/linear_gradient_gallery.cpp, examples/component/modal_dialog.cpp, examples/component/modal_dialog_custom.cpp, examples/component/renderer.cpp, examples/component/resizable_split.cpp, examples/component/with_restored_io.cpp, examples/dom/dbox.cpp, examples/dom/gauge_direction.cpp, examples/dom/linear_gradient.cpp, and examples/dom/separator.cpp.

Definition at line 31 of file composite_decorator.cpp.

◆ align_right()

Element align_right ( Element child )

Align an element on the right side.

Parameters

child The decorated element.

Returns: The right aligned element.

Examples: examples/dom/table.cpp.

Definition at line 39 of file composite_decorator.cpp.

◆ nothing()

Element nothing ( Element element )

A decoration doing absolutely nothing.

Definition at line 30 of file util.cpp.

◆ Render() [1/2]

void Render	(	Screen &	screen,
		const Element &	element
	)

Display an element on a ftxui::Screen.

Examples: examples/dom/border.cpp, examples/dom/border_colored.cpp, examples/dom/border_style.cpp, examples/dom/canvas.cpp, examples/dom/color_gallery.cpp, examples/dom/color_info_palette256.cpp, examples/dom/color_truecolor_HSV.cpp, examples/dom/color_truecolor_RGB.cpp, examples/dom/dbox.cpp, examples/dom/gauge.cpp, examples/dom/gauge_direction.cpp, examples/dom/graph.cpp, examples/dom/gridbox.cpp, examples/dom/hflow.cpp, examples/dom/html_like.cpp, examples/dom/linear_gradient.cpp, examples/dom/package_manager.cpp, examples/dom/paragraph.cpp, examples/dom/separator.cpp, examples/dom/separator_style.cpp, examples/dom/size.cpp, examples/dom/spinner.cpp, examples/dom/style_blink.cpp, examples/dom/style_bold.cpp, examples/dom/style_color.cpp, examples/dom/style_dim.cpp, examples/dom/style_gallery.cpp, examples/dom/style_hyperlink.cpp, examples/dom/style_inverted.cpp, examples/dom/style_strikethrough.cpp, examples/dom/style_underlined.cpp, examples/dom/style_underlined_double.cpp, examples/dom/table.cpp, examples/dom/vbox_hbox.cpp, and examples/dom/vflow.cpp.

Definition at line 47 of file node.cpp.

◆ Render() [2/2]

void Render	(	Screen &	screen,
		Node *	node
	)

Display an element on a ftxui::Screen.

Definition at line 53 of file node.cpp.

◆ GetColorInfo() [1/2]

ColorInfo GetColorInfo ( Color::Palette256 index )

Definition at line 272 of file color_info.cpp.

◆ GetColorInfo() [2/2]

ColorInfo GetColorInfo ( Color::Palette16 index )

Definition at line 276 of file color_info.cpp.

◆ wchar_width()

int wchar_width ( wchar_t ucs )

Definition at line 1312 of file string.cpp.

◆ wstring_width()

int wstring_width ( const std::wstring & text )

Definition at line 1316 of file string.cpp.

◆ to_string()

std::string to_string ( const std::wstring & s )

Convert a UTF8 std::string into a std::wstring.

Examples: examples/component/button.cpp, examples/component/button_animated.cpp, examples/component/button_in_frame.cpp, examples/component/button_style.cpp, examples/component/checkbox.cpp, examples/component/checkbox_in_frame.cpp, examples/component/composition.cpp, examples/component/custom_loop.cpp, examples/component/flexbox_gallery.cpp, examples/component/focus.cpp, examples/component/homescreen.cpp, examples/component/linear_gradient_gallery.cpp, examples/component/menu2.cpp, examples/component/menu_entries.cpp, examples/component/menu_entries_animated.cpp, examples/component/menu_in_frame.cpp, examples/component/menu_in_frame_horizontal.cpp, examples/component/menu_multiple.cpp, examples/component/menu_underline_animated_gallery.cpp, examples/component/print_key_press.cpp, examples/component/radiobox_in_frame.cpp, examples/component/slider_rgb.cpp, examples/component/window.cpp, examples/dom/gauge.cpp, examples/dom/gauge_direction.cpp, examples/dom/hflow.cpp, examples/dom/package_manager.cpp, examples/dom/size.cpp, examples/dom/spinner.cpp, and examples/dom/vflow.cpp.

Definition at line 1565 of file string.cpp.

◆ to_wstring() [1/2]

std::wstring to_wstring ( const std::string & s )

Convert a std::wstring into a UTF8 std::string.

Definition at line 1637 of file string.cpp.

◆ to_wstring() [2/2]

std::wstring to_wstring ( T s )

Definition at line 17 of file string.hpp.

◆ string_width()

int string_width ( const std::string & input )

Definition at line 1329 of file string.cpp.

◆ Utf8ToGlyphs()

std::vector< std::string > Utf8ToGlyphs ( const std::string & input )

Definition at line 1356 of file string.cpp.

◆ CellToGlyphIndex()

std::vector< int > CellToGlyphIndex ( const std::string & input )

Definition at line 1464 of file string.cpp.

◆ CatchEvent() [3/3]

Component CatchEvent	(	Component	child,
		std::function< bool(Event event)>	on_event
	)

Return a component, using |on_event| to catch events. This function must returns true when the event has been handled, false otherwise.

Parameters

child	The wrapped component.
on_event	The function drawing the interface.

Example

auto screen = ScreenInteractive::TerminalOutput();
auto renderer = Renderer([] {
  return text("My interface");
});
auto component = CatchEvent(renderer, [&](Event event) {
  if (event == Event::Character('q')) {
    screen.ExitLoopClosure()();
    return true;
  }
  return false;
});
screen.Loop(component);

Definition at line 56 of file catch_event.cpp.

◆ Slider() [5/14]

template Component Slider ( SliderOption< int8_t > )

◆ Slider() [6/14]

template Component Slider ( SliderOption< int16_t > )

◆ Slider() [7/14]

template Component Slider ( SliderOption< int32_t > )

◆ Slider() [8/14]

template Component Slider ( SliderOption< int64_t > )

◆ Slider() [9/14]

template Component Slider ( SliderOption< uint8_t > )

◆ Slider() [10/14]

template Component Slider ( SliderOption< uint16_t > )

◆ Slider() [11/14]

template Component Slider ( SliderOption< uint32_t > )

◆ Slider() [12/14]

template Component Slider ( SliderOption< uint64_t > )

◆ Slider() [13/14]

template Component Slider ( SliderOption< float > )

◆ Slider() [14/14]

template Component Slider ( SliderOption< double > )

◆ EatCodePoint() [1/2]

bool EatCodePoint	(	const std::string &	input,
		size_t	start,
		size_t *	end,
		uint32_t *	ucs
	)

Definition at line 1173 of file string.cpp.

◆ EatCodePoint() [2/2]

bool EatCodePoint	(	const std::wstring &	input,
		size_t	start,
		size_t *	end,
		uint32_t *	ucs
	)

Definition at line 1243 of file string.cpp.

◆ IsCombining()

bool IsCombining ( uint32_t ucs )

Definition at line 1281 of file string.cpp.

◆ IsFullWidth()

bool IsFullWidth ( uint32_t ucs )

Definition at line 1285 of file string.cpp.

◆ IsControl()

bool IsControl ( uint32_t ucs )

Definition at line 1292 of file string.cpp.

◆ CodepointToWordBreakProperty()

WordBreakProperty CodepointToWordBreakProperty ( uint32_t codepoint )

Definition at line 1306 of file string.cpp.

◆ GlyphPrevious()

size_t GlyphPrevious	(	const std::string &	input,
		size_t	start
	)

Definition at line 1399 of file string.cpp.

◆ GlyphNext()

size_t GlyphNext	(	const std::string &	input,
		size_t	start
	)

Definition at line 1424 of file string.cpp.

◆ GlyphIterate()

size_t GlyphIterate	(	const std::string &	input,
		int	glyph_offset,
		size_t	start
	)

Definition at line 1450 of file string.cpp.

◆ GlyphCount()

int GlyphCount ( const std::string & input )

Definition at line 1505 of file string.cpp.

◆ Utf8ToWordBreakProperty()

std::vector< WordBreakProperty > Utf8ToWordBreakProperty ( const std::string & input )

Definition at line 1533 of file string.cpp.

◆ IsWordBreakingCharacter()

bool IsWordBreakingCharacter	(	const std::string &	input,
		size_t	glyph_index
	)

Variable Documentation

◆ g_uniformize

const std::map<std::string, std::string> g_uniformize

Definition at line 19 of file terminal_input_parser.cpp.

◆ palette256

const std::array<ColorInfo, 256> palette256

Definition at line 13 of file color_info.cpp.

Functions

Enumerations

Typedefs

Data Structures

Namespaces

Variables

Data Structure Documentation

◆ ftxui::AnimatedColorsOption

◆ ftxui::AnimationTask

◆ ftxui::ColorInfo

◆ ftxui::Dimensions

◆ ftxui::EntryState

◆ ftxui::InputState

◆ ftxui::MenuEntryOption

◆ ftxui::ResizableSplitOption

◆ ftxui::SliderOption

◆ ftxui::WindowOptions

◆ ftxui::WindowRenderState

Typedef Documentation

◆ CapturedMouse

◆ ComponentDecorator

◆ ElementDecorator

◆ Component

◆ Components

◆ Sender

◆ Receiver

◆ Closure

◆ Task

◆ Element

◆ Elements

◆ Decorator

◆ GraphFunction

Enumeration Type Documentation

◆ Direction

◆ BorderStyle

◆ WidthOrHeight

◆ Constraint

◆ WordBreakProperty

Function Documentation

◆ Make()

◆ operator|() [1/5]

◆ operator|() [2/5]

◆ operator|=() [1/3]

◆ operator|=() [2/3]

◆ Button() [1/2]

Example

Output

◆ Button() [2/2]

Example

Output

◆ Checkbox() [1/2]

◆ Checkbox() [2/2]

Example

Output

◆ Input() [1/3]

Example

Output

◆ Input() [2/3]

Example

Output

◆ Input() [3/3]

Example

Output

◆ Menu() [1/2]

Example

Output

◆ Menu() [2/2]

Example

Output

◆ MenuEntry() [1/2]

Example

Output

◆ MenuEntry() [2/2]

Example

Output

◆ Radiobox() [1/2]

Example

Output

◆ Radiobox() [2/2]

Example