brand_pluck: Extract a nested element from a brand object

In brand.yml: Unified Branding with a Simple YAML File

Extract a nested element from a brand object

Description

Safely extracts a nested element from a brand object using the provided key path. Returns NULL if the element doesn't exist.

Usage

brand_pluck(brand, ...)

Arguments

brand	A brand object created by read_brand_yml() or as_brand_yml().
...	One or more character strings or symbols representing the path to the nested element.

Value

The value of the nested element if it exists, NULL otherwise.

See Also

Other brand.yml helpers: brand_color_pluck(), brand_has(), with_brand_yml_path()

Examples

brand <- as_brand_yml(list(
  meta = list(name = "Example Brand"),
  color = list(primary = "#FF5733")
))

# Extract the primary color
brand_pluck(brand, "color", "primary") # "#FF5733"

# Try to extract a non-existent element
brand_pluck(brand, "color", "secondary") # NULL

brand.yml documentation built on Nov. 6, 2025, 5:06 p.m.