fix: correct TimeGutter ref (jquense#2204)

Corrects issue with TimeGutter ref in TimeGrid views jquense#2201
Xetoxyc · Jul 5, 2022 · 055cdd0 · 055cdd0
1 parent 779060a
commit 055cdd0
Show file tree

Hide file tree

Showing 2 changed files with 60 additions and 61 deletions.
diff --git a/src/TimeGrid.js b/src/TimeGrid.js
@@ -283,7 +283,7 @@ export default class TimeGrid extends Component {
     }
     this.measureGutterAnimationFrameRequest = window.requestAnimationFrame(
       () => {
-        const width = getWidth(this.gutter)
+        const width = getWidth(this.gutterRef?.current)
 
         if (width && this.state.gutterWidth !== width) {
           this.setState({ gutterWidth: width })

diff --git a/src/TimeGutter.js b/src/TimeGutter.js
@@ -1,83 +1,77 @@
+import React, { useState, useEffect } from 'react'
 import clsx from 'clsx'
 import PropTypes from 'prop-types'
-import React, { Component } from 'react'
 
 import * as TimeSlotUtils from './utils/TimeSlots'
 import TimeSlotGroup from './TimeSlotGroup'
 
-/**
- * Since the TimeGutter only displays the 'times' of slots in a day, and is separate
- * from the Day Columns themselves, we check to see if the range contains an offset difference
- * and, if so, change the beginning and end 'date' by a day to properly display the slots times
- * used.
- */
-function adjustForDST({ min, max, localizer }) {
-  if (localizer.getTimezoneOffset(min) !== localizer.getTimezoneOffset(max)) {
-    return {
-      start: localizer.add(min, -1, 'day'),
-      end: localizer.add(max, -1, 'day'),
-    }
-  }
-  return { start: min, end: max }
-}
-
-export default class TimeGutter extends Component {
-  constructor(...args) {
-    super(...args)
-
-    const { min, max, timeslots, step, localizer } = this.props
-    const { start, end } = adjustForDST({ min, max, localizer })
-    this.slotMetrics = TimeSlotUtils.getSlotMetrics({
-      min: start,
-      max: end,
+const TimeGutter = ({
+  min,
+  max,
+  timeslots,
+  step,
+  localizer,
+  getNow,
+  resource,
+  components,
+  getters,
+  gutterRef,
+}) => {
+  const [slotMetrics, setSlotMetrics] = useState(
+    TimeSlotUtils.getSlotMetrics({
+      min,
+      max,
       timeslots,
       step,
       localizer,
     })
-  }
+  )
 
-  UNSAFE_componentWillReceiveProps(nextProps) {
-    const { min, max, localizer } = nextProps
-    const { start, end } = adjustForDST({ min, max, localizer })
-    this.slotMetrics = this.slotMetrics.update({
-      ...nextProps,
-      min: start,
-      max: end,
-    })
-  }
+  useEffect(() => {
+    if (slotMetrics) {
+      setSlotMetrics(
+        slotMetrics.update({
+          min,
+          max,
+          timeslots,
+          step,
+          localizer,
+        })
+      )
+    }
+    /**
+     * We don't want this to fire when slotMetrics is updated as it would recursively bomb
+     */
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, [min, max, timeslots, step])
 
-  renderSlot = (value, idx) => {
-    if (idx !== 0) return null
-    const { localizer, getNow } = this.props
+  const renderSlot = (value, idx) => {
+    if (idx) return null // don't return the first (0) idx
 
-    const isNow = this.slotMetrics.dateIsInGroup(getNow(), idx)
+    const isNow = slotMetrics.dateIsInGroup(getNow(), idx)
     return (
       <span className={clsx('rbc-label', isNow && 'rbc-now')}>
         {localizer.format(value, 'timeGutterFormat')}
       </span>
     )
   }
 
-  render() {
-    const { resource, components, getters } = this.props
-
-    return (
-      <div className="rbc-time-gutter rbc-time-column">
-        {this.slotMetrics.groups.map((grp, idx) => {
-          return (
-            <TimeSlotGroup
-              key={idx}
-              group={grp}
-              resource={resource}
-              components={components}
-              renderSlot={this.renderSlot}
-              getters={getters}
-            />
-          )
-        })}
-      </div>
-    )
-  }
+  return (
+    <div className="rbc-time-gutter rbc-time-column" ref={gutterRef}>
+      {slotMetrics.groups.map((grp, idx) => {
+        return (
+          <TimeSlotGroup
+            key={idx}
+            group={grp}
+            resource={resource}
+            components={components}
+            renderSlot={renderSlot}
+            getters={getters}
+          />
+        )
+      })}
+    </div>
+  )
 }
 
 TimeGutter.propTypes = {
@@ -91,4 +85,9 @@ TimeGutter.propTypes = {
 
   localizer: PropTypes.object.isRequired,
   resource: PropTypes.string,
+  gutterRef: PropTypes.any,
 }
+
+export default React.forwardRef((props, ref) => (
+  <TimeGutter gutterRef={ref} {...props} />
+))