android_resource
android_resource
def android_resource(
*,
name: str,
default_target_platform: None | str = None,
target_compatible_with: list[str] = [],
compatible_with: list[str] = [],
exec_compatible_with: list[str] = [],
visibility: list[str] = [],
within_view: list[str] = ["PUBLIC"],
metadata: OpaqueMetadata = {},
tests: list[str] = [],
modifiers: OpaqueMetadata = [],
_android_toolchain: str = "gh_facebook_buck2_shims_meta//:android",
_apple_platforms: dict[str, str] = {},
_build_only_native_code: bool = select({"prelude//android/constraints:build_only_native_code": True, "DEFAULT": False}),
_java_toolchain: str = "gh_facebook_buck2_shims_meta//:java_for_android",
allowlisted_locales: None | list[str] = None,
assets: None | str | dict[str, str] = None,
contacts: list[str] = [],
default_host_platform: None | str = None,
deps: list[str] = [],
has_whitelisted_strings: bool = False,
labels: list[str] = [],
licenses: list[str] = [],
manifest: None | str = None,
package: None | str = None,
project_assets: None | str = None,
project_res: None | str = None,
res: None | str | dict[str, str] = None,
resource_union: bool = False,
) -> None
An android_resource()
rule is used to bundle Android resources that are traditionally stored in res
and assets
directories.
Parameters
name
: name of the targetdefault_target_platform
: specifies the default target platform, used when no platforms are specified on the command linetarget_compatible_with
: a list of constraints that are required to be satisfied for this target to be compatible with a configurationcompatible_with
: a list of constraints that are required to be satisfied for this target to be compatible with a configurationexec_compatible_with
: a list of constraints that are required to be satisfied for this target to be compatible with an execution platformvisibility
: a list of visibility patterns restricting what targets can depend on this onewithin_view
: a list of visibility patterns restricting what this target can depend onmetadata
: a key-value map of metadata associated with this targettests
: a list of targets that provide tests for this onemodifiers
: an array of modifiers associated with this targetdeps
: Otherandroid_resource
rules to include via-S
when runningaapt
.manifest
: An optional Android Manifest for the to declare any permissions or intents it may need or want to handle. May either be a file or anandroid_manifest()
target.package
: Java package for theR.java
file that will be generated for these resources.
Details
The output of an android_resource()
is an R.txt
file
generated via aapt --output-text-symbols
.
Examples:
Most of the time, an android_resource
rule defines only name
, res
, and package
. By convention,
such simple rules are often named res
:
android_resource(
name = 'res',
res = subdir_glob([('res', '**')]),
package = 'com.example',
)