Back to Facebook Developer Docs

@react-native/assets-registry

packages/assets-registry/README.md

0.87.02.1 KB
Original Source

@react-native/assets-registry

[!Warning] This package is deprecated (since 0.87) and will be removed in a future release. Use AssetRegistry from react-native (or the react-native/asset-registry build entry point) instead of @react-native/assets-registry/registry, and @react-native/asset-utils instead of @react-native/assets-registry/path-support.

Runtime registry that maps asset IDs generated in a Metro bundle to asset metadata. It backs <Image>, Image.resolveAssetSource(), and any code that resolves require('./img.png') on native.

Most apps never import this directly — assets are handled through <Image>.

API

@react-native/assets-registry/registry (DEPRECATED)

[!Warning] Deprecated: Aliases to AssetRegistry (since 0.87).

Please use:

  • import { AssetRegistry } from 'react-native'; (apps/library code)
  • 'react-native/asset-registry' (entrypoint for Metro/build configs)
ExportSignatureNotes
registerAsset(asset: PackagerAsset) => numberStores the asset; returns a numeric ID
getAssetByID(assetId: number) => PackagerAssetLooks an asset back up by ID

@react-native/assets-registry/path-support (DEPRECATED)

[!Warning] Deprecated: Use @react-native/asset-utils (since 0.87).

Android resource-path helpers, used when copying assets into drawable-* folders.

ExportSignatureNotes
getAndroidResourceFolderName(asset: PackagerAsset, scale: number) => stringe.g. drawable-xhdpi; non-drawable types resolve to raw
getAndroidResourceIdentifier(asset: PackagerAsset) => stringSanitised resource name
getBasePath(asset: PackagerAsset) => stringhttpServerLocation without the leading slash