User Guide#

The Panel user guide introduces the main concepts required for building interactive apps and dashboards using Panel, and gives an overview of the functionality available. The guide is split into core, reference, and supplementary sections.

Core Guide#

To get an initial understanding of the core concepts and components of Panel and how to use it in practice, it is recommended that all users go through each of the core guide sections.

Overview: A high-level overview of the key concepts behind Panel.
Components: An introduction to the three main component types: Widgets, Panes, and Panels.
APIs: An introduction to the different APIs panel provides to build interactive applications and dashboards.

Reference guide#

The reference guides provide a more in-depth treatment of some of the APIs and components in Panel, with detailed information that you can refer to when needed.

Customization: How to customize the visual appearance, layout, and size of Panel components.
Interact: Quickly making a panel using interact().
Widgets: Declaring and working with Panel widgets.
Parameters: Using Param to express panels in a self-contained class.
Linking: Defining links between Panel objects in Python and Javascript.
Templates: Learn how to compose multiple Panels into a custom HTML document.
Pipelines: Using Parameterized classes to declare linear workflows containing multiple panels.
Performance, Profiling and Debugging: Learn how to speed up your application and find issues.

State, Caching & Callbacks#

Session State and Callbacks: Learn how to access session state and schedule callbacks.
Asynchronous and Concurrent Processing: Learn how leverage asynchronous and concurrent processing to make your app more responsive.

Export#

Display & Export: Guide towards configuring and displaying output and exporting Panel apps and components.
Running Panel in the Browser with WASM: Guide to embedding interactive Panel components in a web page or converting entire Panel applications to run entirely in your browser.

Server Usage#

Server configuration: A guide detailing how to launch and configure a server from the commandline or programmatically.
Server Deployment: Step-by-step guides for deploying Panel apps locally, on a web server or on common cloud providers.
Authentication: Learn how to add an authentication component in front of your application.
Django Integration: How to embed a Panel/Bokeh app inside a Django web-server deployment.
FastAPI Integration: How to embed a Panel/Bokeh app inside a FastAPI web-server deployment.

Extending Panel#

Building custom components: Learn how to extend Panel by building custom components.