Skip to content

docs: enterprise component field notes (ag-grid, map, react flow)#6781

Open
amsraman wants to merge 2 commits into
mainfrom
docs/enterprise-field-notes
Open

docs: enterprise component field notes (ag-grid, map, react flow)#6781
amsraman wants to merge 2 commits into
mainfrom
docs/enterprise-field-notes

Conversation

@amsraman

Copy link
Copy Markdown
Contributor

Sixth batch of upstreaming Reflex Build's AI-builder knowledge base. Enterprise component gaps:

AG Grid

  • Two new pages for previously-undocumented features: Tree Data (tree_data/get_data_path FunctionVar pattern, conditional paths, aggregation) and Master-Detail (detail_cell_renderer_params with successCallback) — both registered in the sidebar
  • index.md: selection-changed handler signature (list[dict], and the exact mismatch error a dict signature raises), floating filters, enterprise multi-column filter
  • cell-selection.md: fill-handle modes/direction, per-column suppression, nonexistent-prop pitfalls
  • model-wrapper.md: bug fix — docs said class_model=, the actual kwarg is model_class= (verified against reflex_enterprise); fixed-height requirement, _is_authorized example
  • value-transformers.md: formatter patterns and cell renderers (incl. the @rx.memo-via-lambda requirement for interactive renderers)

Map: Leaflet icon-options dicts (no rxe.map.icon exists), map-API pitfalls (function not class, don't store in state, positional args), zoom debounce.

React Flow: controlled vs uncontrolled flows, the where-changes-get-applied rule (apply_node_changes in component wiring, never state code), provider takes no handlers, screen_to_flow_position usage.

Memories already covered by existing pages (pivot mode, basic usage, value getters, editing) were skipped; one memory's unverifiable event-payload claim was rejected. Pre-commit incl. pyright clean.

🤖 Generated with Claude Code

New AG Grid pages for tree data and master-detail (previously
undocumented), selection/filtering/fill-handle additions, a
model-wrapper kwarg bug fix (class_model -> model_class), formatter and
cell-renderer patterns; Leaflet map icon dicts and map-API pitfalls;
React Flow controlled-state wiring, provider constraints, and
screen_to_flow_position. Sidebar entries registered for the new pages.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@amsraman
amsraman requested review from a team and Alek99 as code owners July 15, 2026 23:06
@codspeed-hq

codspeed-hq Bot commented Jul 15, 2026

Copy link
Copy Markdown

Merging this PR will not alter performance

✅ 26 untouched benchmarks
⏩ 8 skipped benchmarks1


Comparing docs/enterprise-field-notes (9642324) with main (7e80931)

Open in CodSpeed

Footnotes

  1. 8 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports.

@chatgpt-codex-connector chatgpt-codex-connector 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.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 196cbfd86b

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".


class State(rx.State):
# Dynamic variant: update these vars to reconfigure the grid
detail_cell_renderer_params: dict = STATIC_DETAIL_PARAMS

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Avoid putting detail callbacks in state

When this dynamic variant is copied with STATIC_DETAIL_PARAMS above, the state var contains the get_detail_row_data lambda. Reflex state vars are serialized for the client; arbitrary callables inside a dict are not preserved, so the detail grid loses the callback and expanded rows cannot load. Keep renderer params with JS callbacks as module-level props or rebuild them in the component instead of storing them in rx.State.

Useful? React with 👍 / 👎.

@greptile-apps

greptile-apps Bot commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This documentation PR (sixth batch of AI-builder knowledge-base upstreaming) adds two new AG Grid enterprise pages (Tree Data, Master Detail), fixes a class_model=model_class= kwarg typo, and enriches several existing pages with previously-undocumented patterns for Map, React Flow, cell selection, formatters, and selection-changed handlers.

  • New pages: tree-data.md covers data_path_key / get_data_path FunctionVar patterns and dynamic rx.cond path switching; master-detail.md documents detail_cell_renderer_params with the correct module-level (not state-var) placement for callable params, explicitly addressing the previously-flagged serialization issue.
  • Existing page fixes: corrects model_wrapper kwarg from class_model= to model_class=, adds _is_authorized / column customization examples, floating filters, on_selection_changed handler signature, fill-handle config, Map API positional-arg requirement, and React Flow controlled vs. uncontrolled flow rules.

Confidence Score: 5/5

Documentation-only changes; no runtime code is modified. Safe to merge.

All changes are Markdown documentation and sidebar/title registration. The patterns shown are technically sound and stated to be verified against reflex_enterprise. The only issue found is a minor method-name inconsistency in model-wrapper.md between a pre-existing bullet list and the new code example added in this PR.

docs/enterprise/ag_grid/model-wrapper.md — the overridable-methods bullet list uses _get_columns_defs (plural) while the new code example calls _get_column_defs (singular).

Important Files Changed

Filename Overview
docs/enterprise/ag_grid/model-wrapper.md Fixes class_model= → model_class= kwarg bug, adds fixed-height requirement and _is_authorized example; pre-existing bullet list names _get_columns_defs (plural) while new code example calls _get_column_defs (singular), creating an inconsistency on the same page.
docs/enterprise/ag_grid/master-detail.md New page documenting master-detail grids; correctly uses module-level objects for callback-bearing params and explicitly warns against storing lambdas in state vars.
docs/enterprise/ag_grid/tree-data.md New page for tree data with data_path_key and get_data_path FunctionVar patterns; dynamic path switching via rx.cond and group_default_expanded docs look correct.
docs/enterprise/ag_grid/index.md Adds floating filter, enterprise multi-column filter, and on_selection_changed handler documentation with correct list[dict] signature; all additions are accurate.
docs/enterprise/ag_grid/value-transformers.md Adds formatter pattern comparison (inline JS, Python lambda, FunctionStringVar) and cell_renderer section with @rx.memo requirement for interactive renderers; patterns are well-documented.
docs/enterprise/map/index.md Adds custom marker icon dict pattern, map API usage pitfalls, positional-args requirement, and zoom debounce guidance; all accurate.
docs/enterprise/react_flow/interactivity.md Adds on_connect handler, controlled vs uncontrolled flow explanation, and the where-changes-get-applied rule for apply_node_changes; all technically accurate.
docs/enterprise/react_flow/components.md Adds note that FlowProvider does not accept event handlers and shows correct handler placement on rxe.flow; example is correct.
docs/enterprise/react_flow/hooks.md Adds FlowProvider dependency note and screen_to_flow_position usage example for on_connect_end; documentation is accurate.
docs/enterprise/ag_grid/cell-selection.md Adds fill-handle direction/mode options, non-existent-prop pitfall note, and per-column suppress_fill_handle; documentation is accurate.
docs/app/reflex_docs/pages/docs/init.py Adds tree-data.md and master-detail.md to the manual_titles mapping; straightforward and correct.
docs/app/reflex_docs/templates/docpage/sidebar/sidebar_items/enterprise.py Registers Tree Data and Master Detail sidebar items under the AG Grid section between Pivot Mode and Theme; ordering and paths look correct.

Reviews (2): Last reviewed commit: "ENG: fix master-detail docs: keep callba..." | Re-trigger Greptile

Comment thread docs/enterprise/ag_grid/master-detail.md Outdated
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.

1 participant