Language
Items are the main building blocks that make up a section. Each type of item is presented differently and has slightly different properties and functionality.
The Support Content type has been deprecated. With the release of our enhanced customization feature set in early 2026, all support content items were migrated to the asset type with downloads disabled, full width display and metadata hidden. See display
Shared Item Properties
uuid
string
The unique identifier of the item.
type
string
The type of the item.
sectionUuid
string
The unique identifier of the section the item belongs to.
displayOrder
number
The order of the item in the section.
shortId
string
A short, URL-friendly identifier for the item.
version
number
The version number the item belongs to.
kitUuid
string
The unique identifier of the kit the item belongs to.
data
object
Type-specific data for the item.
status
string
The status of the item: active, trashed, or deleted.
displayProperties
object
Display customization settings for the item. Available on spaces with enhanced customization.
Display Properties
showMetadata
boolean
If the metadata is shown in the lingo app. Default true
imageAlignment
top | leading | trailing
The layout of the image and text content in the lingo app. Default top
allowDownload
boolean
Whether the asset can be downloaded. Default: true
caption
string
A text caption to display along side the asset. Default null
cardBackgroundColor
string
A color to display for the entire content block in lingo
size
number (1-6)
The size the content block should be display at. The number of assets across at dekstop size. 1 = full width, 6 = 6 across. Default 5.
autoplay
boolean
For motion assets only. If the video should play. Default: false.
displayStyle
image | text_only
For guides, this determines if the guide should present an image or be text only.
Items with type heading are used to create hierarchy in a section. They are included in the kit outline and displayed in the kit navigation panel in the Lingo app.
Heading Properties
data.content
string
The string value for the heading.
Create a heading item in a given section. The new item will be appended to the end of the section.
Typescript
const item = await lingo.createHeading("My Heading", {
kitUuid: "kit-id",
sectionUuid: "section-id",
});
console.log(`Created heading ${item.data.content}`);
Arguments
text
string • required
The text content for the heading.
data.kitUuid
string • required
The kit uuid. This must match the kit of the section.
data.sectionUuid
string • required
The section uuid to add the heading to.
data.displayOrder
string | number
The relative position of the item in the section. (Default append)
Items with type note are used to add text content along side your other content. The text content of a note can contain formatting which is a subset of standard markdown.
Inline Note Properties
data.content
string
The string value for the note.
Create a note item in a given section. The new item will be appended to the end of the section.
Typescript
const item = await lingo.createNote("Welcome to our brand kit", {
kitUuid: "kit-id",
sectionUuid: "section-id",
});
console.log(`Created note with message: ${item.data.content}`);
Arguments
text
string • required
The text content for the note. This can contain markdown formatting.
data.kitUuid
string • required
The kit uuid. This must match the kit of the section.
data.sectionUuid
string • required
The section uuid to add the note to.
data.displayOrder
string | number
The relative position of the item in the section. (Default append)
Items with type guide are used to provide guidance about how content should be used. Guides can be a do or a don't and can be text only or include an image.
For guides that have an image, the image is stored as an asset however these assets can only be of type: PNG or JPG and they are not included in the library.
Guide properties
data.title
string
The "Do" or "Don't" title.
data.color
string
The color of the guide. "red" or "green".
data.content
string
The text content for the guide.
assetId
string
The id of the asset used for the guide image, if any.
asset
Asset
The asset used for the guide image, if any.
Create a guide item in a given section. The new item will be appended to the end of the section.
Typescript
const item = await lingo.createGuide(
{
title: "Do",
text: "Keep accessibility in mind.",
},
{
kitUuid: "kit-id",
sectionUuid: "section-id",
}
);
console.log(`Created ${item.data.title} guide`);
Arguments
content.title
Do | Don't • required
The title of the guide. `Do` or `Don't`
content.text
string • required
The text content of the guide.
content.file
string
A filepath to a JPG or PNG file. If provided, guide displays with an image.
data.kitUuid
string • required
The kit uuid. This must match the kit of the section.
data.sectionUuid
string • required
The section uuid to add the guide to.
data.displayOrder
string | number
The relative position of the item in the section. (Default append)
Items with type code_snippet render code in Lingo. They can contain any text content but also support syntax highlighting and an option to copy the text.
Code Snippet Item.data Properties
data.content
string
The string value for the code.
data.codeLanguage
string
The coding language for syntax highlighting
Create a code snippet item in a given section. The new item will be appended to the end of the section.
Typescript
const item = await lingo.createCodeSnippet(
{
text: "const foo = 'bar'",
language: "javascript",
},
{
kitUuid: "kit-id",
sectionUuid: "section-id",
}
);
Arguments
content.text
string • required
The code content for the snippet.
content.language
string
The coding language for syntax highlighting. (Default auto)
data.kitUuid
string • required
The kit uuid. This must match the kit of the section.
data.sectionUuid
string • required
The section uuid to add the code snippet to.
data.displayOrder
string | number
The relative position of the item in the section. (Default append)
Items with type gallery are used to group assets together. There are two types of galleries: manual galleries where you select assets yourself, and dynamic galleries that automatically populate from a saved library view.
Gallery Properties
data.name
string
The name of the gallery. Used for manual galleries.
data.viewId
number
The id of the saved library view. Used for dynamic galleries.
data.viewName
string
The name of the saved library view. Used for dynamic galleries.
data.assets
number
The number of assets in the gallery.
data.itemProcessing
string
The processing status for dynamic galleries. 'pending' while assets are being gathered, 'complete' when done.
Fetch items inside a gallery. For large galleries you can paginate through results, or use fetchAllItemsInGallery to automatically retrieve all items.
Typescript
// Fetch a single page of items
const items = await lingo.fetchItemsInGallery("gallery-id", 0, 1, 50);
// Fetch all items (auto-paginates)
const allItems = await lingo.fetchAllItemsInGallery("gallery-id");
fetchItemsInGallery Arguments
galleryId
string • required
The uuid of the gallery item.
version
number
The version number of the kit. (Default 0 for latest)
page
number
The page of results to fetch. (Default 1)
limit
number
The max number of items per page. (Default 50)
fetchAllItemsInGallery Arguments
galleryId
string • required
The uuid of the gallery item.
version
number
The version number of the kit. (Default 0 for latest)
Create a gallery item in a given section. You can create either a manual gallery by providing a name, or a dynamic gallery by providing a viewId.
Typescript
// Create a manual gallery
const item = await lingo.createManualGallery("Brand Logos", {
kitUuid: "kit-id",
sectionUuid: "section-id",
});
// Create a dynamic gallery from a saved view
const item = await lingo.createDynamicGallery(42, {
kitUuid: "kit-id",
sectionUuid: "section-id",
});
createManualGallery Arguments
name
string • required
The name of the gallery.
data.kitUuid
string • required
The kit uuid. This must match the kit of the section.
data.sectionUuid
string • required
The section uuid to add the gallery to.
data.displayOrder
string | number
The relative position of the item in the section. (Default append)
createDynamicGallery Arguments
viewId
number • required
The id of a saved library view.
data.kitUuid
string • required
The kit uuid. This must match the kit of the section.
data.sectionUuid
string • required
The section uuid to add the gallery to.
data.displayOrder
string | number
The relative position of the item in the section. (Default append)
Assets can be created directly within galleries. The functions are similar to creating assets in sections, just swap the section for a the id of the parent gallery item.
To add assets to a manual gallery, use any of the asset creation functions (createFileAsset, createColorAsset, or createLinkAsset) and pass a galleryUuid instead of sectionUuid in the item data. The kitUuid is still required.
Typescript
// Upload a file asset into a gallery
const { item, asset } = await lingo.createFileAsset(
"/path/to/logo.png",
{ name: "Primary Logo" },
{
kitUuid: "kit-id",
galleryUuid: "gallery-id",
}
);
// Add a color asset to a gallery
const { item, asset } = await lingo.createColorAsset(
"#FF5733",
{ name: "Brand Red" },
{
kitUuid: "kit-id",
galleryUuid: "gallery-id",
}
);
// Add a link asset to a gallery
const { item, asset } = await lingo.createLinkAsset(
"https://example.com",
{ name: "Website" },
{
kitUuid: "kit-id",
galleryUuid: "gallery-id",
}
);
Only asset items can be added to galleries. Other item types (headings, notes, guides, code snippets) can only be created in sections.
Items with type asset are used to reference assets from your library. Items simply place assets into kits.
For more details about assets, see the section.
Asset Item Properties
assetId
string
The unique identifier of the related asset.
asset
Asset
The asset object referenced by this item.