Nodes List¶

List of all nodes included in the library.

Text¶

`functui.common.text`	A simple text node.
`functui.rich_text.adaptive_text`	A data node for text that can be wrapped and styled.
`functui.rich_text.rich_text`	A data node for text that can be styled.

Containers¶

`functui.common.vbox`	A container node that arranges its chilren verticaly.
`functui.common.hbox`	A container node that arranges its chilren Horizontaly.
`functui.common.static_box`	A container node that does not arrange its children in any way
`functui.flex.vbox_flex`	A container node that allows children to expand on the y axis.
`functui.flex.hbox_flex`	A container node that allows children to expand on the x axis.
`functui.flex.hbox_flex_wrap`	A container node that allows children to wrap vertically.

Interactive¶

`functui.nav.interaction_area`	A wrapper node that marks its child layout as interactive.
`functui.nav.v_scroll`	Allow vertical scrolling if child does not fit into available space.

See also

Keyboard and Mouse

Borders and Separators¶

`functui.common.vbar`	Vertical bar.
`functui.common.vbar_custom`	Vertical bar build with a custom character.
`functui.common.vbar_double`	A double vertical bar.
`functui.common.vbar_thick`	A thick vertical bar.
`functui.common.vbar_ascii`	An ascii vertical bar.
`functui.common.hbar`	Horizontal bar.
`functui.common.hbar_custom`	Horizonatal bar build with a custom character.
`functui.common.hbar_double`	A double horizontal bar.
`functui.common.hbar_thick`	A thick horizontal bar.
`functui.common.hbar_ascii`	An ascii horizontal bar.
`functui.common.border`	Puts a border around a layout.
`functui.common.border_with_title`	Border with a title attached on top.
`functui.common.border_rounded`	Puts a rounded border around a layout.
`functui.common.border_thick`	Puts a thick border around a layout.
`functui.common.border_double`	Puts a double border around a layout.
`functui.common.border_ascii`	Puts a border consisting of ascii characters around a layout.

Sizing and Constraints¶

`functui.common.shrink`	Shrink child layout to its minimum size
`functui.common.shrink_x`	Shrink child layout to its minimum size along the x axis
`functui.common.shrink_y`	Shrink child layout to its minimum size along the y axis
`functui.common.center`	Shrink and center child layout in remaining space.
`functui.common.center_x`	Shrink and center child layout along the x axis.
`functui.common.center_y`	Shrink and center child layout along the y axis.
`functui.common.custom_padding`	Add padding / Shrink a layout by differences
`functui.common.padding`	Add padding to left and right of a child layout.
`functui.common.clamp_width`	Limit width of a child layout.
`functui.common.clamp_height`	Limit height of a child layout.
`functui.common.min_width`	Set a minimum width.
`functui.common.min_height`	Set a minimum height.
`functui.flex.flex`	Wrap layout in a `Flex` class to mark it as flexible.
`functui.flex.flex_custom`	Wrap child layout in a `Flex` class to mark it as flexible and adjust attributes.

Styling¶

`functui.common.fg`	Style all descendants with specified foreground.
`functui.common.bg`	Style all descendants with specified background.
`functui.common.bg_char`	Fill background with char
`functui.common.bg_fill`	Fill background with whitespace.
`functui.common.styled`	Style a wrapper node with specified rule
`functui.common.bold`	Style all descendants as bold.
`functui.common.blink`	Style all descendants as blink.
`functui.common.underline`	Style all descendants as underlined.
`functui.common.strike_through`	Style all descendants as strike_through.
`functui.common.reverse`	Style all descendants as reverse.
`functui.common.italic`	Style all descendants as italic.

See also

Utility¶

`functui.common.combine`	Combines multiple wrapper nodes into one.
`functui.common.empty`	A dummy wrapper node for situation when a wrapper node is required but not needed.
`functui.common.nothing`	A dummy node for situations where a node is required but not needed.