Skip to content

Learn BrickflowUI

This learning guide is a practical curriculum for becoming productive with BrickflowUI.

It is not an API reference. It is a guided path that teaches the mental model, the common patterns, the sharp edges, and the way experienced users build real apps with the library.

The guide assumes you already know Python. It does not assume you know React, frontend build systems, WebSockets, Databricks Apps, or dashboard design.

What You Will Learn

By the end, you should be able to build:

  • a simple interactive app
  • a multi-section dashboard
  • a filtered table and chart experience
  • a pipeline observability portal
  • a chatbot-style assistant UI
  • a polished landing page
  • a Databricks-ready app package
  • a full capstone app that combines all of the above

Follow the chapters in order the first time:

  1. What Is BrickflowUI
  2. Install And Run
  3. Your First App
  4. Mental Model
  5. Layout Skills
  6. Components And Composition
  7. State And Events
  8. Inputs And User Actions
  9. Forms And API Routes
  10. Tables And Data Display
  11. Charts And Visualizations
  12. Pipeline Dashboards
  13. Chatbot And Assistant UI
  14. Theming And Branding
  15. Navigation And App Structure
  16. Databricks Apps Deployment
  17. Debugging And Reliability
  18. Production Checklist
  19. Capstone Project
  20. Glossary

How To Use This Guide

Each chapter has:

  • a learning goal
  • a practical explanation
  • copy-paste code
  • common mistakes
  • exercises
  • a checkpoint

Do not rush the exercises. BrickflowUI skill comes from understanding how state, events, data, layout, and visuals fit together.

The Big Idea

BrickflowUI lets you describe UI in Python:

return db.Column(
    [
        db.Text("Pipeline Health", variant="h1"),
        db.Button("Refresh", on_click=refresh),
    ]
)

The framework renders that Python component tree through a bundled frontend, listens for user events, calls your Python handlers, and sends UI updates back to the browser.

You write Python. BrickflowUI handles the browser runtime.