Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[EuiDataGrid] Allow consuming applications to control various internal state via ref #5590

Merged
merged 17 commits into from
Feb 2, 2022

Commits on Jan 11, 2022

  1. [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>
    Constance and chandlerprall authored Jan 11, 2022
    Configuration menu
    Copy the full SHA
    59461c7 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    d96203d View commit details
    Browse the repository at this point in the history

Commits on Jan 12, 2022

  1. [EuiDataGrid] Add setIsFullScreen to ref API (#5531)

    * Expose `setIsFullScreen` to ref API
    
    * Update documentation/examples
    Constance authored Jan 12, 2022
    Configuration menu
    Copy the full SHA
    e5def1c View commit details
    Browse the repository at this point in the history

Commits on Jan 14, 2022

  1. Configuration menu
    Copy the full SHA
    5638646 View commit details
    Browse the repository at this point in the history

Commits on Jan 18, 2022

  1. Configuration menu
    Copy the full SHA
    ffc93f1 View commit details
    Browse the repository at this point in the history

Commits on Jan 20, 2022

  1. Configuration menu
    Copy the full SHA
    18cb489 View commit details
    Browse the repository at this point in the history

Commits on Jan 26, 2022

  1. [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
    Constance authored Jan 26, 2022
    Configuration menu
    Copy the full SHA
    f8a25bc View commit details
    Browse the repository at this point in the history

Commits on Jan 27, 2022

  1. Configuration menu
    Copy the full SHA
    0a94221 View commit details
    Browse the repository at this point in the history

Commits on Feb 1, 2022

  1. [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
    Constance authored Feb 1, 2022
    Configuration menu
    Copy the full SHA
    a31880b View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    ee7e2a9 View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    27b69db View commit details
    Browse the repository at this point in the history
  4. Improve changelog

    cee-chen committed Feb 1, 2022
    Configuration menu
    Copy the full SHA
    36201c6 View commit details
    Browse the repository at this point in the history

Commits on Feb 2, 2022

  1. Configuration menu
    Copy the full SHA
    a06db0f View commit details
    Browse the repository at this point in the history
  2. Data grid ref methods docs review

    miukimiu authored and cee-chen committed Feb 2, 2022
    Configuration menu
    Copy the full SHA
    938e2d8 View commit details
    Browse the repository at this point in the history
  3. Fix colIndex to be available in renderCellValue as well as cell actions

    - primarily for use within trailing/leading cells and custom actions
    
    - see 1609e45
    cee-chen committed Feb 2, 2022
    Configuration menu
    Copy the full SHA
    2056498 View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    f65cfda View commit details
    Browse the repository at this point in the history
  5. Configuration menu
    Copy the full SHA
    fbc2114 View commit details
    Browse the repository at this point in the history