CompositionalLayoutDSL Documentation

Structures

Boundary​Supplementary​Item

An object used to add headers or footers to a collection view.

Compositional​Layout

An object that completely represent a compositional layout.

Configuration

An object that defines scroll direction, section spacing, and headers or footers for the layout.

Decoration​Item

An object used to add a background to a section of a collection view.

Custom​Group

A customizable container for a set of items.

HGroup

A container for a set of items that lays out the items horizontally.

VGroup

A container for a set of items that lays out the items vertically.

Item

The most basic component of a collection view's layout.

List​Section
Raw​Section

A container to allow usage of NSCollectionLayoutSection with this library

Section

A container that combines a set of groups into distinct visual groupings.

Supplementary​Item

An object used to add an extra visual decoration, such as a badge or a frame, to an item in a collection view.

Enumerations

Supplementary​Item.​Anchor​Offset
List​Result​Builder

A custom parameter attribute that constructs list of Element from closures.

Protocols

Layout​Boundary​Supplementary​Item

A type that represents a boundary supplementary item in a compositional layout and provides modifiers to configure boundary supplementary items.

Layout​Configuration

A type that represents a compositional layout configuration and provides modifiers to change the configuration.

Layout​Decoration​Item

A type that represents a decoration item in a compositional layout and provides modifiers to configure decoration items.

Layout​Group

A type that represents a group in a compositional layout and provides modifiers to configure groups.

Layout​Item

A type that represents an item in a compositional layout and provides modifiers to configure items.

Resizable​Item
Layout​Section

A type that represents a section in a compositional layout and provides modifiers to configure sections.

Layout​Supplementary​Item

A type that represents a supplementary item in a compositional layout and provides modifiers to configure supplementary items.

Typealiases

Layout​Item​Builder
Layout​Boundary​Supplementary​Item​Builder
Layout​Supplementary​Item​Builder
Layout​Decoration​Item​Builder

Functions

Layout​Section​Builder(layout​Section:​)

Converts a layout section into a NSCollectionLayoutSection

Layout​Builder(configuration:​layout​Section:​)

Converts a layout configuration and a layout section into an NSCollectionViewCompositionalLayout

Layout​Builder(configuration:​layout​Section:​)

Converts a layout configuration and a layout section into a UICollectionViewCompositionalLayout

Layout​Builder(compositional​Layout:​)

Converts a compositionalLayout into an NSCollectionViewCompositionalLayout

Layout​Builder(compositional​Layout:​)

Converts a compositionalLayout into a UICollectionViewCompositionalLayout