PageListItemSettings | Quail Pages

Documentation

Page-owned presentation settings used when a page is represented by PageList. PageListItemSettings is not a standalone Element, Card, or PageCard. It belongs to the owning PageDocument and affects only that page's generated PageList representation. It allows a page to present differently inside a PageList without changing the page's normal presentation. Omitted values fall back to the page's normal content or the owning PageList's defaults according to PageList's existing precedence rules.

Kind

Supporting Object

Required fields

None

Used by

PageDocument

Properties

badge

string | null

Overrides the badge shown on generated PageList cards. When omitted or undefined, the page author is used as the default badge. Set to null or an empty string to suppress the default badge.

ctaText

string

Action label shown instead of the owning PageList's ctaText default.

description

string

Summary shown instead of the page description in generated PageList cards.

image

Image

Image shown instead of the page hero in generated PageList cards.

subtitle

string

Subtitle shown for this page in generated PageList cards.

Example

Required

{}

Full

{ "badge": "example", "ctaText": "example", "description": "A representative Quail Pages example used to demonstrate this authored JSON contract in generated documentation.", "image": { "alt": "The Acme team working together", "aspectRatio": "16:9", "badge": "example", "caption": { "credit": "example", "subtitle": "example", "title": "Example" }, "centerOffset": { "x": 50, "y": 40 }, "class": "example", "fetchPriority": "high", "lightbox": false, "link": { "href": "/example", "newTab": false, "nofollow": false, "sponsored": false }, "loading": "lazy", "maxWidth": 0, "src": "/images/team.jpg", "width": 0 }, "subtitle": "example" }

examples are generated from the schema.