Skip to navigation

Design libraries

A design library is a collection of reusable experience templates, components, design tokens, content types, data assemblies (binding configurations) and editor interfaces that can be shared across spaces and environments.

This feature is currently available only on specific plans. For more information, reach out to your Sales representative.

How items are included

When creating a design library, supply a source environment and a taxonomy concept ID in basedOn. The concept identifies which items to include when creating a version.

Items selected by taxonomy

The version includes components, design tokens and experience templates assigned that concept in the source environment.

Associated items

The version also includes:

  • Data assemblies used by those components and experience templates, including data assemblies used within other data assemblies.
  • Content types used by those data assemblies, together with their editor interfaces, when includeLinkedContentTypes is set to true.

These associated items do not need the taxonomy concept assigned to them.

Creating a design library saves these selection settings. Items are copied when you create a version.

Design library

List design libraries

Create a design library

Get a design library

Update a design library

Delete a design library

Versions

A version is an immutable snapshot of a design library’s items.

Versions

Installations

An installation tracks the application of a design library version to a target environment.

Installations

Limits

LimitMaximum
Items per version1,000 unique fetched items across all item types.
Library or version name256 characters.
Library or version description1,000 characters.
Versions being createdOne per library with status created or in_progress.
Concurrent installations100 per target organisation across all spaces, environments and libraries.
Results per list page100 items.

The version item limit includes derived content types and data assemblies.

The concurrent installation limit counts installations with status created or in_progress. Capacity becomes available when an installation succeeds or fails. See Concurrent installation limit for how to handle capacity errors.

Pagination

List operations use cursor pagination.