Merge pull request #1723 from wix/infra/refactorTimeline_2

Refactor Timeline component - part2

Author: lidord-wix

example/src/screens/timelineCalendar.tsx

@@ -81,7 +81,7 @@ const EVENTS = [
 
 export default class TimelineCalendarScreen extends Component {
   state = {
-    currentDate: '2017-09-07'
+    currentDate: '2017-09-10'
   };
 
   marked = {
@@ -120,7 +120,7 @@ export default class TimelineCalendarScreen extends Component {
           format24h={true}
           eventTapped={e => e}
           events={EVENTS.filter(event => sameDate(new XDate(event.start), new XDate(this.state.currentDate)))}
-          // scrollToFirst={true}
+          scrollToFirst
           // start={0}
           // end={24}
         />

src/timeline/Timeline.tsx

@@ -1,10 +1,7 @@
-// @flow
+import React, {useCallback, useEffect, useMemo, useRef} from 'react';
+import {View, Dimensions, ScrollView} from 'react-native';
 import min from 'lodash/min';
 import map from 'lodash/map';
-import PropTypes from 'prop-types';
-
-import React, {Component} from 'react';
-import {View, Dimensions, ScrollView, TextStyle, ViewStyle} from 'react-native';
 
 import {Theme} from '../types';
 import styleConstructor from './style';
@@ -13,7 +10,6 @@ import TimelineHours from './TimelineHours';
 import EventBlock, {Event, PackedEvent} from './EventBlock';
 
 const LEFT_MARGIN = 60 - 1;
-
 const {width: dimensionWidth} = Dimensions.get('window');
 
 export interface TimelineProps {
@@ -29,111 +25,68 @@ export interface TimelineProps {
   renderEvent?: (event: PackedEvent) => JSX.Element;
 }
 
-interface State {
-  _scrollY: number;
-  packedEvents: PackedEvent[];
-}
-
-export default class Timeline extends Component<TimelineProps, State> {
-  static propTypes = {
-    start: PropTypes.number,
-    end: PropTypes.number,
-    eventTapped: PropTypes.func, // TODO: remove after deprecation
-    onEventPress: PropTypes.func,
-    format24h: PropTypes.bool,
-    events: PropTypes.arrayOf(
-      PropTypes.shape({
-        start: PropTypes.string.isRequired,
-        end: PropTypes.string.isRequired,
-        title: PropTypes.string.isRequired,
-        summary: PropTypes.string.isRequired,
-        color: PropTypes.string
-      })
-    ).isRequired
-  };
-
-  static defaultProps = {
-    start: 0,
-    end: 24,
-    events: [],
-    format24h: true
-  };
-
-  private scrollView = React.createRef<ScrollView>();
-  style: {[key: string]: ViewStyle | TextStyle};
-  calendarHeight: number;
-
-  constructor(props: TimelineProps) {
-    super(props);
-
-    const {start = 0, end = 0} = this.props;
-    this.calendarHeight = (end - start) * HALF_HOUR_BLOCK_HEIGHT;
-
-    this.style = styleConstructor(props.theme || props.styles, this.calendarHeight);
-
-    const width = dimensionWidth - LEFT_MARGIN;
-    const packedEvents = populateEvents(props.events, width, start);
-    const firstTop = min(map(packedEvents, 'top')) ?? 0;
-    const initPosition = firstTop  - this.calendarHeight / (end - start);
-    const verifiedInitPosition = initPosition < 0 ? 0 : initPosition;
-
-    this.state = {
-      _scrollY: verifiedInitPosition,
-      packedEvents
-    };
-  }
-
-  componentDidUpdate(prevProps: TimelineProps) {
+const Timeline = (props: TimelineProps) => {
+  const {
+    format24h = true,
+    start = 0,
+    end = 24,
+    events = [],
+    onEventPress,
+    renderEvent,
+    theme,
+    scrollToFirst,
+    eventTapped
+  } = props;
+
+  const scrollView = useRef<ScrollView>();
+  const calendarHeight = useRef((end - start) * HALF_HOUR_BLOCK_HEIGHT);
+  const styles = useRef(styleConstructor(theme || props.styles, calendarHeight.current));
+
+  const packedEvents = useMemo(() => {
     const width = dimensionWidth - LEFT_MARGIN;
-    const {events: prevEvents, start: prevStart = 0} = prevProps;
-    const {events, start = 0} = this.props;
-
-    if (prevEvents !== events || prevStart !== start) {
-      this.setState({
-        packedEvents: populateEvents(events, width, start)
-      });
-    }
-  }
-
-  componentDidMount() {
-    this.props.scrollToFirst && this.scrollToFirst();
-  }
-
-  scrollToFirst() {
-    setTimeout(() => {
-      if (this.state && this.state._scrollY && this.scrollView) {
-        this.scrollView?.current?.scrollTo({
-          x: 0,
-          y: this.state._scrollY,
-          animated: true
-        });
+    return populateEvents(events, width, start);
+  }, [events, start]);
+
+  useEffect(() => {
+    if (scrollToFirst) {
+      const firstTop = min(map(packedEvents, 'top')) ?? 0;
+      const initPosition = firstTop - calendarHeight.current / (end - start);
+      const verifiedInitPosition = initPosition < 0 ? 0 : initPosition;
+
+      if (verifiedInitPosition) {
+        setTimeout(() => {
+          scrollView?.current?.scrollTo({
+            y: verifiedInitPosition,
+            animated: true
+          });
+        }, 0);
       }
-    }, 1);
-  }
-
-  onEventPress = (eventIndex: number) => {
-    const event = this.props.events[eventIndex];
-    if (this.props.eventTapped) {
-      //TODO: remove after deprecation
-      this.props.eventTapped(event);
-    } else {
-      this.props.onEventPress?.(event);
     }
-  };
-
-  renderEvents() {
-    const {packedEvents} = this.state;
-    const {format24h, renderEvent} = this.props;
+  }, []);
+
+  const _onEventPress = useCallback(
+    (eventIndex: number) => {
+      const event = events[eventIndex];
+      if (eventTapped) {
+        //TODO: remove after deprecation
+        eventTapped(event);
+      } else {
+        onEventPress?.(event);
+      }
+    },
+    [events, onEventPress, eventTapped]
+  );
 
+  const renderEvents = () => {
     const events = packedEvents.map((event: PackedEvent, i: number) => {
       return (
         <EventBlock
           key={i}
           index={i}
           event={event}
-          styles={this.style}
+          styles={styles.current}
           format24h={format24h}
-          onPress={this.onEventPress}
+          onPress={_onEventPress}
           renderEvent={renderEvent}
         />
       );
@@ -144,15 +97,15 @@ export default class Timeline extends Component<TimelineProps, State> {
         <View style={{marginLeft: LEFT_MARGIN}}>{events}</View>
       </View>
     );
-  }
+  };
 
-  render() {
-    const {format24h, start, end} = this.props;
-    return (
-      <ScrollView ref={this.scrollView} contentContainerStyle={[this.style.contentStyle, {width: dimensionWidth}]}>
-        <TimelineHours start={start} end={end} format24h={format24h} styles={this.style} />
-        {this.renderEvents()}
-      </ScrollView>
-    );
-  }
-}
+  return (
+    // @ts-expect-error
+    <ScrollView ref={scrollView} contentContainerStyle={[styles.current.contentStyle, {width: dimensionWidth}]}>
+      <TimelineHours start={start} end={end} format24h={format24h} styles={styles.current} />
+      {renderEvents()}
+    </ScrollView>
+  );
+};
+
+export default Timeline;