Reflex Documentation

Reflex Documentation

Reflex is a Python framework for building full-stack web apps. Use this index to find agent-readable Markdown docs, or see llms-full.txt for the complete docs in one file.

Reflex is a Python framework for building full-stack web apps. Use this index to find agent-readable Markdown docs, or see llms-full.txt for the complete docs in one file.

Available Resources

Docs

• Project Structure (Advanced)

  • URL: https://reflex.dev/docs/advanced-onboarding/code-structure.md

• Configuration

  • URL: https://reflex.dev/docs/advanced-onboarding/configuration.md

• How Reflex Works

  • URL: https://reflex.dev/docs/advanced-onboarding/how-reflex-works.md

• Reflex Build: Best Practices

  • URL: https://reflex.dev/docs/ai/overview/best-practices.md

• Templates

  • URL: https://reflex.dev/docs/ai/overview/templates.md

• Your First Reflex Build App

  • URL: https://reflex.dev/docs/ai/overview/tutorial.md

• What Is Reflex Build

  • URL: https://reflex.dev/docs/ai/overview/what-is-reflex-build.md

• AI Onboarding

  • URL: https://reflex.dev/docs/ai/integrations/ai-onboarding.md

• Overview

  • URL: https://reflex.dev/docs/ai/integrations/mcp-overview.md

• Installation

  • URL: https://reflex.dev/docs/ai/integrations/mcp-installation.md

• Skills

  • URL: https://reflex.dev/docs/ai/integrations/skills.md

• Browser Javascript

  • URL: https://reflex.dev/docs/api-reference/browser-javascript.md

• Browser Storage

  • URL: https://reflex.dev/docs/api-reference/browser-storage.md

• CLI

  • URL: https://reflex.dev/docs/api-reference/cli.md

• Event Triggers

  • URL: https://reflex.dev/docs/api-reference/event-triggers.md

• Plugins

  • URL: https://reflex.dev/docs/api-reference/plugins.md

• Special Events

  • URL: https://reflex.dev/docs/api-reference/special-events.md

• Telemetry

  • URL: https://reflex.dev/docs/api-reference/telemetry.md

• Utility Functions

  • URL: https://reflex.dev/docs/api-reference/utils.md

• Reflex's Var System

  • URL: https://reflex.dev/docs/api-reference/var-system.md

• App

  • URL: https://reflex.dev/docs/api-reference/app.md

• Component

  • URL: https://reflex.dev/docs/api-reference/component.md

• Componentstate

  • URL: https://reflex.dev/docs/api-reference/componentstate.md

• Config

  • URL: https://reflex.dev/docs/api-reference/config.md

• Event

  • URL: https://reflex.dev/docs/api-reference/event.md

• Eventhandler

  • URL: https://reflex.dev/docs/api-reference/eventhandler.md

• Eventspec

  • URL: https://reflex.dev/docs/api-reference/eventspec.md

• Statemanager

  • URL: https://reflex.dev/docs/api-reference/statemanager.md

• State

  • URL: https://reflex.dev/docs/api-reference/state.md

• Importvar

  • URL: https://reflex.dev/docs/api-reference/importvar.md

• Var

  • URL: https://reflex.dev/docs/api-reference/var.md

• Environment Variables

  • URL: https://reflex.dev/docs/api-reference/environment-variables.md

• API Routes Overview

  • URL: https://reflex.dev/docs/api-routes/overview.md

• Assets

  • URL: https://reflex.dev/docs/assets/overview.md

• Files

  • URL: https://reflex.dev/docs/assets/upload-and-download-files.md

• Authentication Overview

  • URL: https://reflex.dev/docs/authentication/authentication-overview.md

• Client Storage Overview

  • URL: https://reflex.dev/docs/client-storage/overview.md

• Conditional Rendering

  • URL: https://reflex.dev/docs/components/conditional-rendering.md

• Convert HTML to Reflex

  • URL: https://reflex.dev/docs/components/html-to-reflex.md

• Props

  • URL: https://reflex.dev/docs/components/props.md

• Rendering Iterables

  • URL: https://reflex.dev/docs/components/rendering-iterables.md

• Custom Component CLI Reference

  • URL: https://reflex.dev/docs/custom-components/command-reference.md

• Custom Components Overview

  • URL: https://reflex.dev/docs/custom-components/overview.md

• Python Package Index

  • URL: https://reflex.dev/docs/custom-components/prerequisites-for-publishing.md

• Database Overview

  • URL: https://reflex.dev/docs/database/overview.md

• Queries

  • URL: https://reflex.dev/docs/database/queries.md

• Relationships

  • URL: https://reflex.dev/docs/database/relationships.md

• Tables

  • URL: https://reflex.dev/docs/database/tables.md

• AG Chart

  • URL: https://reflex.dev/docs/enterprise/ag-chart.md

• Aligned Grids

  • URL: https://reflex.dev/docs/enterprise/ag-grid/aligned-grids.md

• Cell Selection

  • URL: https://reflex.dev/docs/enterprise/ag-grid/cell-selection.md

• Column Definitions

  • URL: https://reflex.dev/docs/enterprise/ag-grid/column-defs.md

• AG Grid

  • URL: https://reflex.dev/docs/enterprise/ag-grid.md

• Model Wrapper

  • URL: https://reflex.dev/docs/enterprise/ag-grid/model-wrapper.md

• Pivot Mode

  • URL: https://reflex.dev/docs/enterprise/ag-grid/pivot-mode.md

• Themes

  • URL: https://reflex.dev/docs/enterprise/ag-grid/theme.md

• Value Transformers

  • URL: https://reflex.dev/docs/enterprise/ag-grid/value-transformers.md

• Built with Reflex Badge

  • URL: https://reflex.dev/docs/enterprise/built-with-reflex.md

• Components

  • URL: https://reflex.dev/docs/enterprise/components.md

• Drag and Drop

  • URL: https://reflex.dev/docs/enterprise/drag-and-drop.md

• Event Handler API Plugin

  • URL: https://reflex.dev/docs/enterprise/event-handler-api.md

• Autocomplete component

  • URL: https://reflex.dev/docs/enterprise/mantine/autocomplete.md

• Collapse component

  • URL: https://reflex.dev/docs/enterprise/mantine/collapse.md

• Combobox

  • URL: https://reflex.dev/docs/enterprise/mantine/combobox.md

• Mantine

  • URL: https://reflex.dev/docs/enterprise/mantine.md

• JSON Input

  • URL: https://reflex.dev/docs/enterprise/mantine/json-input.md

• Loading Overlay component

  • URL: https://reflex.dev/docs/enterprise/mantine/loading-overlay.md

• MultiSelect component

  • URL: https://reflex.dev/docs/enterprise/mantine/multi-select.md

• Number Formatter component

  • URL: https://reflex.dev/docs/enterprise/mantine/number-formatter.md

• Pill

  • URL: https://reflex.dev/docs/enterprise/mantine/pill.md

• Ring Progress component

  • URL: https://reflex.dev/docs/enterprise/mantine/ring-progress.md

• Semi Circle Progress component

  • URL: https://reflex.dev/docs/enterprise/mantine/semi-circle-progress.md

• Spoiler component

  • URL: https://reflex.dev/docs/enterprise/mantine/spoiler.md

• TagsInput

  • URL: https://reflex.dev/docs/enterprise/mantine/tags-input.md

• Timeline component

  • URL: https://reflex.dev/docs/enterprise/mantine/timeline.md

• Tree component

  • URL: https://reflex.dev/docs/enterprise/mantine/tree.md

• Interactive Maps

  • URL: https://reflex.dev/docs/enterprise/map.md

• Reflex Enterprise

  • URL: https://reflex.dev/docs/enterprise/overview.md

• Basic Flow Example

  • URL: https://reflex.dev/docs/enterprise/react-flow/basic-flow.md

• Flow Components

  • URL: https://reflex.dev/docs/enterprise/react-flow/components.md

• Edges

  • URL: https://reflex.dev/docs/enterprise/react-flow/edges.md

• Example React Flow Components

  • URL: https://reflex.dev/docs/enterprise/react-flow/examples.md

• Hooks (API)

  • URL: https://reflex.dev/docs/enterprise/react-flow/hooks.md

• Adding Interactivity to Your Flow

  • URL: https://reflex.dev/docs/enterprise/react-flow/interactivity.md

• Nodes

  • URL: https://reflex.dev/docs/enterprise/react-flow/nodes.md

• Overview

  • URL: https://reflex.dev/docs/enterprise/react-flow/overview.md

• Theming

  • URL: https://reflex.dev/docs/enterprise/react-flow/theming.md

• Utility Functions

  • URL: https://reflex.dev/docs/enterprise/react-flow/utils.md

• Single Port Proxy

  • URL: https://reflex.dev/docs/enterprise/single-port-proxy.md

• Background Tasks

  • URL: https://reflex.dev/docs/events/background-events.md

• Chaining events

  • URL: https://reflex.dev/docs/events/chaining-events.md

• Decentralized Event Handlers

  • URL: https://reflex.dev/docs/events/decentralized-event-handlers.md

• Event Actions

  • URL: https://reflex.dev/docs/events/event-actions.md

• Event Arguments

  • URL: https://reflex.dev/docs/events/event-arguments.md

• Events Overview

  • URL: https://reflex.dev/docs/events/events-overview.md

• Page Load Events

  • URL: https://reflex.dev/docs/events/page-load-events.md

• Special Events Docs

  • URL: https://reflex.dev/docs/events/special-events.md

• Yielding Updates

  • URL: https://reflex.dev/docs/events/yield-events.md

• Basics

  • URL: https://reflex.dev/docs/getting-started/basics.md

• AI Chat App

  • URL: https://reflex.dev/docs/getting-started/chatapp-tutorial.md

• Data Dashboard

  • URL: https://reflex.dev/docs/getting-started/dashboard-tutorial.md

• Installation

  • URL: https://reflex.dev/docs/getting-started/installation.md

• Introduction

  • URL: https://reflex.dev/docs/getting-started/introduction.md

• Project Structure

  • URL: https://reflex.dev/docs/getting-started/project-structure.md

• Project

  • URL: https://reflex.dev/docs/hosting/adding-members.md

• App

  • URL: https://reflex.dev/docs/hosting/app-management.md

• Billing

  • URL: https://reflex.dev/docs/hosting/billing.md

• Bring Your Own Cloud

  • URL: https://reflex.dev/docs/hosting/bring-your-own-cloud.md

• Compute

  • URL: https://reflex.dev/docs/hosting/compute.md

• Config File

  • URL: https://reflex.dev/docs/hosting/config-file.md

• Custom Domains

  • URL: https://reflex.dev/docs/hosting/custom-domains.md

• Deploy Reflex to Databricks

  • URL: https://reflex.dev/docs/hosting/databricks.md

• Reflex Cloud - Quick Start

  • URL: https://reflex.dev/docs/hosting/deploy-quick-start.md

• Deploy to GCP

  • URL: https://reflex.dev/docs/hosting/deploy-to-gcp.md

• Deploy with Github Actions

  • URL: https://reflex.dev/docs/hosting/deploy-with-github-actions.md

• Logs

  • URL: https://reflex.dev/docs/hosting/logs.md

• Machine Types

  • URL: https://reflex.dev/docs/hosting/machine-types.md

• Regions

  • URL: https://reflex.dev/docs/hosting/regions.md

• Secrets (Environment Variables)

  • URL: https://reflex.dev/docs/hosting/secrets-environment-vars.md

• Security Scan

  • URL: https://reflex.dev/docs/hosting/security-scan.md

• Self Hosting

  • URL: https://reflex.dev/docs/hosting/self-hosting.md

• Tokens

  • URL: https://reflex.dev/docs/hosting/tokens.md

• Avatar

  • URL: https://reflex.dev/docs/library/data-display/avatar.md

• Badge

  • URL: https://reflex.dev/docs/library/data-display/badge.md

• Callout

  • URL: https://reflex.dev/docs/library/data-display/callout.md

• Code Block

  • URL: https://reflex.dev/docs/library/data-display/code-block.md

• Data List

  • URL: https://reflex.dev/docs/library/data-display/data-list.md

• Icon

  • URL: https://reflex.dev/docs/library/data-display/icon.md

• List

  • URL: https://reflex.dev/docs/library/data-display/list.md

• Moment

  • URL: https://reflex.dev/docs/library/data-display/moment.md

• Progress

  • URL: https://reflex.dev/docs/library/data-display/progress.md

• Scroll Area

  • URL: https://reflex.dev/docs/library/data-display/scroll-area.md

• Spinner

  • URL: https://reflex.dev/docs/library/data-display/spinner.md

• Accordion

  • URL: https://reflex.dev/docs/library/disclosure/accordion.md

• Segmented Control

  • URL: https://reflex.dev/docs/library/disclosure/segmented-control.md

• Tabs

  • URL: https://reflex.dev/docs/library/disclosure/tabs.md

• Auto Scroll

  • URL: https://reflex.dev/docs/library/dynamic-rendering/auto-scroll.md

• Cond

  • URL: https://reflex.dev/docs/library/dynamic-rendering/cond.md

• Foreach

  • URL: https://reflex.dev/docs/library/dynamic-rendering/foreach.md

• Match

  • URL: https://reflex.dev/docs/library/dynamic-rendering/match.md

• Button

  • URL: https://reflex.dev/docs/library/forms/button.md

• Checkbox

  • URL: https://reflex.dev/docs/library/forms/checkbox.md

• type attribute is required for "typeMismatch" validation

  • URL: https://reflex.dev/docs/library/forms/form.md

• Input

  • URL: https://reflex.dev/docs/library/forms/input.md

• Radio Group

  • URL: https://reflex.dev/docs/library/forms/radio-group.md

• Select

  • URL: https://reflex.dev/docs/library/forms/select.md

• Slider

  • URL: https://reflex.dev/docs/library/forms/slider.md

• Switch

  • URL: https://reflex.dev/docs/library/forms/switch.md

• Text Area

  • URL: https://reflex.dev/docs/library/forms/text-area.md

• File Upload

  • URL: https://reflex.dev/docs/library/forms/upload.md

• Area Chart

  • URL: https://reflex.dev/docs/library/graphing/charts/areachart.md

• Bar Chart

  • URL: https://reflex.dev/docs/library/graphing/charts/barchart.md

• Composed Chart

  • URL: https://reflex.dev/docs/library/graphing/charts/composedchart.md

• Error Bar

  • URL: https://reflex.dev/docs/library/graphing/charts/errorbar.md

• Funnel Chart

  • URL: https://reflex.dev/docs/library/graphing/charts/funnelchart.md

• Line Chart

  • URL: https://reflex.dev/docs/library/graphing/charts/linechart.md

• Pie Chart

  • URL: https://reflex.dev/docs/library/graphing/charts/piechart.md

• Radar Chart

  • URL: https://reflex.dev/docs/library/graphing/charts/radarchart.md

• Radial Bar Chart

  • URL: https://reflex.dev/docs/library/graphing/charts/radialbarchart.md

• Scatter Chart

  • URL: https://reflex.dev/docs/library/graphing/charts/scatterchart.md

• Axis

  • URL: https://reflex.dev/docs/library/graphing/general/axis.md

• Brush

  • URL: https://reflex.dev/docs/library/graphing/general/brush.md

• - rx.recharts.CartesianAxis

  • URL: https://reflex.dev/docs/library/graphing/general/cartesiangrid.md

• Label

  • URL: https://reflex.dev/docs/library/graphing/general/label.md

• Legend

  • URL: https://reflex.dev/docs/library/graphing/general/legend.md

• Reference

  • URL: https://reflex.dev/docs/library/graphing/general/reference.md

• Graphing Tooltip

  • URL: https://reflex.dev/docs/library/graphing/general/tooltip.md

• Plotly

  • URL: https://reflex.dev/docs/library/graphing/other-charts/plotly.md

• Pyplot

  • URL: https://reflex.dev/docs/library/graphing/other-charts/pyplot.md

• HTML Form Elements

  • URL: https://reflex.dev/docs/library/html/forms.md

• HTML Elements

  • URL: https://reflex.dev/docs/library/html/html.md

• HTML Layout Elements

  • URL: https://reflex.dev/docs/library/html/layout.md

• HTML Media Elements

  • URL: https://reflex.dev/docs/library/html/media.md

• HTML SVG Elements

  • URL: https://reflex.dev/docs/library/html/svg.md

• HTML Table Elements

  • URL: https://reflex.dev/docs/library/html/tables.md

• HTML Text Elements

  • URL: https://reflex.dev/docs/library/html/text.md

• Aspect Ratio

  • URL: https://reflex.dev/docs/library/layout/aspect-ratio.md

• Box

  • URL: https://reflex.dev/docs/library/layout/box.md

• Card

  • URL: https://reflex.dev/docs/library/layout/card.md

• Center

  • URL: https://reflex.dev/docs/library/layout/center.md

• Container

  • URL: https://reflex.dev/docs/library/layout/container.md

• Flex

  • URL: https://reflex.dev/docs/library/layout/flex.md

• Fragment

  • URL: https://reflex.dev/docs/library/layout/fragment.md

• Grid

  • URL: https://reflex.dev/docs/library/layout/grid.md

• Inset

  • URL: https://reflex.dev/docs/library/layout/inset.md

• Section

  • URL: https://reflex.dev/docs/library/layout/section.md

• Separator

  • URL: https://reflex.dev/docs/library/layout/separator.md

• Spacer

  • URL: https://reflex.dev/docs/library/layout/spacer.md

• Stack

  • URL: https://reflex.dev/docs/library/layout/stack.md

• Audio

  • URL: https://reflex.dev/docs/library/media/audio.md

• Image

  • URL: https://reflex.dev/docs/library/media/image.md

• Video

  • URL: https://reflex.dev/docs/library/media/video.md

• Clipboard

  • URL: https://reflex.dev/docs/library/other/clipboard.md

• HTML Embed

  • URL: https://reflex.dev/docs/library/other/html-embed.md

• Memo

  • URL: https://reflex.dev/docs/library/other/memo.md

• Script

  • URL: https://reflex.dev/docs/library/other/script.md

• Skeleton (loading placeholder)

  • URL: https://reflex.dev/docs/library/other/skeleton.md

• Theme

  • URL: https://reflex.dev/docs/library/other/theme.md

• Alert Dialog

  • URL: https://reflex.dev/docs/library/overlay/alert-dialog.md

• Context Menu

  • URL: https://reflex.dev/docs/library/overlay/context-menu.md

• Dialog

  • URL: https://reflex.dev/docs/library/overlay/dialog.md

• Drawer

  • URL: https://reflex.dev/docs/library/overlay/drawer.md

• Dropdown Menu

  • URL: https://reflex.dev/docs/library/overlay/dropdown-menu.md

• Hovercard

  • URL: https://reflex.dev/docs/library/overlay/hover-card.md

• Popover

  • URL: https://reflex.dev/docs/library/overlay/popover.md

• Toast

  • URL: https://reflex.dev/docs/library/overlay/toast.md

• Tooltip

  • URL: https://reflex.dev/docs/library/overlay/tooltip.md

• Data Editor

  • URL: https://reflex.dev/docs/library/tables-and-data-grids/data-editor.md

• Data Table

  • URL: https://reflex.dev/docs/library/tables-and-data-grids/data-table.md

• Table

  • URL: https://reflex.dev/docs/library/tables-and-data-grids/table.md

• Blockquote

  • URL: https://reflex.dev/docs/library/typography/blockquote.md

• Code

  • URL: https://reflex.dev/docs/library/typography/code.md

• Em (Emphasis)

  • URL: https://reflex.dev/docs/library/typography/em.md

• Heading

  • URL: https://reflex.dev/docs/library/typography/heading.md

• rx.text.kbd (Keyboard)

  • URL: https://reflex.dev/docs/library/typography/kbd.md

• Link

  • URL: https://reflex.dev/docs/library/typography/link.md

• Markdown

  • URL: https://reflex.dev/docs/library/typography/markdown.md

• Quote

  • URL: https://reflex.dev/docs/library/typography/quote.md

• Strong

  • URL: https://reflex.dev/docs/library/typography/strong.md

• Text

  • URL: https://reflex.dev/docs/library/typography/text.md

• Dynamic Routes

  • URL: https://reflex.dev/docs/pages/dynamic-routing.md

• Pages

  • URL: https://reflex.dev/docs/pages/overview.md

• Login Form

  • URL: https://reflex.dev/docs/recipes/auth/login-form.md

• Sign up Form

  • URL: https://reflex.dev/docs/recipes/auth/signup-form.md

• Forms

  • URL: https://reflex.dev/docs/recipes/content/forms.md

• Grid Recipe

  • URL: https://reflex.dev/docs/recipes/content/grid.md

• Multi-column and row layout

  • URL: https://reflex.dev/docs/recipes/content/multi-column-row.md

• Stats

  • URL: https://reflex.dev/docs/recipes/content/stats.md

• Top Banner

  • URL: https://reflex.dev/docs/recipes/content/top-banner.md

• Footer Bar

  • URL: https://reflex.dev/docs/recipes/layout/footer.md

• Navigation Bar

  • URL: https://reflex.dev/docs/recipes/layout/navbar.md

• Sidebar

  • URL: https://reflex.dev/docs/recipes/layout/sidebar.md

• Smart Checkboxes Group

  • URL: https://reflex.dev/docs/recipes/others/checkboxes.md

• Chips

  • URL: https://reflex.dev/docs/recipes/others/chips.md

• Dark Mode Toggle

  • URL: https://reflex.dev/docs/recipes/others/dark-mode-toggle.md

• Pricing Cards

  • URL: https://reflex.dev/docs/recipes/others/pricing-cards.md

• Speed Dial

  • URL: https://reflex.dev/docs/recipes/others/speed-dial.md

• State Overview

  • URL: https://reflex.dev/docs/state/overview.md

• Component State

  • URL: https://reflex.dev/docs/state-structure/component-state.md

• State Mixins

  • URL: https://reflex.dev/docs/state-structure/mixins.md

• State Structure Overview

  • URL: https://reflex.dev/docs/state-structure/overview.md

• Shared State

  • URL: https://reflex.dev/docs/state-structure/shared-state.md

• Style and Layout Props

  • URL: https://reflex.dev/docs/styling/common-props.md

• Custom Stylesheets

  • URL: https://reflex.dev/docs/styling/custom-stylesheets.md

• Layout Components

  • URL: https://reflex.dev/docs/styling/layout.md

• Styling Overview

  • URL: https://reflex.dev/docs/styling/overview.md

• Responsive

  • URL: https://reflex.dev/docs/styling/responsive.md

• Tailwind

  • URL: https://reflex.dev/docs/styling/tailwind.md

• Theming

  • URL: https://reflex.dev/docs/styling/theming.md

• UI Overview

  • URL: https://reflex.dev/docs/ui/overview.md

• Exception handlers

  • URL: https://reflex.dev/docs/utility-methods/exception-handlers.md

• Lifespan Tasks

  • URL: https://reflex.dev/docs/utility-methods/lifespan-tasks.md

• Other Methods

  • URL: https://reflex.dev/docs/utility-methods/other-methods.md

• State Utility Methods

  • URL: https://reflex.dev/docs/utility-methods/router-attributes.md

• Base Vars

  • URL: https://reflex.dev/docs/vars/base-vars.md

• Computed Vars

  • URL: https://reflex.dev/docs/vars/computed-vars.md

• Custom Vars

  • URL: https://reflex.dev/docs/vars/custom-vars.md

• Var Operations

  • URL: https://reflex.dev/docs/vars/var-operations.md

• Custom Code And Hooks

  • URL: https://reflex.dev/docs/wrapping-react/custom-code-and-hooks.md

• Complex Example

  • URL: https://reflex.dev/docs/wrapping-react/example.md

• Styles and Imports

  • URL: https://reflex.dev/docs/wrapping-react/imports-and-styles.md

• Find The Component

  • URL: https://reflex.dev/docs/wrapping-react/library-and-tags.md

• Assets

  • URL: https://reflex.dev/docs/wrapping-react/local-packages.md

• More React Libraries

  • URL: https://reflex.dev/docs/wrapping-react/more-wrapping-examples.md

• Wrapping React Overview

  • URL: https://reflex.dev/docs/wrapping-react/overview.md

• Props

  • URL: https://reflex.dev/docs/wrapping-react/props.md

• Serializers

  • URL: https://reflex.dev/docs/wrapping-react/serializers.md

• Step By Step

  • URL: https://reflex.dev/docs/wrapping-react/step-by-step.md

How to Use This Skill

Reference these resources when working with Reflex Documentation.