Commits on May 28, 2024

1. fix(xychart): strip legacy react events from exhaustive prop lists in… …

   … type declarations
   
   The event names `onPointerEnterCapture` and
   `onPointerLeaveCapture` are erroneously included
   in the types for react 16 and 17 - these have
   never been valid event names, but the decision has
   been taken to leave them in place based on the
   definitely-typed backporting policy. However,
   these event names _have_ been removed from the
   types for React 18.
   
   In a few places in xycharts, properties are
   removed from components with DOM element props
   using the `Omit` utility type. When the
   declarations are generated, these `Omit`s are
   transformed into `Pick`s with the inverted set of
   keys. This results in all known properties for
   these components (including
   `onPointerEnterCapture` and
   `onPointerLeaveCapture`) being included. This
   causes compilation errors for consumers of this
   package that use React 18.
   
   This commit proposes a heavily targeted fix by
   including the removed event names in the string
   unions passed to `Omit`. This is somewhat
   distasteful, because it only resolves the issue
   for existing occurrences - any new places in the
   codebase with this pattern will need to be
   specifically handled.
   
   Possible future improvements:
   1. Test the type declarations in this library
      against the React 18 types in CI to ensure we
      handle future occurrences of this pattern.
   2. Find a general solution to this. The only
      possibility I can come up with is patching the
      react type declarations used in this library to
      remove these events - since they aren't valid
      anyway, it should be fine to remove them.

   

   mtlewis committed May 28, 2024
   Configuration menu

   • View commit details
   • Copy full SHA for e903a82
   • Browse repository at this point

   Copy the full SHA

   e903a82 View commit details

   Browse the repository at this point in the history