mirror of
https://github.com/facebook/react-native.git
synced 2026-11-18 20:19:07 +00:00
(Redo D108193641) remove useNativeDriver under featureflag animatedForceNativeDriver" (#57250)
Summary: Pull Request resolved: https://github.com/react/react-native/pull/57250 ## Changelog: [General] [Added] - remove `useNativeDriver` under featureflag animatedForceNativeDriver When `animatedForceNativeDriver` is enabled, it forces `useNativeDriver` to `true` for all Animated animations and events, overriding the config (explicit `false` set by user will be no-op). Has no effect unless the shared animated backend is enabled, which is required to support native driver for all props. When calling `NativeAnimatedHelper.isNativeDriverForced`, do null check first for backward compatibility in rn-macos Also using this flag to gate the js animation logic that could be cleaned up when this path is fully working. Reviewed By: javache, bmsdave Differential Revision: D108880837 fbshipit-source-id: 2a061ddef3aa49893b88d81caa7f1fdbf28f7842
This commit is contained in:
1 parent
fe53279889
commit
9cf30b6e4b
10 files changed
+155
-7
No files matched your search
@@ -20,6 +20,7 @@ import type {DecayAnimationConfig} from './animations/DecayAnimation';
|
||||
import type {SpringAnimationConfig} from './animations/SpringAnimation';
|
||||
import type {TimingAnimationConfig} from './animations/TimingAnimation';
|
||||
|
||||
import NativeAnimatedHelper from '../../src/private/animated/NativeAnimatedHelper';
|
||||
import {AnimatedEvent, attachNativeEventImpl} from './AnimatedEvent';
|
||||
import DecayAnimation from './animations/DecayAnimation';
|
||||
import SpringAnimation from './animations/SpringAnimation';
|
||||
@@ -200,7 +201,11 @@ const springImpl = function (
|
||||
},
|
||||
|
||||
_isUsingNativeDriver: function (): boolean {
|
||||
return config.useNativeDriver || false;
|
||||
return (
|
||||
NativeAnimatedHelper.isNativeDriverForced?.() ||
|
||||
config.useNativeDriver ||
|
||||
false
|
||||
);
|
||||
},
|
||||
}
|
||||
);
|
||||
@@ -254,7 +259,11 @@ const timingImpl = function (
|
||||
},
|
||||
|
||||
_isUsingNativeDriver: function (): boolean {
|
||||
return config.useNativeDriver || false;
|
||||
return (
|
||||
NativeAnimatedHelper.isNativeDriverForced?.() ||
|
||||
config.useNativeDriver ||
|
||||
false
|
||||
);
|
||||
},
|
||||
}
|
||||
);
|
||||
@@ -296,7 +305,11 @@ const decayImpl = function (
|
||||
},
|
||||
|
||||
_isUsingNativeDriver: function (): boolean {
|
||||
return config.useNativeDriver || false;
|
||||
return (
|
||||
NativeAnimatedHelper.isNativeDriverForced?.() ||
|
||||
config.useNativeDriver ||
|
||||
false
|
||||
);
|
||||
},
|
||||
}
|
||||
);
|
||||
|
||||
@@ -78,6 +78,42 @@ const SUPPORTED_STYLES: {[string]: true} = {
|
||||
top: true,
|
||||
/* flex */
|
||||
flex: true,
|
||||
flexGrow: true,
|
||||
flexShrink: true,
|
||||
flexBasis: true,
|
||||
aspectRatio: true,
|
||||
/* margin */
|
||||
margin: true,
|
||||
marginLeft: true,
|
||||
marginRight: true,
|
||||
marginTop: true,
|
||||
marginBottom: true,
|
||||
marginStart: true,
|
||||
marginEnd: true,
|
||||
marginHorizontal: true,
|
||||
marginVertical: true,
|
||||
/* padding */
|
||||
padding: true,
|
||||
paddingLeft: true,
|
||||
paddingRight: true,
|
||||
paddingTop: true,
|
||||
paddingBottom: true,
|
||||
paddingStart: true,
|
||||
paddingEnd: true,
|
||||
paddingHorizontal: true,
|
||||
paddingVertical: true,
|
||||
/* border width */
|
||||
borderWidth: true,
|
||||
borderLeftWidth: true,
|
||||
borderRightWidth: true,
|
||||
borderTopWidth: true,
|
||||
borderBottomWidth: true,
|
||||
borderStartWidth: true,
|
||||
borderEndWidth: true,
|
||||
/* gap */
|
||||
gap: true,
|
||||
rowGap: true,
|
||||
columnGap: true,
|
||||
}
|
||||
: {}),
|
||||
};
|
||||
|
||||
@@ -21,6 +21,65 @@ import {Animated, View, useAnimatedValue} from 'react-native';
|
||||
import {allowStyleProp} from 'react-native/Libraries/Animated/NativeAnimatedAllowlist';
|
||||
import ReactNativeElement from 'react-native/src/private/webapis/dom/nodes/ReactNativeElement';
|
||||
|
||||
// marginLeft (and the other margin props) are only on the native animated
|
||||
// allowlist when the shared backend is enabled. This test deliberately does NOT
|
||||
// call allowStyleProp('marginLeft') — it verifies the prop is supported natively
|
||||
// out of the box under useSharedAnimatedBackend.
|
||||
test('animate marginLeft layout prop', () => {
|
||||
const viewRef = createRef<HostInstance>();
|
||||
|
||||
let _animatedMarginLeft;
|
||||
let _marginLeftAnimation;
|
||||
|
||||
function MyApp() {
|
||||
const animatedMarginLeft = useAnimatedValue(0);
|
||||
_animatedMarginLeft = animatedMarginLeft;
|
||||
return (
|
||||
<Animated.View
|
||||
ref={viewRef}
|
||||
style={[
|
||||
{
|
||||
width: 100,
|
||||
height: 100,
|
||||
marginLeft: animatedMarginLeft,
|
||||
},
|
||||
]}
|
||||
/>
|
||||
);
|
||||
}
|
||||
|
||||
const root = Fantom.createRoot();
|
||||
|
||||
Fantom.runTask(() => {
|
||||
root.render(<MyApp />);
|
||||
});
|
||||
|
||||
Fantom.runTask(() => {
|
||||
_marginLeftAnimation = Animated.timing(_animatedMarginLeft, {
|
||||
toValue: 100,
|
||||
duration: 200,
|
||||
useNativeDriver: true,
|
||||
}).start();
|
||||
});
|
||||
|
||||
Fantom.unstable_produceFramesForDuration(100);
|
||||
|
||||
expect(root.getRenderedOutput({props: ['marginLeft']}).toJSX()).toEqual(
|
||||
<rn-view marginLeft="50" />,
|
||||
);
|
||||
|
||||
Fantom.unstable_produceFramesForDuration(100);
|
||||
|
||||
// TODO: this shouldn't be necessary since animation should be stopped after duration
|
||||
Fantom.runTask(() => {
|
||||
_marginLeftAnimation?.stop();
|
||||
});
|
||||
|
||||
expect(root.getRenderedOutput({props: ['marginLeft']}).toJSX()).toEqual(
|
||||
<rn-view marginLeft="100" />,
|
||||
);
|
||||
});
|
||||
|
||||
test('animated opacity', () => {
|
||||
let _opacity;
|
||||
let _opacityAnimation;
|
||||
|
||||
@@ -70,6 +70,7 @@ export default class Animation {
|
||||
previousAnimation: ?Animation,
|
||||
animatedValue: AnimatedValue,
|
||||
): void {
|
||||
// TODO: T274006331 - Remove js-only animation once shared backend is fully rolled out
|
||||
if (!this._useNativeDriver && animatedValue.__isNative === true) {
|
||||
throw new Error(
|
||||
'Attempting to run JS driven animation on animated node ' +
|
||||
|
||||
@@ -85,6 +85,7 @@ export default class DecayAnimation extends Animation {
|
||||
this._startTime = Date.now();
|
||||
|
||||
const useNativeDriver = this.__startAnimationIfNative(animatedValue);
|
||||
// TODO: T274006331 - Remove js-only animation once shared backend is fully rolled out
|
||||
if (!useNativeDriver) {
|
||||
this._animationFrame = requestAnimationFrame(() => this.onUpdate());
|
||||
}
|
||||
|
||||
@@ -225,6 +225,7 @@ export default class SpringAnimation extends Animation {
|
||||
|
||||
const start = () => {
|
||||
const useNativeDriver = this.__startAnimationIfNative(animatedValue);
|
||||
// TODO: T274006331 - Remove js-only animation once shared backend is fully rolled out
|
||||
if (!useNativeDriver) {
|
||||
this.onUpdate();
|
||||
}
|
||||
|
||||
@@ -129,6 +129,7 @@ export default class TimingAnimation extends Animation {
|
||||
this._startTime = Date.now();
|
||||
|
||||
const useNativeDriver = this.__startAnimationIfNative(animatedValue);
|
||||
// TODO: T274006331 - Remove js-only animation once shared backend is fully rolled out
|
||||
if (!useNativeDriver) {
|
||||
// Animations that sometimes have 0 duration and sometimes do not
|
||||
// still need to use the native driver when duration is 0 so as to
|
||||
|
||||
@@ -959,6 +959,17 @@ const definitions: FeatureFlagDefinitions = {
|
||||
},
|
||||
ossReleaseStage: 'none',
|
||||
},
|
||||
animatedForceNativeDriver: {
|
||||
defaultValue: false,
|
||||
metadata: {
|
||||
dateAdded: '2026-06-10',
|
||||
description:
|
||||
'When enabled, forces `useNativeDriver` to `true` for all Animated animations and events, overriding the config (including an explicit `false`). Has no effect unless the shared animated backend is enabled, which is required to support native driver for all props.',
|
||||
expectedReleaseValue: true,
|
||||
purpose: 'experimentation',
|
||||
},
|
||||
ossReleaseStage: 'none',
|
||||
},
|
||||
animatedShouldDebounceQueueFlush: {
|
||||
defaultValue: false,
|
||||
metadata: {
|
||||
|
||||
@@ -417,17 +417,35 @@ function assertNativeAnimatedModule(): void {
|
||||
|
||||
let _warnedMissingNativeAnimated = false;
|
||||
|
||||
// Whether the native driver should be forced on for every animation, overriding
|
||||
// the config (including an explicit `useNativeDriver: false`). This is only safe
|
||||
// when the shared animated backend is enabled — that backend is what makes every
|
||||
// prop drivable natively. Forcing native without it would break animations of
|
||||
// props the legacy native driver doesn't support.
|
||||
function isNativeDriverForced(): boolean {
|
||||
return (
|
||||
ReactNativeFeatureFlags.animatedForceNativeDriver() &&
|
||||
ReactNativeFeatureFlags.cxxNativeAnimatedEnabled() &&
|
||||
// eslint-disable-next-line
|
||||
ReactNativeFeatureFlags.useSharedAnimatedBackend()
|
||||
);
|
||||
}
|
||||
|
||||
function shouldUseNativeDriver(
|
||||
config: Readonly<{...AnimationConfig, ...}> | EventConfig<unknown>,
|
||||
): boolean {
|
||||
if (config.useNativeDriver == null) {
|
||||
const forceNativeDriver = isNativeDriverForced();
|
||||
|
||||
if (config.useNativeDriver == null && !forceNativeDriver) {
|
||||
console.warn(
|
||||
'Animated: `useNativeDriver` was not specified. This is a required ' +
|
||||
'option and must be explicitly set to `true` or `false`',
|
||||
);
|
||||
}
|
||||
|
||||
if (config.useNativeDriver === true && !NativeAnimatedModule) {
|
||||
const useNativeDriver = forceNativeDriver || config.useNativeDriver === true;
|
||||
|
||||
if (useNativeDriver === true && !NativeAnimatedModule) {
|
||||
if (process.env.NODE_ENV !== 'test') {
|
||||
if (!_warnedMissingNativeAnimated) {
|
||||
console.warn(
|
||||
@@ -443,7 +461,7 @@ function shouldUseNativeDriver(
|
||||
return false;
|
||||
}
|
||||
|
||||
return config.useNativeDriver || false;
|
||||
return useNativeDriver;
|
||||
}
|
||||
|
||||
function transformDataType(value: number | string): number | string {
|
||||
@@ -469,6 +487,7 @@ export default {
|
||||
assertNativeAnimatedModule,
|
||||
generateNewAnimationId,
|
||||
generateNewNodeTag,
|
||||
isNativeDriverForced,
|
||||
// $FlowExpectedError[unsafe-getters-setters] - unsafe getter lint suppression
|
||||
// $FlowExpectedError[missing-type-arg] - unsafe getter lint suppression
|
||||
get nativeEventEmitter(): NativeEventEmitter {
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
* This source code is licensed under the MIT license found in the
|
||||
* LICENSE file in the root directory of this source tree.
|
||||
*
|
||||
* @generated SignedSource<<9665e3af57529f1b50d02c79e7a869eb>>
|
||||
* @generated SignedSource<<68e9dbd18bfcb5e7d5cad27d8663ce66>>
|
||||
* @flow strict
|
||||
* @noformat
|
||||
*/
|
||||
@@ -30,6 +30,7 @@ import {
|
||||
export type ReactNativeFeatureFlagsJsOnly = Readonly<{
|
||||
jsOnlyTestFlag: Getter<boolean>,
|
||||
animatedDeferStartOfTimingAnimations: Getter<boolean>,
|
||||
animatedForceNativeDriver: Getter<boolean>,
|
||||
animatedShouldDebounceQueueFlush: Getter<boolean>,
|
||||
animatedShouldSyncValueBeforeStartCallback: Getter<boolean>,
|
||||
animatedShouldUseSingleOp: Getter<boolean>,
|
||||
@@ -145,6 +146,11 @@ export const jsOnlyTestFlag: Getter<boolean> = createJavaScriptFlagGetter('jsOnl
|
||||
*/
|
||||
export const animatedDeferStartOfTimingAnimations: Getter<boolean> = createJavaScriptFlagGetter('animatedDeferStartOfTimingAnimations', false);
|
||||
|
||||
/**
|
||||
* When enabled, forces `useNativeDriver` to `true` for all Animated animations and events, overriding the config (including an explicit `false`). Has no effect unless the shared animated backend is enabled, which is required to support native driver for all props.
|
||||
*/
|
||||
export const animatedForceNativeDriver: Getter<boolean> = createJavaScriptFlagGetter('animatedForceNativeDriver', false);
|
||||
|
||||
/**
|
||||
* Enables an experimental flush-queue debouncing in Animated.js.
|
||||
*/
|
||||
|
||||
Reference in new issue
Block a user