Skip to main content

Get started

Requirements​

Use a compiler and standard library with C++23 and std::expected, CMake 3.25 or later and Ninja. The build selects C++26 when the compiler supports it. Set CMAKE_CXX_STANDARD=23 to use the fallback explicitly. Native widgets also require Qt 6.8 or later with Widgets. The library builds with C++ and Qt alone.

Qt must be discoverable through CMake. With a separate Qt SDK, pass its installation directory through CMAKE_PREFIX_PATH. Keep that local path in your shell or CMakeUserPresets.json.

Run from the repository root:

cmake -S . -B build -G Ninja -DCMAKE_BUILD_TYPE=Release
cmake --build build
./build/shadcn_gallery

The gallery is a native Qt application. Build it with the compiler and Qt kit you use for your application.

Add the source to your application​

Place a reviewed source snapshot at third_party/shadcn-cpp. This avoids any network download during configuration.

cmake_minimum_required(VERSION 3.25)
project(course_viewer LANGUAGES CXX)
set(SHADCN_BUILD_TESTS OFF CACHE BOOL "" FORCE)
set(SHADCN_BUILD_EXAMPLES OFF CACHE BOOL "" FORCE)
add_subdirectory(third_party/shadcn-cpp)
add_executable(course_viewer main.cpp)
target_link_libraries(course_viewer PRIVATE shadcn::widgets)

The public widget API uses Qt types so that ordinary layouts, signals and application code work together. The component pages define the supported scope. Inherited Qt appearance options are not all implemented by the custom painters. This complete example creates a card and a button:

#include <shadcn/shadcn.hpp>
#include <QApplication>
#include <QVBoxLayout>

int main(int argc, char** argv) {
    QApplication app(argc, argv);
    shadcn::install(app);

    QWidget window;
    QVBoxLayout layout(&window);
    auto& card = shadcn::make_child<shadcn::Card>(window);
    card.setTitle("Modern C++");
    card.setDescription("Continue the current lesson.");
    layout.addWidget(&card);

    auto& button = shadcn::make_child<shadcn::Button>(card, "Continue lesson");
    button.setVariant(shadcn::Variant::Outline);
    card.content().addWidget(&button);
    QObject::connect(&button, &QPushButton::clicked, &window, [&window] {
        window.setWindowTitle("Lesson opened");
    });

    window.resize(540, 280);
    window.show();
    return app.exec();
}

make_child gives the parent ownership and returns a borrowed reference. Do not delete the reference or keep it after the parent has been destroyed. Use QPointer for a delayed observer. See ownership and safety.

Install a CMake package​

cmake --install build --prefix "$HOME/.local"

An application can then call find_package(shadcn 0.1.1 EXACT REQUIRED COMPONENTS widgets) and link shadcn::widgets. Its compiler, standard library and Qt kit must match the installed package. This snapshot does not publish binary packages or promise ABI compatibility.

To build the core without Qt:

cmake -S . -B build/core -G Ninja -DSHADCN_BUILD_WIDGETS=OFF
cmake --build build/core
cmake --install build/core --prefix "$HOME/.local"

That installation exposes shadcn::core without Qt. A package built with widgets includes the Qt dependency in its package configuration. The consumer example uses the installed core package.

Pin a development snapshot​

Use an exact repository commit with CMake FetchContent, or vendor that commit. Do not use a moving branch for a production build. The project version is 0.1.1. It names a release series, not an exact source, so pin a commit or a release tag rather than the version alone.