/** * Copyright (c) Meta Platforms, Inc. and affiliates. * * This source code is licensed under the MIT license found in the * LICENSE file in the root directory of this source tree. * * @flow * @format */ import type {PlatformConfig} from '../AnimatedPlatformConfig'; import {validateStyles} from '../../../src/private/animated/NativeAnimatedValidation'; import * as ReactNativeFeatureFlags from '../../../src/private/featureflags/ReactNativeFeatureFlags'; import flattenStyle from '../../StyleSheet/flattenStyle'; import Platform from '../../Utilities/Platform'; import AnimatedNode from './AnimatedNode'; import AnimatedObject from './AnimatedObject'; import AnimatedTransform from './AnimatedTransform'; import AnimatedWithChildren from './AnimatedWithChildren'; export type AnimatedStyleAllowlist = $ReadOnly<{[string]: true}>; function createAnimatedStyle( inputStyle: {[string]: mixed}, allowlist: ?AnimatedStyleAllowlist, keepUnanimatedValues: boolean, ): [$ReadOnlyArray, $ReadOnlyArray, {[string]: mixed}] { const nodeKeys: Array = []; const nodes: Array = []; const style: {[string]: mixed} = {}; const keys = Object.keys(inputStyle); for (let ii = 0, length = keys.length; ii < length; ii++) { const key = keys[ii]; const value = inputStyle[key]; if (allowlist == null || hasOwn(allowlist, key)) { let node; if (value != null && key === 'transform') { node = ReactNativeFeatureFlags.shouldUseAnimatedObjectForTransform() ? AnimatedObject.from(value) : // $FlowFixMe[incompatible-call] - `value` is mixed. AnimatedTransform.from(value); } else if (value instanceof AnimatedNode) { node = value; } else { node = AnimatedObject.from(value); } if (node == null) { if (keepUnanimatedValues) { style[key] = value; } } else { nodeKeys.push(key); nodes.push(node); style[key] = node; } } else { if (__DEV__) { // WARNING: This is a potentially expensive check that we should only // do in development. Without this check in development, it might be // difficult to identify which styles need to be allowlisted. if (AnimatedObject.from(inputStyle[key]) != null) { console.error( `AnimatedStyle: ${key} is not allowlisted for animation, but it ` + 'contains AnimatedNode values; styles allowing animation: ', allowlist, ); } } if (keepUnanimatedValues) { style[key] = value; } } } return [nodeKeys, nodes, style]; } export default class AnimatedStyle extends AnimatedWithChildren { #inputStyle: any; #nodeKeys: $ReadOnlyArray; #nodes: $ReadOnlyArray; #style: {[string]: mixed}; /** * Creates an `AnimatedStyle` if `value` contains `AnimatedNode` instances. * Otherwise, returns `null`. */ static from( inputStyle: any, allowlist: ?AnimatedStyleAllowlist, ): ?AnimatedStyle { const flatStyle = flattenStyle(inputStyle); if (flatStyle == null) { return null; } const [nodeKeys, nodes, style] = createAnimatedStyle( flatStyle, allowlist, Platform.OS !== 'web', ); if (nodes.length === 0) { return null; } return new AnimatedStyle(nodeKeys, nodes, style, inputStyle); } constructor( nodeKeys: $ReadOnlyArray, nodes: $ReadOnlyArray, style: {[string]: mixed}, inputStyle: any, ) { super(); this.#nodeKeys = nodeKeys; this.#nodes = nodes; this.#style = style; this.#inputStyle = inputStyle; } __getValue(): Object | Array { const style: {[string]: mixed} = {}; const keys = Object.keys(this.#style); for (let ii = 0, length = keys.length; ii < length; ii++) { const key = keys[ii]; const value = this.#style[key]; if (value instanceof AnimatedNode) { style[key] = value.__getValue(); } else { style[key] = value; } } /* $FlowFixMe[incompatible-type] Error found due to incomplete typing of * Platform.flow.js */ return Platform.OS === 'web' ? [this.#inputStyle, style] : style; } /** * Creates a new `style` object that contains the same style properties as * the supplied `staticStyle` object, except with animated nodes for any * style properties that were created by this `AnimatedStyle` instance. */ __getValueWithStaticStyle(staticStyle: Object): Object | Array { const flatStaticStyle = flattenStyle(staticStyle); const style: {[string]: mixed} = flatStaticStyle == null ? {} : flatStaticStyle === staticStyle ? // Copy the input style, since we'll mutate it below. {...flatStaticStyle} : // Reuse `flatStaticStyle` if it is a newly created object. flatStaticStyle; const keys = Object.keys(style); for (let ii = 0, length = keys.length; ii < length; ii++) { const key = keys[ii]; const maybeNode = this.#style[key]; if (key === 'transform' && maybeNode instanceof AnimatedTransform) { style[key] = maybeNode.__getValueWithStaticTransforms( // NOTE: This check should not be necessary, but the types are not // enforced as of this writing. Array.isArray(style[key]) ? style[key] : [], ); } else if (maybeNode instanceof AnimatedObject) { style[key] = maybeNode.__getValueWithStaticObject(style[key]); } else if (maybeNode instanceof AnimatedNode) { style[key] = maybeNode.__getValue(); } } /* $FlowFixMe[incompatible-type] Error found due to incomplete typing of * Platform.flow.js */ return Platform.OS === 'web' ? [this.#inputStyle, style] : style; } __getAnimatedValue(): Object { const style: {[string]: mixed} = {}; const nodeKeys = this.#nodeKeys; const nodes = this.#nodes; for (let ii = 0, length = nodes.length; ii < length; ii++) { const key = nodeKeys[ii]; const node = nodes[ii]; style[key] = node.__getAnimatedValue(); } return style; } __attach(): void { const nodes = this.#nodes; for (let ii = 0, length = nodes.length; ii < length; ii++) { const node = nodes[ii]; node.__addChild(this); } } __detach(): void { const nodes = this.#nodes; for (let ii = 0, length = nodes.length; ii < length; ii++) { const node = nodes[ii]; node.__removeChild(this); } super.__detach(); } __makeNative(platformConfig: ?PlatformConfig) { const nodes = this.#nodes; for (let ii = 0, length = nodes.length; ii < length; ii++) { const node = nodes[ii]; node.__makeNative(platformConfig); } super.__makeNative(platformConfig); } __getNativeConfig(): Object { const platformConfig = this.__getPlatformConfig(); const styleConfig: {[string]: ?number} = {}; const nodeKeys = this.#nodeKeys; const nodes = this.#nodes; for (let ii = 0, length = nodes.length; ii < length; ii++) { const key = nodeKeys[ii]; const node = nodes[ii]; node.__makeNative(platformConfig); styleConfig[key] = node.__getNativeTag(); } if (__DEV__) { validateStyles(styleConfig); } return { type: 'style', style: styleConfig, }; } } // Supported versions of JSC do not implement the newer Object.hasOwn. Remove // this shim when they do. // $FlowIgnore[method-unbinding] const _hasOwnProp = Object.prototype.hasOwnProperty; const hasOwn: (obj: $ReadOnly<{...}>, prop: string) => boolean = // $FlowIgnore[method-unbinding] Object.hasOwn ?? ((obj, prop) => _hasOwnProp.call(obj, prop));