Deprecate ImageBackground

[zoontek]

Summary:

Deprecates ImageBackground as part of the effort to keep core lean. It is a thin wrapper around a View and an Image, and can easily be replaced by composing a View with an absolutely positioned Image and layering children on top:

import type { ReactNode, Ref } from "react";
import {
  Image,
  StyleSheet,
  View,
  type ImageProps,
  type ViewProps,
} from "react-native";

type ImageBackgroundProps = Omit<ImageProps, "style"> & {
  children?: ReactNode;
  ref?: Ref<View>;
  style?: ViewProps["style"];
};

export const ImageBackground = ({
  children,
  importantForAccessibility,
  ref,
  style,
  ...props
}: ImageBackgroundProps) => {
  const { height, width } = StyleSheet.flatten(style);

  return (
    <View
      ref={ref}
      accessibilityIgnoresInvertColors={true}
      importantForAccessibility={importantForAccessibility}
      style={style}
    >
      <Image
        {...props}
        importantForAccessibility={importantForAccessibility}
        style={[StyleSheet.absoluteFill, { height, width }]}
      />
      {children}
    </View>
  );
};

Changelog:

[GENERAL] [DEPRECATED] - Deprecate ImageBackground, use a View with an absolutely positioned Image instead

Test Plan:

• deprecated shows a strikethrough on ImageBackground in editors.
• Importing/rendering ImageBackground logs the deprecation warning once.

[meta-codesync]

@cortinico has imported this pull request. If you are a Meta employee, you can view this in D110484567.