ftxui/5.0.0

C++ Functional Terminal User Interface.
ncursesscreenterminaltui
Recipe info
MIT
View recipe on GitHub
github.com/ArthurSonz...
2023-08-20
99cc82efeb91a0d9d60...
Available packages
Linux
Windows
macOS
macOS Apple Silicon
Install
Add the following line to your conanfile.txt:
[requires]
ftxui/5.0.0

Using ftxui

Note

If you are a new Conan user, we recommend reading the how to consume packages tutorial.

If you need additional assistance, please ask a question in the Conan Center Index repository.

Simplest use case consuming this recipe and assuming CMake as your local build tool:

[requires]
ftxui/5.0.0
[generators]
CMakeDeps
CMakeToolchain
[layout]
cmake_layout
from conan import ConanFile
from conan.tools.cmake import cmake_layout


class ExampleRecipe(ConanFile):
    settings = "os", "compiler", "build_type", "arch"
    generators = "CMakeDeps", "CMakeToolchain"

    def requirements(self):
        self.requires("ftxui/5.0.0")

    def layout(self):
        cmake_layout(self)

Now, you can run this Conan command to locally install (and build if necessary) this recipe and its dependencies (if any):

$ conan install conanfile.txt --build=missing

Useful information to take into account to consume this library:


These are the main declared targets:

  • CMake package name(s): ftxui
  • CMake target name(s): ftxui::ftxui 
    • ftxui-dom => ftxui::dom
ftxui-screen => ftxui::screen
ftxui-component => ftxui::component
  • pkg-config file name(s): ftxui.pc 
    • ftxui-dom => ftxui-ftxui-dom.pc
ftxui-screen => ftxui-ftxui-screen.pc
ftxui-component => ftxui-ftxui-component.pc

A simple use case using the CMake file name and the global target:

# ...
find_package(ftxui REQUIRED)
# ...
target_link_libraries(YOUR_TARGET ftxui::ftxui)

These are all the available headers. Some of these ones might be non-public; make sure of it by visiting the ftxui homepage listed above:

#include "ftxui/component/animation.hpp"
#include "ftxui/component/captured_mouse.hpp"
#include "ftxui/component/component.hpp"
#include "ftxui/component/component_base.hpp"
#include "ftxui/component/component_options.hpp"
#include "ftxui/component/event.hpp"
#include "ftxui/component/loop.hpp"
#include "ftxui/component/mouse.hpp"
#include "ftxui/component/receiver.hpp"
#include "ftxui/component/screen_interactive.hpp"
#include "ftxui/component/task.hpp"
#include "ftxui/dom/canvas.hpp"
#include "ftxui/dom/deprecated.hpp"
#include "ftxui/dom/direction.hpp"
#include "ftxui/dom/elements.hpp"
#include "ftxui/dom/flexbox_config.hpp"
#include "ftxui/dom/linear_gradient.hpp"
#include "ftxui/dom/node.hpp"
#include "ftxui/dom/requirement.hpp"
#include "ftxui/dom/table.hpp"
#include "ftxui/dom/take_any_args.hpp"
#include "ftxui/screen/box.hpp"
#include "ftxui/screen/color.hpp"
#include "ftxui/screen/color_info.hpp"
#include "ftxui/screen/deprecated.hpp"
#include "ftxui/screen/screen.hpp"
#include "ftxui/screen/string.hpp"
#include "ftxui/screen/terminal.hpp"
#include "ftxui/util/autoreset.hpp"
#include "ftxui/util/ref.hpp"