Places›Itinerary

places

Itinerary

Day-by-day travel itineraries with timed stops and locations

Install

  1. Add the package: npm install @refrakt-md/places
  2. Add it to the plugins array in refrakt.config.json: "plugins": ["@refrakt-md/places"]

About the plugin and its runes

Source

import Markdoc from '@markdoc/markdoc';
const { Tag } = Markdoc;
import {
	createComponentRenderable,
	createContentModelSchema,
	bodyOnly,
	renderNodes,
	pageSectionProperties,
} from '@refrakt-md/runes';

export const itineraryStopSections = { body: 'body' } as const;

export const itineraryStop = createContentModelSchema({
	sections: itineraryStopSections,
	provides: ['prose'],
	attributes: {
		time: {
			type: String,
			required: false,
			description: 'Scheduled time for this stop (e.g. "9:00 AM").',
		},
		location: {
			type: String,
			required: false,
			description: 'Name of the place or venue for this stop.',
		},
		duration: {
			type: String,
			required: false,
			description: 'How long to spend at this stop (e.g. "2 hours").',
		},
		activity: {
			type: String,
			required: false,
			description: 'Type of activity at this stop (e.g. "sightseeing", "dining").',
		},
		lat: {
			type: String,
			required: false,
			description: 'Latitude coordinate for placing this stop on a map.',
		},
		lng: {
			type: String,
			required: false,
			description: 'Longitude coordinate for placing this stop on a map.',
		},
	},
	contentModel: bodyOnly(),
	transform(resolved, attrs, config) {
		const timeTag = new Tag('time', {}, [attrs.time ?? '']);
		const locationTag = new Tag('span', {}, [attrs.location ?? '']);
		const durationMeta = new Tag('meta', { content: attrs.duration ?? '' });
		const activityMeta = new Tag('meta', { content: attrs.activity ?? '' });
		const latMeta = new Tag('meta', { content: attrs.lat ?? '' });
		const lngMeta = new Tag('meta', { content: attrs.lng ?? '' });
		const body = renderNodes(resolved.body, config).wrap('div');

		return createComponentRenderable({
			rune: 'itinerary-stop',
			tag: 'li',
			properties: {
				time: timeTag,
				location: locationTag,
				duration: durationMeta,
				activity: activityMeta,
				lat: latMeta,
				lng: lngMeta,
			},
			refs: {
				body: body.tag('div'),
			},
			children: [timeTag, locationTag, body.next()],
		});
	},
});

export const itineraryDay = createContentModelSchema({
	attributes: {
		label: {
			type: String,
			required: false,
			description: 'Display label for this day (e.g. "Day 1 — Arrival").',
		},
		date: {
			type: String,
			required: false,
			description: 'Calendar date for this day of the itinerary.',
		},
	},
	contentModel: {
		type: 'sections',
		sectionHeading: 'heading',
		fields: [{ name: 'header', match: 'paragraph', optional: true, greedy: true }],
		sectionModel: {
			type: 'sequence',
			fields: [{ name: 'body', match: 'any', optional: true, greedy: true }],
		},
		emitTag: 'itinerary-stop',
		headingExtract: {
			fields: [
				{ name: 'time', match: 'text' as const, pattern: /^(.+?)\s*[-–—]\s*/ },
				{ name: 'location', match: 'text' as const, pattern: 'remainder' as const },
			],
		},
		emitAttributes: {
			time: '$time',
			location: '$location',
		},
	},
	transform(resolved, attrs, config) {
		const headerNodes = renderNodes(resolved.header, config);
		const stopsRendered = renderNodes(resolved.sections, config);

		const stopsStream = stopsRendered.tag('li').typeof('ItineraryStop');

		const labelTag = new Tag('h3', {}, [attrs.label ?? '']);
		const dateMeta = new Tag('meta', { content: attrs.date ?? '' });

		const stopsList = new Tag('ol', {}, stopsStream.toArray());

		const children: any[] = [labelTag];
		if (headerNodes.count() > 0) {
			children.push(headerNodes.wrap('div').next());
		}
		children.push(stopsList);

		return createComponentRenderable({
			rune: 'itinerary-day',
			tag: 'article',
			properties: {
				label: labelTag,
				date: dateMeta,
				stop: stopsStream,
			},
			refs: {
				stops: stopsList,
			},
			children,
		});
	},
});

export const itinerarySections = {
	preamble: 'preamble',
	headline: 'title',
	blurb: 'description',
} as const;

export const itinerary = createContentModelSchema({
	sections: itinerarySections,
	attributes: {
		variant: {
			type: String,
			required: false,
			description: 'Layout style for the itinerary (e.g. "day-by-day").',
		},
		direction: {
			type: String,
			required: false,
			description: 'Flow direction of the timeline: vertical or horizontal.',
		},
	},
	contentModel: {
		when: [
			{
				condition: { hasChild: 'heading:2' },
				model: {
					type: 'sections' as const,
					sectionHeading: 'heading:2',
					fields: [{ name: 'header', match: 'heading|paragraph', optional: true, greedy: true }],
					sectionModel: {
						type: 'sequence' as const,
						fields: [{ name: 'body', match: 'any', optional: true, greedy: true }],
					},
					emitTag: 'itinerary-day',
					emitAttributes: {
						label: '$heading',
					},
				},
			},
		],
		default: {
			type: 'sections' as const,
			sectionHeading: 'heading:2',
			fields: [],
			sectionModel: {
				type: 'sequence' as const,
				fields: [],
			},
			emitTag: 'itinerary-day',
			implicitSection: { attributes: { label: '' } },
		},
	},
	transform(resolved, attrs, config) {
		const headerNodes = renderNodes(resolved.header, config);
		const bodyStream = renderNodes(resolved.sections, config);

		const variantMeta = new Tag('meta', { content: attrs.variant ?? 'day-by-day' });
		const directionMeta = new Tag('meta', { content: attrs.direction ?? 'vertical' });

		const days = bodyStream.tag('article').typeof('ItineraryDay');
		const daysContainer = new Tag('div', {}, days.toArray());

		const children: any[] = [];
		if (headerNodes.count() > 0) {
			children.push(headerNodes.wrap('header').next());
		}
		children.push(daysContainer);

		return createComponentRenderable({
			rune: 'itinerary',
			tag: 'section',
			properties: {
				variant: variantMeta,
				direction: directionMeta,
				day: days,
			},
			refs: { ...pageSectionProperties(headerNodes), days: daysContainer },
			children,
		});
	},
});

View plugins/places/src/tags/itinerary.ts on GitHub

A travel plan, day by day, with a time and a place for each stop.

Basic usage

{% itinerary variant="day-by-day" %}
## Day 1 — Arrival

### 9:00 AM — Narita Airport

Clear customs and pick up your Japan Rail Pass at the JR counter.

### 12:00 PM — Shinjuku

Check in to the hotel and grab lunch at a nearby ramen shop.

### 6:00 PM — Shibuya

Explore the famous crossing and have dinner in the area.

## Day 2 — Temples & Gardens

### 8:00 AM — Meiji Shrine

Start the day with a peaceful walk through the shrine grounds.

### 11:00 AM — Harajuku

Browse Takeshita Street and the backstreet boutiques.
{% /itinerary %}
<section data-rune="itinerary" data-rune-fields="{&quot;variant&quot;:&quot;day-by-day&quot;,&quot;direction&quot;:&quot;vertical&quot;}">
  <div data-name="days">
    <article data-rune="itinerary-day" data-rune-fields="{&quot;date&quot;:&quot;&quot;}" data-field="day">
      <h3 data-field="label">Day 1 — Arrival</h3>
      <ol data-name="stops">
        <li data-rune="itinerary-stop" data-rune-fields="{&quot;duration&quot;:&quot;&quot;,&quot;activity&quot;:&quot;&quot;,&quot;lat&quot;:&quot;&quot;,&quot;lng&quot;:&quot;&quot;}" data-field="stop">
          <time data-field="time">9:00 AM</time>
          <span data-field="location">Narita Airport</span>
          <div data-name="body">
            <p>Clear customs and pick up your Japan Rail Pass at the JR counter.</p>
          </div>
        </li>
        <li data-rune="itinerary-stop" data-rune-fields="{&quot;duration&quot;:&quot;&quot;,&quot;activity&quot;:&quot;&quot;,&quot;lat&quot;:&quot;&quot;,&quot;lng&quot;:&quot;&quot;}" data-field="stop">
          <time data-field="time">12:00 PM</time>
          <span data-field="location">Shinjuku</span>
          <div data-name="body">
            <p>Check in to the hotel and grab lunch at a nearby ramen shop.</p>
          </div>
        </li>
        <li data-rune="itinerary-stop" data-rune-fields="{&quot;duration&quot;:&quot;&quot;,&quot;activity&quot;:&quot;&quot;,&quot;lat&quot;:&quot;&quot;,&quot;lng&quot;:&quot;&quot;}" data-field="stop">
          <time data-field="time">6:00 PM</time>
          <span data-field="location">Shibuya</span>
          <div data-name="body">
            <p>Explore the famous crossing and have dinner in the area.</p>
          </div>
        </li>
      </ol>
    </article>
    <article data-rune="itinerary-day" data-rune-fields="{&quot;date&quot;:&quot;&quot;}" data-field="day">
      <h3 data-field="label">Day 2 — Temples &amp; Gardens</h3>
      <ol data-name="stops">
        <li data-rune="itinerary-stop" data-rune-fields="{&quot;duration&quot;:&quot;&quot;,&quot;activity&quot;:&quot;&quot;,&quot;lat&quot;:&quot;&quot;,&quot;lng&quot;:&quot;&quot;}" data-field="stop">
          <time data-field="time">8:00 AM</time>
          <span data-field="location">Meiji Shrine</span>
          <div data-name="body">
            <p>Start the day with a peaceful walk through the shrine grounds.</p>
          </div>
        </li>
        <li data-rune="itinerary-stop" data-rune-fields="{&quot;duration&quot;:&quot;&quot;,&quot;activity&quot;:&quot;&quot;,&quot;lat&quot;:&quot;&quot;,&quot;lng&quot;:&quot;&quot;}" data-field="stop">
          <time data-field="time">11:00 AM</time>
          <span data-field="location">Harajuku</span>
          <div data-name="body">
            <p>Browse Takeshita Street and the backstreet boutiques.</p>
          </div>
        </li>
      </ol>
    </article>
  </div>
</section>

Day 1 — Arrival

  1. Narita Airport

    Clear customs and pick up your Japan Rail Pass at the JR counter.

  2. Shinjuku

    Check in to the hotel and grab lunch at a nearby ramen shop.

  3. Shibuya

    Explore the famous crossing and have dinner in the area.

Day 2 — Temples & Gardens

  1. Meiji Shrine

    Start the day with a peaceful walk through the shrine grounds.

  2. Harajuku

    Browse Takeshita Street and the backstreet boutiques.

<section class="rf-itinerary rf-itinerary--day-by-day rf-itinerary--vertical" data-variant="day-by-day" data-direction="vertical" data-elevation="flat" data-rune="itinerary" data-density="full">
  <div data-name="days" class="rf-itinerary__days">
    <article class="rf-itinerary-day" data-field="day" data-rune="itinerary-day" data-density="full">
      <h3 data-field="label" data-name="header" class="rf-itinerary-day__header">Day 1 — Arrival</h3>
      <ol data-name="stops" data-sequence="connected" class="rf-itinerary-day__stops">
        <li class="rf-itinerary-stop" data-field="stop" data-activity="" data-duration="" data-rune="itinerary-stop" data-density="full">
          <time data-field="time" data-name="time" class="rf-itinerary-stop__time">9:00 AM</time>
          <span data-field="location" data-name="location" class="rf-itinerary-stop__location">Narita Airport</span>
          <div data-name="body" class="rf-itinerary-stop__body" data-section="body">
            <p>Clear customs and pick up your Japan Rail Pass at the JR counter.</p>
          </div>
        </li>
        <li class="rf-itinerary-stop" data-field="stop" data-activity="" data-duration="" data-rune="itinerary-stop" data-density="full">
          <time data-field="time" data-name="time" class="rf-itinerary-stop__time">12:00 PM</time>
          <span data-field="location" data-name="location" class="rf-itinerary-stop__location">Shinjuku</span>
          <div data-name="body" class="rf-itinerary-stop__body" data-section="body">
            <p>Check in to the hotel and grab lunch at a nearby ramen shop.</p>
          </div>
        </li>
        <li class="rf-itinerary-stop" data-field="stop" data-activity="" data-duration="" data-rune="itinerary-stop" data-density="full">
          <time data-field="time" data-name="time" class="rf-itinerary-stop__time">6:00 PM</time>
          <span data-field="location" data-name="location" class="rf-itinerary-stop__location">Shibuya</span>
          <div data-name="body" class="rf-itinerary-stop__body" data-section="body">
            <p>Explore the famous crossing and have dinner in the area.</p>
          </div>
        </li>
      </ol>
    </article>
    <article class="rf-itinerary-day" data-field="day" data-rune="itinerary-day" data-density="full">
      <h3 data-field="label" data-name="header" class="rf-itinerary-day__header">Day 2 — Temples &amp; Gardens</h3>
      <ol data-name="stops" data-sequence="connected" class="rf-itinerary-day__stops">
        <li class="rf-itinerary-stop" data-field="stop" data-activity="" data-duration="" data-rune="itinerary-stop" data-density="full">
          <time data-field="time" data-name="time" class="rf-itinerary-stop__time">8:00 AM</time>
          <span data-field="location" data-name="location" class="rf-itinerary-stop__location">Meiji Shrine</span>
          <div data-name="body" class="rf-itinerary-stop__body" data-section="body">
            <p>Start the day with a peaceful walk through the shrine grounds.</p>
          </div>
        </li>
        <li class="rf-itinerary-stop" data-field="stop" data-activity="" data-duration="" data-rune="itinerary-stop" data-density="full">
          <time data-field="time" data-name="time" class="rf-itinerary-stop__time">11:00 AM</time>
          <span data-field="location" data-name="location" class="rf-itinerary-stop__location">Harajuku</span>
          <div data-name="body" class="rf-itinerary-stop__body" data-section="body">
            <p>Browse Takeshita Street and the backstreet boutiques.</p>
          </div>
        </li>
      </ol>
    </article>
  </div>
</section>

How Markdown is read

You writeIt becomes
A ## headingA day, labelled with the heading
A heading inside a day, such as ### 9:00 AM — Narita AirportA stop: the text before the first dash is its time, the rest its place
The content under a stop headingThe stop's description
A short paragraph, then a # heading and a paragraph, before the first dayThe eyebrow, headline and blurb (Page sections)

Single-day itinerary

Without H2 headings, all stops are grouped into a single implicit day.

{% itinerary %}
### 10:00 AM — Museum of Modern Art

Spend the morning exploring the permanent collection.

### 1:00 PM — Central Park

Picnic lunch on the Great Lawn.

### 3:00 PM — Times Square

Walk through the theater district.
{% /itinerary %}
<section data-rune="itinerary" data-rune-fields="{&quot;variant&quot;:&quot;day-by-day&quot;,&quot;direction&quot;:&quot;vertical&quot;}">
  <div data-name="days">
    <article data-rune="itinerary-day" data-rune-fields="{&quot;date&quot;:&quot;&quot;}" data-field="day">
      <h3 data-field="label"></h3>
      <ol data-name="stops">
        <li data-rune="itinerary-stop" data-rune-fields="{&quot;duration&quot;:&quot;&quot;,&quot;activity&quot;:&quot;&quot;,&quot;lat&quot;:&quot;&quot;,&quot;lng&quot;:&quot;&quot;}" data-field="stop">
          <time data-field="time">10:00 AM</time>
          <span data-field="location">Museum of Modern Art</span>
          <div data-name="body">
            <p>Spend the morning exploring the permanent collection.</p>
          </div>
        </li>
        <li data-rune="itinerary-stop" data-rune-fields="{&quot;duration&quot;:&quot;&quot;,&quot;activity&quot;:&quot;&quot;,&quot;lat&quot;:&quot;&quot;,&quot;lng&quot;:&quot;&quot;}" data-field="stop">
          <time data-field="time">1:00 PM</time>
          <span data-field="location">Central Park</span>
          <div data-name="body">
            <p>Picnic lunch on the Great Lawn.</p>
          </div>
        </li>
        <li data-rune="itinerary-stop" data-rune-fields="{&quot;duration&quot;:&quot;&quot;,&quot;activity&quot;:&quot;&quot;,&quot;lat&quot;:&quot;&quot;,&quot;lng&quot;:&quot;&quot;}" data-field="stop">
          <time data-field="time">3:00 PM</time>
          <span data-field="location">Times Square</span>
          <div data-name="body">
            <p>Walk through the theater district.</p>
          </div>
        </li>
      </ol>
    </article>
  </div>
</section>

  1. Museum of Modern Art

    Spend the morning exploring the permanent collection.

  2. Central Park

    Picnic lunch on the Great Lawn.

  3. Times Square

    Walk through the theater district.

<section class="rf-itinerary rf-itinerary--day-by-day rf-itinerary--vertical" data-variant="day-by-day" data-direction="vertical" data-elevation="flat" data-rune="itinerary" data-density="full">
  <div data-name="days" class="rf-itinerary__days">
    <article class="rf-itinerary-day" data-field="day" data-rune="itinerary-day" data-density="full">
      <h3 data-field="label" data-name="header" class="rf-itinerary-day__header"></h3>
      <ol data-name="stops" data-sequence="connected" class="rf-itinerary-day__stops">
        <li class="rf-itinerary-stop" data-field="stop" data-activity="" data-duration="" data-rune="itinerary-stop" data-density="full">
          <time data-field="time" data-name="time" class="rf-itinerary-stop__time">10:00 AM</time>
          <span data-field="location" data-name="location" class="rf-itinerary-stop__location">Museum of Modern Art</span>
          <div data-name="body" class="rf-itinerary-stop__body" data-section="body">
            <p>Spend the morning exploring the permanent collection.</p>
          </div>
        </li>
        <li class="rf-itinerary-stop" data-field="stop" data-activity="" data-duration="" data-rune="itinerary-stop" data-density="full">
          <time data-field="time" data-name="time" class="rf-itinerary-stop__time">1:00 PM</time>
          <span data-field="location" data-name="location" class="rf-itinerary-stop__location">Central Park</span>
          <div data-name="body" class="rf-itinerary-stop__body" data-section="body">
            <p>Picnic lunch on the Great Lawn.</p>
          </div>
        </li>
        <li class="rf-itinerary-stop" data-field="stop" data-activity="" data-duration="" data-rune="itinerary-stop" data-density="full">
          <time data-field="time" data-name="time" class="rf-itinerary-stop__time">3:00 PM</time>
          <span data-field="location" data-name="location" class="rf-itinerary-stop__location">Times Square</span>
          <div data-name="body" class="rf-itinerary-stop__body" data-section="body">
            <p>Walk through the theater district.</p>
          </div>
        </li>
      </ol>
    </article>
  </div>
</section>

Attributes

AttributeTypeRequiredDescription
variantstring—Layout style for the itinerary (e.g. "day-by-day").
directionstring—Flow direction of the timeline: vertical or horizontal.

Universal attributes

bg

The background layer: image, video, gradient, flat overlay wash and legibility scrim, in a single injected layer behind the rune's content.

AttributeTypeRequiredDescription
bgstring—Background preset applied to this block
bg-fromstring—Gradient start colour — a semantic token name (→ var(--rf-color-*))
bg-gradient"to-t" | "to-b" | "to-l" | "to-r" | "to-tr" | "to-br" | "to-bl" | "to-tl"—Gradient direction (bounded named set)
bg-gradient-type"linear" | "radial" | "conic"—Gradient type
bg-tostring—Gradient end colour — a semantic token name
bg-viastring—Optional middle gradient stop — a semantic token name
scrim"top" | "bottom" | "left" | "right" | "none"—Scrim direction (heaviest edge); presence turns the scrim on, "none" opts out of the default cover scrim
scrim-blur"none" | "sm" | "md" | "lg"—Frost scrim blur amount
scrim-strength"sm" | "md" | "lg"—Gradient scrim strength
scrim-tone"dark" | "light"—Whether the scrim darkens (for light text) or lightens (for dark text)
scrim-type"gradient" | "frost"—Scrim treatment: gradient (default) or frost (backdrop blur)
elevation

How far the rune sits off the page, from sunken to overlay. The theme decides what each step looks like.

AttributeTypeRequiredDescription
elevation"sunken" | "flush" | "flat" | "raised" | "floating" | "overlay" | "none" | "sm" | "md" | "lg"—Surface depth, from sunken to overlay. Deprecated: none, sm, md and lg (read as flat, raised, raised and floating)
inset

Internal padding override.

AttributeTypeRequiredDescription
inset"flush" | "tight" | "default" | "loose" | "breathe"—Inner padding of this block
motion

Scroll-reveal entrance. You choose its character; the theme decides how it moves.

AttributeTypeRequiredDescription
reveal"none" | "fade" | "slide" | "scale" | "blur"—Scroll-reveal entrance character (none|fade|slide|scale|blur); the theme owns the choreography
staggerboolean—Cascade this block's items in as it reveals (no-op on single-child runes)
prominence

Header emphasis. Scales a rune's header, or its featured quotation; the theme decides the type size for each step.

AttributeTypeRequiredDescription
prominence"quiet" | "normal" | "prominent" | "display" | "marquee"—Emphasis of a page-section header or a featured quotation (only on runes that have one)
spacing

Block-level rhythm override.

AttributeTypeRequiredDescription
spacing"flush" | "tight" | "default" | "loose" | "breathe"—Vertical spacing above and below this block
substrate

Generated pattern fills behind the content, drawn by the theme.

AttributeTypeRequiredDescription
substrate"dots" | "grid" | "lines" | "cross" | "checker" | "none"—Generated surface pattern
substrate-fill"inherit" | "inset"—Surface fill the pattern sits on (full colour stays with tint)
substrate-opacity"sm" | "md" | "lg"—Pattern ink strength
substrate-size"sm" | "md" | "lg"—Pattern cell size
substrate-target"self" | "media"—Which surface the pattern fills (overrides the rune/theme default)
tint

Per-rune colour override: a named tint from the theme registry, with inline per-token overrides layered on top.

AttributeTypeRequiredDescription
tintstring—Color tint preset applied to this block
tint-mode"auto" | "dark" | "light"—Whether the tint adapts to auto, dark, or light mode
width

The track a block rune occupies.

AttributeTypeRequiredDescription
width"compact" | "narrow" | "content" | "wide" | "full"—Maximum width constraint for this block
Not availableWhy
dropcap, readingthis rune declares no prose body
framethis rune declares neither a `frameTarget` nor a media section

itinerary-day

AttributeTypeRequiredDescription
labelstring—Display label for this day (e.g. "Day 1 — Arrival").
datestring—Calendar date for this day of the itinerary.

Universal attributes

bg

The background layer: image, video, gradient, flat overlay wash and legibility scrim, in a single injected layer behind the rune's content.

AttributeTypeRequiredDescription
bgstring—Background preset applied to this block
bg-fromstring—Gradient start colour — a semantic token name (→ var(--rf-color-*))
bg-gradient"to-t" | "to-b" | "to-l" | "to-r" | "to-tr" | "to-br" | "to-bl" | "to-tl"—Gradient direction (bounded named set)
bg-gradient-type"linear" | "radial" | "conic"—Gradient type
bg-tostring—Gradient end colour — a semantic token name
bg-viastring—Optional middle gradient stop — a semantic token name
scrim"top" | "bottom" | "left" | "right" | "none"—Scrim direction (heaviest edge); presence turns the scrim on, "none" opts out of the default cover scrim
scrim-blur"none" | "sm" | "md" | "lg"—Frost scrim blur amount
scrim-strength"sm" | "md" | "lg"—Gradient scrim strength
scrim-tone"dark" | "light"—Whether the scrim darkens (for light text) or lightens (for dark text)
scrim-type"gradient" | "frost"—Scrim treatment: gradient (default) or frost (backdrop blur)
elevation

How far the rune sits off the page, from sunken to overlay. The theme decides what each step looks like.

AttributeTypeRequiredDescription
elevation"sunken" | "flush" | "flat" | "raised" | "floating" | "overlay" | "none" | "sm" | "md" | "lg"—Surface depth, from sunken to overlay. Deprecated: none, sm, md and lg (read as flat, raised, raised and floating)
inset

Internal padding override.

AttributeTypeRequiredDescription
inset"flush" | "tight" | "default" | "loose" | "breathe"—Inner padding of this block
motion

Scroll-reveal entrance. You choose its character; the theme decides how it moves.

AttributeTypeRequiredDescription
reveal"none" | "fade" | "slide" | "scale" | "blur"—Scroll-reveal entrance character (none|fade|slide|scale|blur); the theme owns the choreography
staggerboolean—Cascade this block's items in as it reveals (no-op on single-child runes)
spacing

Block-level rhythm override.

AttributeTypeRequiredDescription
spacing"flush" | "tight" | "default" | "loose" | "breathe"—Vertical spacing above and below this block
substrate

Generated pattern fills behind the content, drawn by the theme.

AttributeTypeRequiredDescription
substrate"dots" | "grid" | "lines" | "cross" | "checker" | "none"—Generated surface pattern
substrate-fill"inherit" | "inset"—Surface fill the pattern sits on (full colour stays with tint)
substrate-opacity"sm" | "md" | "lg"—Pattern ink strength
substrate-size"sm" | "md" | "lg"—Pattern cell size
substrate-target"self" | "media"—Which surface the pattern fills (overrides the rune/theme default)
tint

Per-rune colour override: a named tint from the theme registry, with inline per-token overrides layered on top.

AttributeTypeRequiredDescription
tintstring—Color tint preset applied to this block
tint-mode"auto" | "dark" | "light"—Whether the tint adapts to auto, dark, or light mode
width

The track a block rune occupies.

AttributeTypeRequiredDescription
width"compact" | "narrow" | "content" | "wide" | "full"—Maximum width constraint for this block
Not availableWhy
dropcap, readingthis rune declares no prose body
framethis rune declares neither a `frameTarget` nor a media section
prominencethis rune has no page-section header or featured quotation

itinerary-stop

AttributeTypeRequiredDescription
timestring—Scheduled time for this stop (e.g. "9:00 AM").
locationstring—Name of the place or venue for this stop.
durationstring—How long to spend at this stop (e.g. "2 hours").
activitystring—Type of activity at this stop (e.g. "sightseeing", "dining").
latstring—Latitude coordinate for placing this stop on a map.
lngstring—Longitude coordinate for placing this stop on a map.

Universal attributes

bg

The background layer: image, video, gradient, flat overlay wash and legibility scrim, in a single injected layer behind the rune's content.

AttributeTypeRequiredDescription
bgstring—Background preset applied to this block
bg-fromstring—Gradient start colour — a semantic token name (→ var(--rf-color-*))
bg-gradient"to-t" | "to-b" | "to-l" | "to-r" | "to-tr" | "to-br" | "to-bl" | "to-tl"—Gradient direction (bounded named set)
bg-gradient-type"linear" | "radial" | "conic"—Gradient type
bg-tostring—Gradient end colour — a semantic token name
bg-viastring—Optional middle gradient stop — a semantic token name
scrim"top" | "bottom" | "left" | "right" | "none"—Scrim direction (heaviest edge); presence turns the scrim on, "none" opts out of the default cover scrim
scrim-blur"none" | "sm" | "md" | "lg"—Frost scrim blur amount
scrim-strength"sm" | "md" | "lg"—Gradient scrim strength
scrim-tone"dark" | "light"—Whether the scrim darkens (for light text) or lightens (for dark text)
scrim-type"gradient" | "frost"—Scrim treatment: gradient (default) or frost (backdrop blur)
dropcap

Per-instance drop-cap opt-in.

AttributeTypeRequiredDescription
dropcapboolean—Style the opening letter of a prose body as a drop cap. Honoured only when the body reads as prose; ignored otherwise.
elevation

How far the rune sits off the page, from sunken to overlay. The theme decides what each step looks like.

AttributeTypeRequiredDescription
elevation"sunken" | "flush" | "flat" | "raised" | "floating" | "overlay" | "none" | "sm" | "md" | "lg"—Surface depth, from sunken to overlay. Deprecated: none, sm, md and lg (read as flat, raised, raised and floating)
inset

Internal padding override.

AttributeTypeRequiredDescription
inset"flush" | "tight" | "default" | "loose" | "breathe"—Inner padding of this block
motion

Scroll-reveal entrance. You choose its character; the theme decides how it moves.

AttributeTypeRequiredDescription
reveal"none" | "fade" | "slide" | "scale" | "blur"—Scroll-reveal entrance character (none|fade|slide|scale|blur); the theme owns the choreography
staggerboolean—Cascade this block's items in as it reveals (no-op on single-child runes)
reading

Editorial register for body text. You pick the register; the theme decides how it looks.

AttributeTypeRequiredDescription
reading"fine" | "ui" | "prose"—Reading register for this block’s body: fine | ui | prose. The theme sets how each one looks.
spacing

Block-level rhythm override.

AttributeTypeRequiredDescription
spacing"flush" | "tight" | "default" | "loose" | "breathe"—Vertical spacing above and below this block
substrate

Generated pattern fills behind the content, drawn by the theme.

AttributeTypeRequiredDescription
substrate"dots" | "grid" | "lines" | "cross" | "checker" | "none"—Generated surface pattern
substrate-fill"inherit" | "inset"—Surface fill the pattern sits on (full colour stays with tint)
substrate-opacity"sm" | "md" | "lg"—Pattern ink strength
substrate-size"sm" | "md" | "lg"—Pattern cell size
substrate-target"self" | "media"—Which surface the pattern fills (overrides the rune/theme default)
tint

Per-rune colour override: a named tint from the theme registry, with inline per-token overrides layered on top.

AttributeTypeRequiredDescription
tintstring—Color tint preset applied to this block
tint-mode"auto" | "dark" | "light"—Whether the tint adapts to auto, dark, or light mode
width

The track a block rune occupies.

AttributeTypeRequiredDescription
width"compact" | "narrow" | "content" | "wide" | "full"—Maximum width constraint for this block
Not availableWhy
framethis rune declares neither a `frameTarget` nor a media section
prominencethis rune has no page-section header or featured quotation