Structure

ItemsRenderingContext

struct ItemsRenderingContext<M> where M : Metadata

The rendering context passed to a listWriter(_:output:paginate:paginatedOutput:) renderer.

Contains all items from the processing step, optionally paginated.

Instance Properties

let allItems: [any AnyItem]

All items across all registered processing steps. When i18n is configured, this only contains items for the current locale.

let items: [Item<M>]

All items from the same processing step (or the current page’s slice when paginated), in sorted order.

let locale: SagaLocale?

The locale of this rendering context, or nil when i18n is not configured.

let outputPath: Path

The output path of the page being rendered.

let paginator: Paginator?

Pagination information, or nil if the writer is not paginated.

let subfolder: Path?

The subfolder name when using nested:. Nil otherwise.

let translations: [SagaLocale : String]

URLs for this page in other locales.

Instance Methods

func asDictionary() -> [String : Any]

Relationships

Conforms To

AtomContext , DictRenderingContext , Swift.Copyable , Swift.Sendable