Dash Prism

Contents

  • Getting Started
    • Installation
    • Minimal Example
    • Development Installation
  • User Guide
    • Layouts
      • Parameterized Layouts
      • Async Layouts
      • Multiple Instances (allow_multiple)
    • Actions
    • Icons
    • Persistence
    • Initial Layout
    • Workspace State
      • Reading State with Actions
      • Writing State with Actions
      • Server-Side Persistence Pattern
      • Validating Workspace Data
    • Configuration
      • Tab Limits
    • Caveats
      • Callback Exceptions
      • ID Transformation (allow_multiple only)
      • Callback Patterns for allow_multiple
      • Registration Order
      • Initialization (dash_prism.init)
        • Static vs Callable Layouts
        • Background Callbacks
  • API Reference
    • Components
      • Prism
        • Prism
      • Action
        • Action
    • Registration
      • register_layout()
      • init()
      • LayoutParameter
        • LayoutParameter.name
        • LayoutParameter.has_default
        • LayoutParameter.default
        • LayoutParameter.annotation
        • LayoutParameter.to_dict()
      • get_layout()
      • clear_registry()
    • Icons
      • get_available_icons()
      • AVAILABLE_ICONS
    • Utilities
      • walk_layout()
      • inject_tab_id()
      • find_component_by_id()
      • update_component_props()
      • validate_workspace()
    • Exceptions
      • InitializationError
      • InvalidWorkspace
  • Contributing
    • Setup
    • Tests
    • Code Style
    • Building Docs
Dash Prism
  • Index

Index

A | C | D | F | G | H | I | L | N | P | R | T | U | V | W

A

  • Action (class in dash_prism)
  • annotation (dash_prism.LayoutParameter attribute)
  • AVAILABLE_ICONS (in module dash_prism)

C

  • clear_registry() (in module dash_prism)

D

  • default (dash_prism.LayoutParameter attribute)

F

  • find_component_by_id() (in module dash_prism)

G

  • get_available_icons() (in module dash_prism)
  • get_layout() (in module dash_prism)

H

  • has_default (dash_prism.LayoutParameter attribute)

I

  • init() (in module dash_prism)
  • InitializationError (class in dash_prism)
  • inject_tab_id() (in module dash_prism)
  • InvalidWorkspace (class in dash_prism)

L

  • LayoutParameter (class in dash_prism)

N

  • name (dash_prism.LayoutParameter attribute)

P

  • Prism (class in dash_prism)

R

  • register_layout() (in module dash_prism)

T

  • to_dict() (dash_prism.LayoutParameter method)

U

  • update_component_props() (in module dash_prism)

V

  • validate_workspace() (in module dash_prism)

W

  • walk_layout() (in module dash_prism)

© Copyright 2026, Ludwig Jonsson.

Built with Sphinx using a theme provided by Read the Docs.