% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/block-meta.R
\name{block_metadata}
\alias{block_metadata}
\alias{block_meta_id}
\alias{block_meta_name}
\alias{block_meta_description}
\alias{block_meta_details}
\alias{block_meta_link}
\alias{block_meta_guidance}
\alias{block_meta_category}
\alias{block_meta_icon}
\alias{block_meta_package}
\alias{block_meta_keywords}
\alias{block_meta_arguments}
\alias{block_meta_examples}
\title{Block metadata}
\usage{
block_metadata(x, fields = "all", ...)

block_meta_id(x, ...)

block_meta_name(x, ...)

block_meta_description(x, ...)

block_meta_details(x, ...)

block_meta_link(x, ...)

block_meta_guidance(x, ...)

block_meta_category(x, ...)

block_meta_icon(x, ...)

block_meta_package(x, ...)

block_meta_keywords(x, ...)

block_meta_arguments(x, ...)

block_meta_examples(x, ...)
}
\arguments{
\item{x}{A \code{block}, a \code{blocks} collection, a \code{block_registry_entry} or a
registry ID}

\item{fields}{Metadata fields to include (defaults to \code{"all"})}

\item{...}{Generic consistency, passed on to methods}
}
\value{
\code{block_metadata()} returns a \code{data.frame}. The \verb{block_meta_*()}
getters return the named attribute: a string (or \code{NA}) for scalar fields, a
character vector for \code{block_meta_keywords()}, a \code{block_args} object for
\code{block_meta_arguments()}, and a list of worked configurations for
\code{block_meta_examples()}.
}
\description{
Registry metadata for blocks is available both as a tabular overview and via
per-attribute accessors. \code{block_metadata()} returns a \code{data.frame} with one
row per block -- dispatching on a \code{block}, a \code{blocks} collection, a
\code{block_registry_entry} or a registry ID -- where scalar attributes are
atomic columns and the multi-valued ones (\code{arguments}, \code{examples},
\code{keywords}) are list-columns. The \code{fields} argument selects a subset of
columns. Each attribute additionally has a dedicated getter
(\code{block_meta_name()}, \code{block_meta_guidance()}, ...) returning that attribute
for a single block. Missing fields are filled with display defaults in the
data.frame; the getters instead return the stored value (or \code{NA} / an empty
value).
}
