Skip to content

Docs: lead the Reflex integration with rxy.data - #478

Merged
Alek99 merged 5 commits into
mainfrom
agent/document-reflex-data-integration
Aug 7, 2026
Merged

Docs: lead the Reflex integration with rxy.data#478
Alek99 merged 5 commits into
mainfrom
agent/document-reflex-data-integration

Conversation

@Alek99

@Alek99 Alek99 commented Aug 7, 2026

Copy link
Copy Markdown
Member

What

Updates the public Reflex integration guide to use the data-bound API introduced by Farhan's component stack:

  • fixed columns render through the data-bound chart factories;
  • state-backed charts use typed @rxy.data methods;
  • both the flat rxy.scatter_chart(...) and composed rxy.chart(...) forms are documented;
  • compile-time schema checks, stable data handles, rx.cond, and rx.foreach behavior are explained;
  • @rxy.figure is kept only as a short escape-hatch note for state-dependent chart structure;
  • the generated API table and executable documentation tests cover the new surface.

Why

The guide still presented @reflex_xy.figure as the default whenever chart data depended on state. That predates the data-bound component API and encourages rebuilding chart structure when only columns change. The updated path keeps chart structure compile-validated and republishes binary columns under a stable handle.

Verification

  • uv run --no-sync reflex compile --dry — 181 routes compiled
  • uv run --no-sync pytest tests in docs/app — 115 passed, 2 skipped
  • uv run --no-sync ruff check . in docs/app — clean
  • uv run --no-sync codespell --toml pyproject.toml ../integrations/reflex.md — clean
  • production docs server returned HTTP 200 for /docs/xy/integrations/reflex/

Review in cubic

Summary by CodeRabbit

  • Documentation
    • Updated Reflex integration guidance to use the rxy namespace and data-backed chart APIs.
    • Added live scatter and line chart examples, including fixed, state-backed, and composed data.
    • Clarified live updates, streaming, event handlers, asynchronous results, and chart export.
    • Refreshed documentation examples and validation to reflect the renamed sections and updated usage.

@coderabbitai

coderabbitai Bot commented Aug 7, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 2a6cd7ca-f8f4-475e-8d60-bcdc5341f701

📥 Commits

Reviewing files that changed from the base of the PR and between de0bfad and 8c51d0d.

📒 Files selected for processing (2)
  • docs/app/tests/test_docs_site.py
  • docs/integrations/reflex.md
🚧 Files skipped from review as they are similar to previous changes (2)
  • docs/app/tests/test_docs_site.py
  • docs/integrations/reflex.md

📝 Walkthrough

Walkthrough

The Reflex integration documentation now describes data-bound chart APIs, typed state-backed data, composed marks, streaming updates, and revised data tiers. Documentation tests validate the updated API names, headings, namespaces, demos, fence parsing, and component construction.

Changes

Reflex data-bound integration

Layer / File(s) Summary
Data-bound API examples
docs/integrations/reflex.md
Examples use the rxy namespace, concrete columns, @rxy.data, rxy.scatter_chart, and typed event handling.
Data flow and API guidance
docs/integrations/reflex.md
Documentation covers typed data, async or empty results, composed marks, live data events, rxy.append, supported data tiers, and updated experimental APIs.
Documentation example validation
docs/app/tests/test_docs_site.py, docs/app/tests/test_framework_integration_examples.py
Tests validate the API entries, executable demos, section names, example namespace, fence parsing, and component construction paths.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

  • reflex-dev/xy#408: Updates the Reflex integration documentation and tests for renamed APIs.
  • reflex-dev/xy#460: Introduces data-bound APIs covered by these documentation updates.
  • reflex-dev/xy#461: Defines the related @rxy.data, rxy.scatter_chart, and composed chart APIs.

Suggested reviewers: masenf

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the main documentation change: leading the Reflex integration guide with the rxy.data API.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch agent/document-reflex-data-integration

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@Alek99
Alek99 marked this pull request as ready for review August 7, 2026 20:58

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/integrations/reflex.md`:
- Around line 6-8: Add reflex_xy.line_chart to the Reflex adapter metadata by
updating the front-matter components list in docs/integrations/reflex.md and the
expected API paths in docs/app/tests/test_docs_site.py, keeping both lists
aligned with the existing Reflex public factories.
🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 58e5dc5d-a376-4ad8-856c-231e051de757

📥 Commits

Reviewing files that changed from the base of the PR and between 55b8b61 and a048bf5.

📒 Files selected for processing (3)
  • docs/app/tests/test_docs_site.py
  • docs/app/tests/test_framework_integration_examples.py
  • docs/integrations/reflex.md

Comment thread docs/integrations/reflex.md

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All reported issues were addressed across 3 files

Reply with feedback, questions, or to request a fix.

Re-trigger cubic

Comment thread docs/integrations/reflex.md
@Alek99
Alek99 marked this pull request as draft August 7, 2026 21:10
@Alek99
Alek99 marked this pull request as ready for review August 7, 2026 21:36

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All reported issues were addressed across 3 files

Reply with feedback, questions, or to request a fix.

Re-trigger cubic

Comment thread docs/app/tests/test_docs_site.py Outdated
Comment thread docs/integrations/reflex.md Outdated
@Alek99
Alek99 merged commit f7c30d4 into main Aug 7, 2026
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants