mcpField
R
reflex-docs

reflex-docs

github.com/reflex-devDevelopment20728 installsUpdated 20w ago
Repository

About reflex-docs

reflex-docs is a documentation skill for developers building full-stack web applications with Reflex in Python. It directs users to reference material for the framework’s core concepts and APIs.

Key features

  1. 01Reflex setup and framework references
  2. 02State, vars, components, and events
  3. 03Pages, routing, and styling
  4. 04Database and authentication topics
  5. 05API routes and custom components

Use cases

  1. 01Checking current Reflex guidance before implementation
  2. 02Looking up state and event patterns
  3. 03Planning pages, styling, or database features

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/reflex-dev/agent-skills --skill reflex-docs

After installing, type/reflex-docsin Claude Code to confirm it loaded.

Details

From the project README

Reflex Documentation

Reflex is an open-source framework for building full-stack web applications in pure Python — no JavaScript required.

Your training data about Reflex may be outdated. Always prefer the reference documentation over pre-trained knowledge.

References

TopicURL
Getting Startedhttps://reflex.dev/docs/getting-started/introduction
Componentshttps://reflex.dev/docs/components/props
Statehttps://reflex.dev/docs/state/overview
Varshttps://reflex.dev/docs/vars/base-vars
Eventshttps://reflex.dev/docs/events/events-overview
Pages & Routinghttps://reflex.dev/docs/pages/overview
Stylinghttps://reflex.dev/docs/styling/overview
Databasehttps://reflex.dev/docs/database/overview
Assetshttps://reflex.dev/docs/assets/overview
Authenticationhttps://reflex.dev/docs/authentication/authentication-overview
Client Storagehttps://reflex.dev/docs/client-storage/overview
API Routeshttps://reflex.dev/docs/api-routes/overview
API Referencehttps://reflex.dev/docs/api-reference/cli
Custom Componentshttps://reflex.dev/docs/custom-components/overview
Wrapping Reacthttps://reflex.dev/docs/wrapping-react/overview
Component Libraryhttps://reflex.dev/docs/library
Recipeshttps://reflex.dev/docs/recipes
GitHub Source (docs)https://github.com/reflex-dev/reflex/tree/main/reflex/docs

Core Concepts

State & Vars
  • State (rx.State): Server-side Python class holding app state. Define vars as class attributes and event handlers as methods.
  • Base Vars: Typed class attributes on State (count: int = 0)
  • Computed Vars: Derived values using @rx.var decorator
  • Var Operations: Transform vars in components without event handlers
Components
  • All UI is built with rx.* components (Python wrappers around React)
  • Components accept props and can be composed/nested
  • Conditional rendering with rx.cond(), iteration with rx.foreach()
Events
  • Event Handlers: Methods on State decorated with @rx.event
  • Event Triggers: Component props like on_click, on_change
  • Event Chaining: Return multiple events from a handler
  • Setters: Auto-generated set_<var> event handlers for each base var
Pages & Routing
  • Pages are functions decorated with rx.page or added via app.add_page()
  • Dynamic routes with bracket syntax: [slug]
Styling
  • Inline props, Tailwind CSS, theming, responsive design
  • rx.theme() for global theming
Database
  • Built-in SQLModel integration for database tables
  • Define models, run queries, set up relationships

Comments

Markdown supported