react-native-reanimated/lib/module/css/component/AnimatedComponent.js

More powerful alternative to Animated library for React Native.

'use strict';

import { Component } from 'react';
import { Platform, StyleSheet } from 'react-native';
import { IS_JEST, ReanimatedError, SHOULD_BE_USE_WEB } from '../../common';
import { getViewInfo } from '../../createAnimatedComponent/getViewInfo';
import { getShadowNodeWrapperFromRef } from '../../fabricUtils';
import { findHostInstance } from '../../platform-specific/findHostInstance';
import { markNodeAsRemovable, unmarkNodeAsRemovable } from '../native';
import { CSSManager } from '../platform';
import { filterNonCSSStyleProps } from './utils';
import { jsx as _jsx } from "react/jsx-runtime";
// TODO - change these ugly underscore prefixed methods and properties to real
// private/protected ones when possible (when changes from this repo are merged
// to the main one)
export default class AnimatedComponent extends Component {
  _cssStyle = {}; // RN style object with Reanimated CSS properties
  _componentRef = null;
  _hasAnimatedRef = false;
  // Used only on web
  _componentDOMRef = null;
  _willUnmount = false;
  constructor(ChildComponent, props) {
    super(props);
    this.ChildComponent = ChildComponent;
  }
  getComponentViewTag() {
    return this._getViewInfo().viewTag;
  }
  _onSetLocalRef() {
    // noop - can be overridden in subclasses
  }
  _getViewInfo() {
    if (this._viewInfo !== undefined) {
      return this._viewInfo;
    }
    let viewTag;
    let shadowNodeWrapper = null;
    let DOMElement = null;
    let viewName;
    if (SHOULD_BE_USE_WEB) {
      // At this point we assume that `_setComponentRef` was already called and `_component` is set.
      // `this._component` on web represents HTMLElement of our component, that's why we use casting
      // TODO - implement a valid solution later on - this is a temporary fix
      viewTag = this._componentRef;
      DOMElement = this._componentDOMRef;
    } else {
      const hostInstance = findHostInstance(this);
      if (!hostInstance) {
        /* 
          findHostInstance can return null for a component that doesn't render anything 
          (render function returns null). Example: 
          svg Stop: https://github.com/react-native-svg/react-native-svg/blob/develop/src/elements/Stop.tsx
        */
        throw new ReanimatedError('Cannot find host instance for this component. Maybe it renders nothing?');
      }
      const viewInfo = getViewInfo(hostInstance);
      viewTag = viewInfo.viewTag ?? -1;
      viewName = viewInfo.viewName;
      shadowNodeWrapper = getShadowNodeWrapperFromRef(this, hostInstance);
    }
    this._viewInfo = {
      viewTag,
      shadowNodeWrapper,
      viewName
    };
    if (DOMElement) {
      this._viewInfo.DOMElement = DOMElement;
    }
    return this._viewInfo;
  }
  _setComponentRef = ref => {
    const forwardedRef = this.props.forwardedRef;
    // Forward to user ref prop (if one has been specified)
    if (typeof forwardedRef === 'function') {
      // Handle function-based refs. String-based refs are handled as functions.
      forwardedRef(ref);
    } else if (typeof forwardedRef === 'object' && forwardedRef) {
      // Handle createRef-based refs
      forwardedRef.current = ref;
    }
    if (!ref) {
      // component has been unmounted
      return;
    }
    if (ref !== this._componentRef) {
      this._componentRef = this._resolveComponentRef(ref);
      // if ref is changed, reset viewInfo
      this._viewInfo = undefined;
    }
    this._onSetLocalRef();
  };
  _resolveComponentRef = ref => {
    const componentRef = ref;
    // Component can specify ref which should be animated when animated version of the component is created.
    // Otherwise, we animate the component itself.
    if (componentRef && componentRef.getAnimatableRef) {
      this._hasAnimatedRef = true;
      return componentRef.getAnimatableRef();
    }
    // Case for SVG components on Web
    if (SHOULD_BE_USE_WEB) {
      if (componentRef && componentRef.elementRef) {
        this._componentDOMRef = componentRef.elementRef.current;
      } else {
        this._componentDOMRef = ref;
      }
    }
    return componentRef;
  };
  _updateStyles(props) {
    this._cssStyle = StyleSheet.flatten(props.style) ?? {};
  }
  componentDidMount() {
    this._updateStyles(this.props);
    const viewTag = this._viewInfo?.viewTag;
    if (!SHOULD_BE_USE_WEB && this._willUnmount && typeof viewTag === 'number') {
      unmarkNodeAsRemovable(viewTag);
    }
    if (!IS_JEST) {
      this._CSSManager ??= new CSSManager(this._getViewInfo());
      this._CSSManager?.update(this._cssStyle);
    }
    this._willUnmount = false;
  }
  componentWillUnmount() {
    if (!IS_JEST && this._CSSManager) {
      this._CSSManager.unmountCleanup();
    }
    const wrapper = this._viewInfo?.shadowNodeWrapper;
    if (!SHOULD_BE_USE_WEB && wrapper) {
      // Mark node as removable on the native (C++) side, but only actually remove it
      // when it no longer exists in the Shadow Tree. This ensures proper cleanup of
      // animations/transitions/props while handling cases where the node might be
      // remounted (e.g., when frozen) after componentWillUnmount is called.

      markNodeAsRemovable(wrapper);
    }
    this._willUnmount = true;
  }
  shouldComponentUpdate(nextProps) {
    this._updateStyles(nextProps);
    if (this._CSSManager) {
      this._CSSManager.update(this._cssStyle);
    }

    // TODO - maybe check if the render is necessary instead of always returning true
    return true;
  }
  render(props) {
    const {
      ChildComponent
    } = this;
    const platformProps = Platform.select({
      web: {},
      default: {
        collapsable: false
      }
    });
    return /*#__PURE__*/_jsx(ChildComponent, {
      ...(props ?? this.props),
      ...platformProps,
      style: filterNonCSSStyleProps(props?.style ?? this.props.style)
      // Casting is used here, because ref can be null - in that case it cannot be assigned to HTMLElement.
      // After spending some time trying to figure out what to do with this problem, we decided to leave it this way
      ,
      ref: this._setComponentRef
    });
  }
}
//# sourceMappingURL=AnimatedComponent.js.map