Skip to main content

CascadeUI - A Redux-Inspired Framework for Discord.py

Stars Sponsor Downloads PyPI discord.py 2.7+ Python 3.10-3.14 Discord Docs CI License: MIT

Build predictable, state-driven interfaces with discord.py.
A flexible, Redux-inspired UI framework that introduces centralized state, access control, lifecycle control, and predictable data flow to Discord applications.

CascadeUI Hero Demo

Read the Docs


Why CascadeUI

Interactive Discord UIs become difficult to manage as they grow. State accumulates across View subclass attributes, components stop responding after bot restarts, multi-step forms lose data between pages, and sharing data between views requires manual message.edit() plumbing in every callback.

CascadeUI introduces structure built on a Redux-inspired core:

  • Centralized state instead of scattered view attributes, so every view reads from a single source of truth and stays in sync automatically.
  • Predictable updates through dispatched actions, with one way to change state and one way to read it. No callback spaghetti.
  • Clear separation between logic and presentation. Reducers handle data, views render it, and neither knows about the other.
  • Reusable UI patterns instead of one-off implementations. Menus, pagination, forms, wizards, tabs, and persistent panels are first-class library primitives.
  • Built-in interaction control for ownership, instance limits, and navigation. Restrict who can click what, cap how many concurrent instances a user or guild can hold, and push, pop, or replace views without tracking message history by hand.
  • Persistence, undo/redo, and lifecycle handling without the boilerplate. Components survive bot restarts, state history is one method call away, and session cleanup happens automatically.

The pattern scales from simple panels to full application-style interfaces.


Architecture

CascadeUI follows a unidirectional data flow model:

User interaction -> dispatch(action)
  -> middleware
  -> reducer (state update)
  -> subscribers notified
  -> views re-render

All state lives in a single store. Actions describe what happened. Reducers define how state changes. Views subscribe to relevant state and update automatically.

Coming from Redux or React?

CascadeUI ports Redux's mental model onto Discord. Most core primitives have a closest analogue in frameworks you already know:

CascadeUI Closest Redux / React analogue
StateStore Redux store
@cascade_reducer Redux reducer
@computed Reselect / useMemo
build_ui() React component render()
on_state_changed componentDidUpdate + auto re-render
push() / pop() / replace() React Router navigation
Middleware chain applyMiddleware
PersistenceMiddleware redux-persist (opt-in per slot)

The table is the whole mapping; the analogues stop being useful where Discord's platform does not resemble a browser. Middleware is async, state outlives the process because Discord messages do, and the interaction model (a three-second acknowledgement wall, webhook tokens that expire at fifteen minutes, per-channel rate limits) has no React or Redux equivalent. Those are covered on their own terms in Core Concepts under Data Flow, State Topology, and Discord Interactions, rather than as a comparison.


When to Use

Every discord.py view requires access control, session cleanup, and interaction safety. CascadeUI handles all of that out of the box with class-level declarations - no boilerplate, no manual checks.

Even a single-view panel benefits from owner_only = True and instance_limit = 1. As your interface grows, the same framework scales to:

  • Shared state across multiple views via StateStore
  • Real data and message persistence via PersistenceMiddleware
  • Cross-view reactivity with dispatch() and subscribed_actions
  • Multi-step flows and validation via WizardLayoutView and FormLayoutView
  • Navigation stacks (push() / pop() / replace()), session policies, and participant_limit
  • Grid-based game boards with emoji_grid() and button_grid()

Getting Started

pip install pycascadeui

Optional dependencies:

pip install pycascadeui[sqlite]      # single-process persistence
pip install pycascadeui[postgres]    # multi-process persistence with LISTEN/NOTIFY

Requirements:

  • Python 3.10+
  • discord.py 2.7+

Hello World

A minimal CascadeUI view: per-user counter with ownership, instance replacement, and state-driven rebuilds - in about 20 lines.

import discord
from discord.ui import ActionRow
from cascadeui import StatefulButton, StatefulLayoutView, card

class CounterView(StatefulLayoutView):
    # Class-level policy -- ownership and instance control in three lines.
    owner_only = True              # Only the opener can click
    instance_limit = 1             # One live counter per user
    instance_policy = "replace"    # Second open replaces the first

    # Reactivity -- build_ui() re-runs whenever scoped state changes.
    subscribed_actions = {"SCOPED_UPDATE"}
    state_scope = "user"

    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        self.build_ui()  # First render: send() needs components to ship

    def build_ui(self):
        self.clear_items()
        count = self.scoped_state.get("count", 0)
        self.add_item(card(f"Count: **{count}**"))
        self.add_item(ActionRow(StatefulButton(
            label="+1",
            style=discord.ButtonStyle.primary,
            callback=self._increment,
        )))

    async def _increment(self, interaction):
        count = self.scoped_state.get("count", 0)
        await self.dispatch_scoped({"count": count + 1})

# In a cog command:
#   view = CounterView(context=ctx)
#   await view.send()

See the Quickstart for the detailed walkthrough and examples/v2_hello_world.py for the full runnable cog.


Feature Showcase

Cross-View Reactivity

Dispatch actions from any view and update all subscribers instantly across the interface.

# Any view can dispatch a named action.
await self.dispatch("SETTINGS_UPDATED", {"theme": "light"})

# Any other open view that subscribes wakes up automatically --
# no manual message.edit(), no cross-view wiring.
class NotificationPanel(StatefulLayoutView):
    subscribed_actions = {"SETTINGS_UPDATED"}
    # build_ui() re-runs whenever SETTINGS_UPDATED fires anywhere.

Cross-View


Dynamic Rendering

Define build_ui() once. The library calls it on every relevant state change and ships the edit for you. No on_state_changed() override, no manual refresh(), no message.edit() plumbing.

SHIP_COLORS = {
    "Carrier": "\U0001f7e5",
    "Battleship": "\U0001f7e7",
    "Cruiser": "\U0001f7e8",
    "Submarine": "\U0001f7e9",
    "Destroyer": "\U0001f7ea",
}

class MyFleetView(StatefulLayoutView):
    state_scope = "user"
    subscribed_actions = {"FLEET_REROLLED"}

    def __init__(self, **kwargs):
        super().__init__(**kwargs)
        self.build_ui()  # First render: send() needs components to ship

    def build_ui(self):
        self.clear_items()
        grid = emoji_grid(10, 10, fill="⬛", row_labels="alpha", col_labels="numeric")
        for ship, cells in self.ship_cells().items():
            grid[cells] = SHIP_COLORS[ship]
        legend = " • ".join(f"{color} **{ship}**" for ship, color in SHIP_COLORS.items())

        self.add_item(card(
            "## \U0001f6a2 My Fleet (Setup)",
            divider(),
            grid,
            divider(),
            legend,
            "Generate a new board layout, or close and hit **Ready**.",
            color=discord.Color.blue(),
        ))
        self.add_item(ActionRow(
            StatefulButton(label="Regenerate", emoji="\U0001f3b2",
                           style=discord.ButtonStyle.primary, callback=self._reroll),
            self.make_exit_button(label="Close"),
        ))

    async def _reroll(self, interaction):
        await self.dispatch("FLEET_REROLLED", {"cells": random_placement()})

# build_ui() runs automatically on every FLEET_REROLLED dispatch --
# no manual refresh() or on_state_changed() override needed.

Dynamic Rendering


Navigation and Flow

Push, pop, and replace views on a shared navigation stack. MenuLayoutView handles the wiring for category-based hubs -- declare your categories and target views, the pattern generates the push callbacks and action_section() items automatically.

from cascadeui import MenuLayoutView

class SettingsMenu(MenuLayoutView):
    instance_limit = 1
    instance_scope = "user_guild"
    instance_policy = "replace"

    def __init__(self, *args, **kwargs):
        categories = [
            {"label": "Appearance", "emoji": "\N{ARTIST PALETTE}",
             "description": "Customize theme and accent colors", "view": AppearanceView},
            {"label": "Notifications", "emoji": "\N{BELL}",
             "description": "Configure DM, mention, and event alerts", "view": NotificationsView},
            {"label": "Locale", "emoji": "\N{GLOBE WITH MERIDIANS}",
             "description": "Set language and timezone preferences", "view": LocaleView},
            {"label": "Server", "emoji": "\N{HOUSE BUILDING}",
             "description": "Per-server display and layout options", "view": GuildPrefsView},
        ]
        super().__init__(*args, categories=categories, **kwargs)

Navigation


Ownership Control

Views are owner-only by default - only the user who opened it can interact. For multi-user scenarios, allowed_users and participant_limit extend that control.

class BattleshipView(StatefulLayoutView):
    unauthorized_message = "You're not part of this game."
    instance_limit = 1
    instance_policy = "reject"
    participant_limit = 2
    auto_register_participants = True

    def __init__(self, *args, opponent_id: int, **kwargs):
        super().__init__(*args, **kwargs)
        self.allowed_users = {self.user_id, opponent_id}

Ownership Control


Lifecycle Control

Cap active sessions per user, guild, or globally. Pick how a collision resolves and how the old view cleans up when a new one opens.

class SettingsHubView(MenuLayoutView):
    instance_limit = 1               # Only one open at a time
    instance_scope = "user_guild"    # Per user per guild
    instance_policy = "replace"      # Exit the old one, open the new one
    exit_policy = "disable"          # Old view's buttons grey out, message stays

V2 Instance Limiting


Persistence and Continuity

Persist views and state across restarts with automatic restoration.

from cascadeui import PersistenceMiddleware, SQLiteBackend, setup_middleware

# Install PersistenceMiddleware once in your bot's setup_hook:
async def setup_hook(self):
    await setup_middleware(
        PersistenceMiddleware(backend=SQLiteBackend("cascadeui.db"), bot=self),
    )

Subclass PersistentRolesLayoutView and declare your categories. The pattern handles button rendering, cardinality enforcement, and restart re-attachment. A stable persistence_key is the match identity the middleware uses to find this panel after restart:

class GuildRoles(PersistentRolesLayoutView):
    categories = [
        RoleCategory(
            name="Color Roles", color=discord.Color.red(), exclusive=True,
            roles={"Red": 101, "Blue": 102, "Green": 103, "Purple": 104},
        ),
        RoleCategory(
            name="Gaming Roles", color=discord.Color.dark_teal(),
            roles={"Minecraft": 201, "Valorant": 202, "League": 203},
        ),
        RoleCategory(
            name="Pronoun Roles", color=discord.Color.blurple(), exclusive=True,
            roles={"He/Him": 301, "She/Her": 302, "They/Them": 303, "Neopronoun/Other": 304},
        ),
    ]

# Same key in, same panel out -- across bot restarts.
panel = GuildRoles(context=ctx, persistence_key=f"roles:{ctx.guild.id}")
await panel.send()

Persistence


State History (Undo/Redo)

Snapshot-based state history per session with built-in undo and redo support.

class NotificationsView(StatefulLayoutView):
    enable_undo = True   # Every dispatch captures a snapshot
    undo_limit = 10      # Stack depth cap (self.undo_depth / self.redo_depth read live)

    async def _undo(self, interaction):
        await self.undo()   # Restore previous snapshot

    async def _redo(self, interaction):
        await self.redo()   # Reapply the reverted snapshot

Undo/Redo


Ephemeral Refresh

Discord ephemeral messages become uneditable after 15 minutes. CascadeUI handles the token handoff automatically.

class FleetView(StatefulLayoutView):
    timeout = 3600                       # Handoff auto-engages for timeout > 900s
    refresh_button_label = "Refresh"     # Default: "Continue Session"

Ephemeral Refresh


Inline Disclosure

Collapsible hides a region behind a trigger that relabels itself. The host owns the revealed content and when to collapse it, so two per view stay independent.

from cascadeui import Collapsible, card, key_value

self.details = Collapsible(
    label="Show Details",
    expanded_label="Hide Details",
    summary=lambda: "**Match 14** - Gold Tier",
    reveal=lambda: [card(key_value({"Score": "12 - 9", "Duration": "24m", "MVP": "@player"}))],
    key="match_14",
)

def build_ui(self):
    self.clear_items()
    for item in self.details.render(self):
        self.add_item(item)

Collapsible


Developer Tools

Inspect live state, session activity, and performance timings without leaving your Discord client.

from cascadeui import DevToolsCog

# In your bot's setup_hook:
await bot.add_cog(DevToolsCog(bot))

DevTools


View Patterns

Category Menu

Category-based navigation hubs with automatic drill-down, themed cards, and declarative per-category styling.

from cascadeui import MenuLayoutView, card, divider, get_theme, key_value

class SettingsMenu(MenuLayoutView):
    # categories=[...] as in Navigation and Flow above.
    auto_exit_button = False  # Exit sits beside Reset All in build_footer()

    def get_theme(self):
        # The theme the user picked restyles every card on the next render.
        return get_theme(self.settings["theme"]) or super().get_theme()

    def build_header(self):
        s, on = self.settings, self.check_or_cross
        return [card(
            "## \N{GEAR}\N{VARIATION SELECTOR-16} Server Settings",
            divider(),
            key_value({
                "\N{ARTIST PALETTE} Theme": s["theme"].title(),
                "\N{BELL} Notifications": (
                    f"DMs {on(s['dm'])}  Mentions {on(s['mentions'])}  Events {on(s['events'])}"
                ),
                "\N{GLOBE WITH MERIDIANS} Locale": f"{s['language']} / {s['timezone']}",
                "\N{HOUSE BUILDING} Server": (
                    f"Nickname {on(s['nickname'])}  Events {on(s['highlight'])}"
                    f"  Compact {on(s['compact'])}"
                ),
            }),
        )]

    # build_footer() adds the session note, Reset All, and Exit.

Category Menu


Tabbed Dashboard

Structured, multi-section interfaces with tab-based navigation and composable layouts. Each tab is an async builder returning that panel's components; the pattern owns the button row, the active-tab styling, and the swap.

from cascadeui import TabLayoutView, action_section, card, divider, gap, key_value

class DashboardView(TabLayoutView):
    instance_limit = 1
    instance_scope = "user_guild"
    instance_policy = "replace"
    active_tab_style = discord.ButtonStyle.success  # The open tab renders green

    def __init__(self, *args, **kwargs):
        tabs = {
            "\N{BAR CHART} Overview": self.build_overview,
            "\N{JIGSAW PUZZLE PIECE} Modules": self.build_modules,
            "\N{GEAR}\N{VARIATION SELECTOR-16} Controls": self.build_controls,
            "\N{INFORMATION SOURCE}\N{VARIATION SELECTOR-16} About": self.build_about,
        }
        super().__init__(*args, tabs=tabs, **kwargs)

    async def build_overview(self):
        guild = self.context.guild
        stats = card(
            f"## {guild.name}",
            action_section(f"**Members:** {guild.member_count}",
                           label="Refresh", emoji="\U0001f504",
                           callback=self._refresh_overview),
            divider(),
            key_value(await self._server_stats()),
            color=discord.Color.green(),
        )
        actions = card(
            "## Quick Actions",
            action_section("View and manage active bot modules",
                           label="Modules", style=discord.ButtonStyle.primary,
                           callback=self._go_to_modules),
            color=discord.Color.blurple(),
        )
        return [stats, gap(), actions, self.make_nav_row(back=False, exit_label="Close")]

Dashboard


Dynamic Pagination

Generate paginated interfaces from raw data with built-in navigation and formatting helpers.

import discord
from cascadeui import PaginatedLayoutView, card, divider

RARITY_COLORS = {
    "Common": discord.Color.light_grey(),
    "Uncommon": discord.Color.green(),
    "Rare": discord.Color.blue(),
    "Legendary": discord.Color.gold(),
}

class InventoryView(PaginatedLayoutView):
    auto_exit_button = True  # Exit below the page buttons, kept through every turn

def format_page(items):
    lines = [f"**{item['name']}** ` {item['rarity']} ` - {item['value']}g" for item in items]
    total = sum(item["value"] for item in items)
    return [card(
        "## Inventory",
        "\n".join(lines),
        divider(),
        f"-# {len(items)} items | Page value: {total:,}g",
        # The list is sorted by rarity, so the last item is the rarest on the page.
        color=RARITY_COLORS[items[-1]["rarity"]],
    )]

view = await InventoryView.from_data(
    items=all_items,
    per_page=4,
    formatter=format_page,
    context=ctx,
)
await view.send()

Pagination


Sectional Pagination

PaginatedRegion pages one slice of a view while the host owns the rest. Give two regions distinct keys and they page independently in the same message.

from cascadeui import PaginatedRegion, card, divider, key_value

self.region = PaginatedRegion(items=standings, per_page=5, key="standings")

def build_ui(self):
    self.clear_items()
    # The view owns the header and footer; they stay put on every page.
    self.add_item(card(
        "## Season 4 Standings",
        key_value({"Region": "EU West", "Bracket": "Ranked", "Updated": "2m ago"}),
    ))
    start = self.region.page * 5 + 1
    rows = "\n".join(
        f"**{start + i}.** {name} • {mmr} MMR • {record}"
        for i, (name, mmr, record) in enumerate(self.region.page_items)
    )
    # The page buttons sit inside the card they page.
    self.add_item(card(
        f"### Ranks {start}\N{EN DASH}{start + 4}", rows, divider(), *self.region.controls(self),
    ))
    self.add_item(card("-# Header and footer belong to the view. Only the middle card pages."))
    self.add_item(self.make_nav_row(back=False, exit_label="Close"))

Paginated Region


Leaderboards

Paginated ranked displays with cross-page numbering, optional page-frame hooks (build_header / build_footer) for aggregate stats, and a persistent variant for admin-posted panels that refresh on live data without a bot restart.

from discord.ui import TextDisplay
from cascadeui import (
    LeaderboardLayoutView, PersistentLeaderboardLayoutView,
    action_section, card, divider, image_section, key_value, render_progress,
)

class ServerLeaderboard(LeaderboardLayoutView):
    leaderboard_top_n = 25
    leaderboard_per_page = 5
    jump_threshold = 6  # Five pages show prev / next only, no first / last
    entry_layout = "sections"  # Two-line rows, each with an avatar beside it
    bars = True

    def format_secondary(self, rank, user_id, stats):
        line = f"`{stats['mmr']}` MMR • {stats['wins']}W / {stats['games']}G"
        if self.bars:
            line += f" • {render_progress(stats['wins'], stats['games'] or 1, width=6)}"
        return line

    def build_header(self, page):
        # An Overview card above the rankings, on every page.
        entries = self.ranked_entries
        icon = self.context.guild.icon  # The guild icon rides beside the heading
        return card(
            image_section("## Overview", url=icon.url) if icon else "## Overview",
            divider(),
            key_value({
                "Ranked players": str(len(entries)),
                "Games played": str(sum(s["games"] for _, s in entries)),
                "Average MMR": str(sum(s["mmr"] for _, s in entries) // len(entries) if entries else 0),
            }),
            action_section(f"Win-rate bars: {'on' if self.bars else 'off'}",
                           label="Toggle bars", callback=self._toggle_bars),
        )

    def build_footer(self, page):
        return TextDisplay("-# Rankings sorted by MMR")  # Folds inside the rankings card

    async def _toggle_bars(self, interaction):
        self.bars = not self.bars
        await self.reload(force=True)  # Same entries, new rows: rebuild anyway


view = ServerLeaderboard(
    context=ctx,
    entries=entries,  # [(user_id, {"mmr": ..., "wins": ..., "games": ...}), ...]
    title=f"Leaderboard - {ctx.guild.name}",
    subtitle=None,
    bot=ctx.bot,  # Avatars resolve from the bot's user cache
)
await view.send(ephemeral=True)


# Persistent variant -- admin-posted panel that survives bot restarts
# and re-fetches live data on every restore.
class PersistentBoard(PersistentLeaderboardLayoutView):
    pass

panel = PersistentBoard(
    context=ctx,
    persistence_key=f"leaderboard:{ctx.guild.id}",
)
await panel.send()

Leaderboards

The recording comes from examples/v2_leaderboard.py, which adds a Mode row naming its demo data.


Forms and Validation

Define structured input flows with declarative fields, native text inputs, and per-field validation.

from cascadeui import FormField, FormLayoutView, min_length, regex

class RegistrationForm(FormLayoutView):
    instance_limit = 1
    instance_policy = "reject"
    exit_policy = "delete"

    def __init__(self, *args, **kwargs):
        # Each group renders as its own card; text fields share one Edit Fields modal.
        fields = [
            FormField(id="username", label="Username", required=True, group="Account",
                      placeholder="3-20 chars, alphanumeric + underscores",
                      min_length=3, max_length=20,
                      validators=[min_length(3),
                                  regex(r"^[a-zA-Z0-9_]+$", "Alphanumeric and underscores only")]),
            FormField(id="email", label="Email", required=True, group="Account",
                      placeholder="you@example.com"),
            FormField(id="password", label="Password", required=True, group="Account",
                      placeholder="8+ chars, letters and digits", min_length=8, secret=True),
            FormField(id="age", label="Age", type="integer", required=True, group="Profile",
                      placeholder="13-120", min_value=13, max_value=120),
            FormField(id="bio", label="Bio", group="Profile",
                      placeholder="Tell us about yourself (optional)",
                      style=discord.TextStyle.paragraph),
            FormField(id="country", label="Country", type="select", required=True,
                      group="Location", placeholder="Select your country...",
                      options=[{"label": "United States", "value": "us"},
                               {"label": "Japan", "value": "jp"}]),
        ]
        super().__init__(*args, title="Registration Form", fields=fields, **kwargs)

    async def on_submit(self, interaction, values):
        await self.respond(
            interaction, f"Welcome, {values['username']}!", ephemeral=True,
        )
        await self.exit()

Forms


Multi-Step Wizard

Multi-step flows with back/next/finish navigation, per-step builders and validators, and fully customizable button styling.

from cascadeui import WizardLayoutView

class CharacterCreator(WizardLayoutView):
    instance_limit = 1
    instance_policy = "reject"
    exit_policy = "delete"
    show_progress_bar = True

    back_button_label = "Previous"
    back_button_emoji = "⬅️"
    next_button_label = "Continue"
    next_button_emoji = "➡️"
    next_button_style = discord.ButtonStyle.primary
    finish_button_label = "Create Character"
    finish_button_emoji = "\U0001f3b2"
    finish_button_style = discord.ButtonStyle.success

    def __init__(self, *args, **kwargs):
        steps = [
            {"name": "Identity",   "builder": self.build_identity, "validator": self.check_identity},
            {"name": "Class",      "builder": self.build_class, "validator": self.check_class},
            {"name": "Abilities",  "builder": self.build_abilities},
            {"name": "Background", "builder": self.build_background},
            # Shown only when Background turns on Heroic Destiny; the step count adjusts.
            {"name": "Destiny",    "builder": self.build_destiny,
             "condition": lambda v: v.heroic_destiny},
            {"name": "Review",     "builder": self.build_review},
        ]
        super().__init__(*args, steps=steps, **kwargs)

Wizard


Emoji Grid

Text-rendered grids with optional axis labels and a mutation API. Plugs directly into card() and Container.

from cascadeui import emoji_grid, card

grid = emoji_grid(3, 8, fill="\u2b1b", col_labels="numeric")
grid.fill_rect((1, 0), (1, 7), "\U0001f7e6")  # A stripe across the middle row

view.add_item(card(grid))

Button Grid

Interactive cell grids packed into ActionRow components. Discord's 5x5 limit is enforced automatically.

from cascadeui import button_grid, StatefulButton

rows = button_grid(5, 5, lambda r, c: StatefulButton(
    label=f"{chr(65 + r)}{c + 1}",
    style=discord.ButtonStyle.secondary,
    callback=on_cell_click,
))
for row in rows:
    view.add_item(row)
Emoji Grid Button Grid

Both images come from one gallery of eight grids. The emoji grid above is its second panel and the button grid its last.


Features

For full details, see the official documentation.

State

  • Centralized store with dispatch and reducer cycle
  • Custom reducers via @cascade_reducer with automatic deep copy and collision guards
  • Action batching with nested-batch collapse and a single notification per commit
  • @computed values with selector-based cache invalidation (≈ Reselect / useMemo)
  • Selector-based subscriptions for targeted re-renders
  • Scoped state family: get_scoped(), set_scoped(), merge_scoped(), iter_scoped()
  • Slot helpers: access_slot(), read_slot(), slot_property
  • Middleware pipeline for logging, persistence, and transformation (Redux-style, async)
  • Event hooks for lifecycle observation
  • Cross-view reactivity: dispatch from any view, all subscribers update instantly

Views

  • V2 layout-based system for structured, container-driven interfaces
  • Full support for traditional discord.py Views (V1)
  • Pre-built patterns: menus, tabs, wizards, forms, pagination, leaderboards, roles
  • PaginatedView.from_cursor() for lazy cursor-driven pagination with LRU page cache
  • DisplayLayoutView for one-shot V2 sends from a pre-built container
  • Automatic state-driven rebuilds: define build_ui(), the library handles the edit (≈ React render())
  • refresh_cooldown_ms to pace library-initiated re-renders, with always-on reactive 429 backoff that retries at the window boundary
  • Theming with per-view overrides and a ContextVar that propagates through builders (≈ React.Context)

Components

  • Stateful buttons, selects, and modals with state integration
  • Modal inputs beyond text: Checkbox, CheckboxGroup, RadioGroup, FileUpload, sharing one validator + custom_id contract with TextInput
  • Select callbacks can opt into a values second parameter
  • V2 builders: card(), stats_card(), action_section(), toggle_section(), image_section(), link_section(), confirm_section(), button_row(), cycle_button(), toggle_button(), tab_nav(), choice_row(), key_value(), alert(), progress_bar(), divider(), gap(), gallery(), file_attachment()
  • V2 stateful composites: PaginatedRegion (per-section pager), Collapsible (inline disclosure)
  • Grid helpers: emoji_grid() and button_grid()
  • Typed modal fields (text, integer, float, date) with per-field validation
  • Declarative FormSchema and WizardSchema base classes
  • Component wrappers: loading states, confirmation dialogs, cooldowns

Interaction Control

  • Owner-only views by default; allowed_users opens access to specific users
  • Instance limits per user, guild, user+guild, or globally with replace or reject policies
  • participant_limit with on_participant_limit hook and auto_register_participants
  • check_instance_available() for fail-fast pre-checks before constructing expensive views
  • Auto-defer with respond(), open_modal(), and safe_defer() helpers
  • Interaction serialization so rapid clicks process sequentially
  • with_cooldown() to rate-limit one control per clicker, surviving the component being rebuilt
  • edit_timeout ceiling that cancels stalled Discord edits before they pin a view
  • Silent snowflake coercion at every public boundary
  • Class-attribute validation at subclass-definition time

Navigation and Lifecycle

  • Navigation stack: push(), pop(), replace() on one shared message (≈ React Router)
  • Parent/child view lifecycle via attach_child() or parent= with automatic cleanup
  • session_continuity opt-in for repeat-open state coalescing
  • auto_refresh_ephemeral for user-driven token handoff past the 15-minute ephemeral wall
  • Automatic message re-fetch so long-lived views survive the interaction token's 15-minute window

Persistence

  • Persistent views that survive bot restarts with automatic message re-attachment
  • Opt-in per slot via persistent_slots = (...) (≈ redux-persist)
  • Built-in SQLite, PostgreSQL, and in-memory backends; custom backends via capability-flag Protocol
  • Cross-process scoped invalidation through PostgreSQL LISTEN/NOTIFY (multi-worker bots)
  • Named scoped buckets via scoped_slot for per-subsystem persistence
  • Two-namespace model (registry and application) with per-namespace debounce and retry backoff
  • Undo and redo via snapshot-based state history (opt in with enable_undo)

Developer Tools

  • Built-in profiler with markdown and JSON exports
  • DevToolsCog with a tabbed state inspector and owner-only /cascadeui command group

Examples

The documentation includes full implementations demonstrating practical usage:

  • Dashboards and control panels
  • Settings systems
  • Pagination
  • Forms and wizards
  • Persistent views
  • Multi-user games with shared state, hidden information, and challenge flows (TicTacToe, Battleship)
  • Open-join lobbies with capacity caps and host-vs-participant authority (Werewolf-style)

Examples


V1 Components

CascadeUI supports traditional discord.py Views and embeds.

Use V1 when you need:

  • Embed-specific features such as fields or timestamps
  • Simpler layouts without containers

All core features such as navigation, persistence, and undo/redo are supported.

Ticket System


Documentation


Support


Development

git clone https://github.com/HollowTheSilver/CascadeUI.git
cd CascadeUI
pip install -e ".[dev,sqlite,postgres]"

pytest tests/ -v
black cascadeui/
isort cascadeui/

Developer's Note

I built CascadeUI with over ten years of Python, and roughly fifteen years of development experience. All documentation, docstrings and test modules are written and designed using custom Anthropic Opus sub-agents. I do not attempt to conceal this fact. I'm a proponent of efficient and responsible agent application in software design. That experience is what makes these tools effective. They're amplifiers, not substitutes.

-- Hollow


MIT License

Metadata

Release files for pycascadeui 3.14.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pycascadeui 3.14.1
File Size Uploaded
pycascadeui-3.14.1.tar.gz 1.2 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for pycascadeui 3.14.1
File Interpreter ABI Platform
pycascadeui-3.14.1-py3-none-any.whl Python 3 none any Details

Total release size: 1.8 MB

Release files / pycascadeui-3.14.1.tar.gz

Download URL pycascadeui-3.14.1.tar.gz
Size 1.2 MB
Tags Source
SHA-256 checksum
How to use checksums
c321f1e109e042a6b571746d38c24dcc56d87b67d8edbe93cabad5bbf9a1a6a7
BLAKE2b-256 checksum
How to use checksums
8858f0d79f7bd3fdd9d5d99756db799d8a50cf604cc37f012d029cac9cec58ea
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 10, 2026.

Transparency log

Release files / pycascadeui-3.14.1-py3-none-any.whl

Download URL pycascadeui-3.14.1-py3-none-any.whl
Size 585.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
db1d4626017d1de11171a498ec569de5dc250d8cfc7edd640d13629bde9713ef
BLAKE2b-256 checksum
How to use checksums
ec75f4c42aac05edcdca9316ecf420afa17aa8002c902936aa3887f287245567
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 10, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

3.14.1 This release

2 release files

3.13.0

2 release files

3.12.3

2 release files

3.12.2

2 release files

3.12.1

2 release files

3.12.0

2 release files

3.11.0

2 release files

3.10.0

2 release files

3.9.1

2 release files

3.9.0

2 release files

3.8.0

2 release files

3.7.0

2 release files

3.6.0

2 release files

3.5.0

2 release files

3.4.1

2 release files

3.4.0

2 release files

3.3.4

2 release files

3.3.3

2 release files

3.3.2

2 release files

3.3.1

2 release files

3.3.0

2 release files

3.2.0

2 release files

3.1.0

2 release files

3.0.0

2 release files

2.1.0

2 release files

2.0.0

2 release files

1.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page