[EuiDataGrid] Add openCellPopover and closeCellPopover to ref APIs
#5550
Conversation
… recent state/value - without this callback, the initial returned hook values will be stale/not properly return most recent values - see next commit for example usage within useCellPopover
- set up initial open/location state, + open/close popover APIs returned to consumers - improve auto props documentation - remove EuiDataGridCellLocation in favor of specifying rowIndex and colIndex (it's less DRY but it's easier for devs to not have to look up EuiDataGridCellLocation from our docs)
- I'm not using context here because we're already using this.context for focus, and unfortunately class components can only initialize one context at time using `static contextType` (see https://reactjs.org/docs/context.html#classcontexttype)
- This should now be handled by the overarching context state, and the cell should simply react to it or update it (similar to how focusContext works) + add new var for hasCellButtons + add unit tests for isFocusedCell alongside isPopoverOpen (since both methods perform similar functions)
- content is TODO, will likely be easier to compare when cleaning it up/moving it all at once
- It should no longer exist as a reusable component that belongs to every single cell, but instead as a single popover that exists at the top grid level and moves from cell to cell - I cleaned and split up the JSX for the popover (e.g. moving popover actions to data_grid_cell_buttons, where it feels like it belongs more) and think it's significantly more DRY now - note the entire `anchorContent` branch removed from EuiDataGridCell that is no longer necessary - Note that due to this change, we now have to mock EuiWrappingPopover in EuiDataGrid tests, as we see failures otherwise
- this is the same behavior as in prod - causes weird DOM issues if we don't close the cell popover automatically
…f view + write bonus Cypress test for useScroll's focus effect now that we have access to the imperative ref
+ remove code snippet - it was starting to get redundant with the API bullet points, and is already available as tab if needed + fix control button widths
There was a problem hiding this comment.
@chandlerprall Once this lands, I'm thinking we can maybe open a PR and merge the ref feature branch into main and handle the 2nd bullet point of #5310 ("Allow consumers to completely control the popover contents including the custom controls") as a separate PR/concern - any thoughts?
| setFocusedCell: (cell: { rowIndex: number; colIndex: number }) => void; | ||
| /** | ||
| * Allows manually opening the popover of the specified cell in the grid. | ||
| */ | ||
| openCellPopover: (cell: { rowIndex: number; colIndex: number }) => void; | ||
| /** | ||
| * Closes any currently open popovers in the data grid. | ||
| */ | ||
| closeCellPopover: () => void; | ||
| } | ||
|
|
||
| export type EuiDataGridCellLocation = { rowIndex: number; colIndex: number }; | ||
|
|
There was a problem hiding this comment.
Quick note that I removed EuiDataGridCellLocation because of our auto props. I wanted to make rowIndex and colIndex immediately available in our props table, and if we used EuiDataGridCellLocation it unfortunately referenced that instead.
|
Preview documentation changes for this PR: https://eui.elastic.co/pr_5550/ |
That makes sense to me 👍 |
There was a problem hiding this comment.
Very cool restructuring! Pulled locally & poked at the tests and some possible performance things, but didn't find any issues there.
I think there's a disconnect somewhere around row ID vs. visible row ID, as this works great on the first page of content but no popover displays when on other pages.
| // If `openCellPopover` was somehow called on this cell but it's not | ||
| // supposed to be expandable, we should do nothing and set popoverIsOpen | ||
| // state back to false | ||
| popoverContext.closeCellPopover(); |
There was a problem hiding this comment.
Did you run into this scenario?
Because the render function calls isPopoverOpen, this can trigger the side effect during rendering, which is a strong anti-pattern. If having the popover state set to open when the cell is non-expandable is an issue, we should try to find a different place to account for it.
There was a problem hiding this comment.
Yes, this scenario can occur if a user manually calls openCellPopover() on a cell that they have set to isExpandable: false. Obviously it wouldn't occur from our internal grid state, but since we're exposing the API to consumers to use at will, I was attempting to guard against it. I tested it locally by adding isExpandable: false to various columns in the ref.js documentation example.
I'm fine removing this piece of logic if you think it's extraneous. The primary bug/scenario I can think of that would occur from not having this logic that sets popoverIsOpen back to false is:
- Consumer calls
openCellPopover()on a cell [0,0] that isisExpandable: false, internalpopoverIsOpenstate is now set totrueand cell location is set to[0,0] - Consumer changes the column to
isExpandable: true - Consumer calls
openCellPopover()on a cell [0,0] again, but nothing happens becausepopoverIsOpenstate is already set totrue
I admit that's not a likely edge case, so if you strongly think this is a risky change I can remove it 🤷♀️
There was a problem hiding this comment.
I lean toward either 1. moving the isExpandable logic into openCellPopover itself, or 2. ignoring the edge case entirely, rather than triggering the side effect from the render.
Or, as a third option, maybe even a small check in componentDidUpdate.
There was a problem hiding this comment.
I'm good with just ignoring the edge case entirely! We can say the onus is on the consumer to know if their cells are not expandable and not call openCellPopover on cell that shouldn't expand
There was a problem hiding this comment.
Let's not mark the conversation as resolved BTW, I'd like the dialogue+decision to be immediately visible to anyone who comes back to this PR for historical context.
+ add a few explanatory comments
- to make it sound less like a verb/method
|
Preview documentation changes for this PR: https://eui.elastic.co/pr_5550/ |
…n `isExpandable: false` cell
|
Preview documentation changes for this PR: https://eui.elastic.co/pr_5550/ |
|
Oh oops, I totally missed that comment 🤦♀️ Looking into it now! |
|
Talked this out with @chandlerprall synchronously and the fix for handling paginated and sorted rowIndexes is going to be a significant amount of code change and deviation from the current setFocusedCell and openCellPopover code (which currently treats |
…l state via `ref` (#5590) * [EuiDataGrid] Set up `ref` that exposes focus/popover internal APIs (#5499) * Set up types * Set up forwardRef * Add setFocusedCell API to returned grid ref obj * Add colIndex prop to cell actions - so that cell actions that trigger modals or flyouts can re-focus into the correct cell using the new ref API * Add documentation + example + props * Add changelog * [PR feedback] Types Co-authored-by: Chandler Prall <chandler.prall@gmail.com> * [PR feedback] Clean up unit test * [Rebase] Tweak useImperativeHandle location - Moving it below fullscreen logic, as we're oging to expose setIsFullScreen as an API shortly Co-authored-by: Chandler Prall <chandler.prall@gmail.com> * [EuiDataGrid] Add `setIsFullScreen` to ref API (#5531) * Expose `setIsFullScreen` to ref API * Update documentation/examples * [EuiDataGrid] Add `openCellPopover` and `closeCellPopover` to ref APIs (#5550) * [setup] Update testCustomHook to expose fn that allows accessing most recent state/value - without this callback, the initial returned hook values will be stale/not properly return most recent values - see next commit for example usage within useCellPopover * Set up cell popover context - set up initial open/location state, + open/close popover APIs returned to consumers - improve auto props documentation - remove EuiDataGridCellLocation in favor of specifying rowIndex and colIndex (it's less DRY but it's easier for devs to not have to look up EuiDataGridCellLocation from our docs) * Pass down popoverContext to cells as a prop - I'm not using context here because we're already using this.context for focus, and unfortunately class components can only initialize one context at time using `static contextType` (see https://reactjs.org/docs/context.html#classcontexttype) * Remove internal cell popoverIsOpen state - This should now be handled by the overarching context state, and the cell should simply react to it or update it (similar to how focusContext works) + add new var for hasCellButtons + add unit tests for isFocusedCell alongside isPopoverOpen (since both methods perform similar functions) * Update cell popovers to set the popover anchor & content - content is TODO, will likely be easier to compare when cleaning it up/moving it all at once * Refactor EuiDataGridCellPopover - It should no longer exist as a reusable component that belongs to every single cell, but instead as a single popover that exists at the top grid level and moves from cell to cell - I cleaned and split up the JSX for the popover (e.g. moving popover actions to data_grid_cell_buttons, where it feels like it belongs more) and think it's significantly more DRY now - note the entire `anchorContent` branch removed from EuiDataGridCell that is no longer necessary - Note that due to this change, we now have to mock EuiWrappingPopover in EuiDataGrid tests, as we see failures otherwise * [bugfix] Handle cells with open popover being scrolled out of view - this is the same behavior as in prod - causes weird DOM issues if we don't close the cell popover automatically * [bugfix] Workaround for popover DOM stuttering issues * [enhancement] Account for openCellPopover being called on cells out of view + write bonus Cypress test for useScroll's focus effect now that we have access to the imperative ref * Update documentation example + remove code snippet - it was starting to get redundant with the API bullet points, and is already available as tab if needed + fix control button widths * [PR feedback] Be more specific about useImperativeHandle dependencies + add a few explanatory comments * [PR feedback] Rename openCellLocation to cellLocation - to make it sound less like a verb/method * [PR feedback] Ignore edge case of `openCellPopover` being called on an `isExpandable: false` cell * [EuiDataGrid] Handle exposed ref APIs potentially pointing to invalid, off-page, or out of view cells (#5572) * Enable sorting + targeting row indices outside of the current page - to test handling the exposed APIs when dealing with sorted/paginated data * Switch data grid example to Typescript - to test type issues during consumer usage + @ts-ignore faker complaints * Fix cell expansion buttons on paginated pages not working correctly * Attempt to more clearly document `rowIndex`s that are actually `visibleRowIndex`s * [setup] Move imperative handler setup to its own util file - this will let us set up ref-specific helpers & add more comment context without bloating the main file * Add catch/check for cell locations that do not exist in the current grid * Add getVisibleRowIndex helper - Converts the `rowIndex` from the consumer to a `visibleRowIndex` that our internal state can use - Account for sorted grid by finding the inversed index of the `sortedRowMap` - To make this easier, I converted soredRowMap to an array (since it's already only uses numbers for both keys and values), since arrays have a handy .findIndex method - Handles automatically paginating the grid if the targeted cell is on a different page * Replace grid ref Jest tests with more complete Cypress tests * Update documentation with new behavior * [PR feedback] Rename fns to indicate multiple concerns - having a side effect in a getter feels bad, so change that to a `find` - rename use hook to indicate sorting and pagination concerns * Improve changelog * Data grid ref methods docs review * Fix colIndex to be available in renderCellValue as well as cell actions - primarily for use within trailing/leading cells and custom actions - see 1609e45 * Fix main datagrid example to restore cell focus on modal/flyout close * [a11y] Fix missing header cell text in main datagrid example Co-authored-by: Chandler Prall <chandler.prall@gmail.com> Co-authored-by: Elizabet Oliveira <elizabet.oliveira@elastic.co>
Summary
The main goal of this PR is to expose APIs that allow consumers to manually control cell popovers (#5310)
However, because each cell contained its own individual popover and popover state, this required a refactor of how our cell popover architecture works:
I strongly recommend:
Screencaps
Coverage
QA
openCellPopoverandcloseCellPopoverAPIs work as expectedChecklist
- [ ] Check against all themes for compatibility in both light and dark modes- [ ] Checked in mobile- [ ] Checked Code Sandbox works for any docs examples- [ ] Checked for breaking changes and labeled appropriately- [ ] A changelog entry exists and is marked appropriately(Will add a finished changelog in final feature branch PR)