Conan

Table of Contents

• • Prerequisites
  • Configuration
  • Install Dependencies and Build
  • Without Conan Center

FTXUI can be easily obtained and integrated into your project using the Conan package manager.

Prerequisites

First, ensure that Conan is installed on your system. If not, you can install it via pip:

pip install conan

Conan often works in tandem with CMake, so you will need to have CMake installed as well. Once you have confirmed both Conan and CMake are installed, create a project directory, for example, ftxui-demo:

mkdir C:\ftxui-demo
cd C:\ftxui-demo

Configuration

After ensuring your environment is set up correctly, create a Conan configuration file conanfile.txt. This file is used to declare your project's dependencies. The FTXUI package can be found on Conan Center.

Each FTXUI release automatically opens a pull request against conan-center-index to publish the new version (see the conan job in .github/workflows/publish.yaml).

[requires]
ftxui/7.0.3
 
[generators]
CMakeDeps
CMakeToolchain
 
[layout]
cmake_layout

Install Dependencies and Build

Once configured, run the following command to install FTXUI and its dependencies:

conan install . --output-folder=build --build=missing

This will download and install ftxui/7.0.3 along with all its dependencies from Conan's remote repositories.

After the installation completes, you can test it by creating a demo.cpp file in your project directory:

#include <ftxui/screen/screen.hpp>
#include <ftxui/dom/elements.hpp>
#include <iostream>
 
int main() {
    using namespace ftxui;
    auto document = hbox({
        text(" Hello "),
        text("FTXUI ") | bold | color(Color::Red),
        text(" world! ")
    });
    auto screen = Screen::Create(Dimension::Full(), Dimension::Fit(document));
    Render(screen, document);
    std::cout << screen.ToString() << std::endl;
    return 0;
}

If the test is successful, you can then create a CMakeLists.txt file in the project directory:

cmake_minimum_required(VERSION 3.20)
project(ftxui-demo)
 
# Set the C++ standard
set(CMAKE_CXX_STANDARD 20)
 
# Find the FTXUI package installed via Conan
find_package(ftxui CONFIG REQUIRED)
 
# Create the executable
add_executable(demo demo.cpp)
 
# Link the executable to the FTXUI library
target_link_libraries(demo PRIVATE ftxui::component)

Without Conan Center

If Conan Center is unreachable (e.g. restricted network), build the package from a local checkout using the conanfile.py at the root of the repository:

git clone https://github.com/ArthurSonzogni/FTXUI
cd FTXUI
git checkout v7.0.3
conan create . --build=missing

This puts ftxui/7.0.3 in your local Conan cache, and the steps above work unchanged. Alternatively, skip Conan entirely and use CMake directly.

---

Previous
Getting Started