'use strict'; import type { ComponentProps, Ref } from 'react'; import { Component } from 'react'; import type { StyleProp } from 'react-native'; import { Platform, StyleSheet } from 'react-native'; import type { AnyComponent, UnknownRecord } from '../../common'; import type { InternalHostInstance } from '../../commonTypes'; import type { AnimatedComponentRef, IAnimatedComponentInternalBase, ViewInfo, } from '../../createAnimatedComponent/commonTypes'; import { getViewInfo } from '../../createAnimatedComponent/getViewInfo'; import { getShadowNodeWrapperFromRef } from '../../fabricUtils'; import type { DefaultStyle } from '../../hook/commonTypes'; import { findHostInstance } from '../../platform-specific/findHostInstance'; import { assignRef } from '../../reactUtils'; import { markNodeAsRemovable, unmarkNodeAsRemovable } from '../native'; import { CSSManager } from '../platform'; import type { CSSStyle } from '../types'; import { filterCSSProps } from './utils'; export type AnimatedComponentProps = UnknownRecord & { ref?: Ref; style?: StyleProp; }; // 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< P extends UnknownRecord = AnimatedComponentProps, S extends object = UnknownRecord, > extends Component implements IAnimatedComponentInternalBase { ChildComponent: AnyComponent; _CSSManager?: CSSManager; _viewInfo?: ViewInfo; _cssStyle: CSSStyle = {}; // RN style object with Reanimated CSS properties _componentRef: AnimatedComponentRef | HTMLElement | null = null; _componentDOMRef: HTMLElement | null = null; _willUnmount: boolean = false; _forwardedRefCleanup?: () => void; constructor(ChildComponent: AnyComponent, props: P) { super(props); this.ChildComponent = ChildComponent; } getComponentViewTag() { return this._getViewInfo().viewTag as number; } _onSetLocalRef() { // noop - can be overridden in subclasses } _getViewInfo(): ViewInfo { if (this._viewInfo !== undefined) { return this._viewInfo; } 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 Error( '[Reanimated] Cannot find host instance for this component. Maybe it renders nothing?' ); } const viewInfo = getViewInfo(hostInstance); const viewTag = viewInfo.viewTag ?? -1; const reactViewName = viewInfo.reactViewName; const shadowNodeWrapper = getShadowNodeWrapperFromRef( this as InternalHostInstance, hostInstance ); this._viewInfo = { viewTag, shadowNodeWrapper, reactViewName }; return this._viewInfo; } _setComponentRef = (ref: Component | HTMLElement) => { // Forward to user ref prop (if one has been specified) const forwardedRef = this.props.forwardedRef as Ref< Component | HTMLElement >; if (!ref) { // component has been unmounted if (this._forwardedRefCleanup) { this._forwardedRefCleanup(); this._forwardedRefCleanup = undefined; } else { assignRef(forwardedRef, null); } return; } this._forwardedRefCleanup = assignRef(forwardedRef, ref); if (ref !== this._componentRef) { this._componentRef = this._resolveComponentRef(ref); // if ref is changed, reset viewInfo this._viewInfo = undefined; } this._onSetLocalRef(); }; _resolveComponentRef = (ref: Component | HTMLElement | null) => { const componentRef = ref as AnimatedComponentRef; // 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) { return componentRef.getAnimatableRef(); } return componentRef; }; _updateStyles(props: P) { this._cssStyle = (StyleSheet.flatten( props.style as StyleProp ) ?? {}) as CSSStyle; } componentDidMount() { this._updateStyles(this.props); const viewTag = this._viewInfo?.viewTag; if (this._willUnmount && typeof viewTag === 'number') { unmarkNodeAsRemovable(viewTag); } this._CSSManager ??= new CSSManager( this._getViewInfo(), // `react-native-svg`'s web classes don't set `static displayName` // (only the native side does), so fall back to the class `name` which // matches the React `displayName` pattern used elsewhere. this.ChildComponent.displayName ?? this.ChildComponent.name ); this._CSSManager?.update(this._cssStyle, this.props); this._willUnmount = false; } componentWillUnmount() { if (this._CSSManager) { this._CSSManager.unmountCleanup(); } const wrapper = this._viewInfo?.shadowNodeWrapper; if (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: P) { this._updateStyles(nextProps); if (this._CSSManager) { this._CSSManager.update(this._cssStyle, nextProps); } // TODO - maybe check if the render is necessary instead of always returning true return true; } render(props?: ComponentProps) { const { ChildComponent } = this; const platformProps = Platform.select({ web: {}, default: { collapsable: false }, }); return ( void} /> ); } }