<SlotContent>

Learn how to render the content of a slot using components.

This component fetches and renders the content of a Slot, serving as the declarative equivalent of the useContent composable.

Example

Here is a basic example of how to use this component:

components/HomeHero.vue

<script setup>import {SlotContent} from '@croct/plug-vue';</script>
<template>    <SlotContent id="home-hero" v-slot="{ content }">        <div>            <strong>{{ content.title }}</strong>            <p>{{ content.subtitle }}</p>            <a :href="content.button.link">{{ content.button.label }}</a>        </div>    </SlotContent></template>

Loading and error states

You can use named slots to handle loading and error states:

components/HomeHero.vue

<script setup>import {SlotContent} from '@croct/plug-vue';</script>
<template>    <SlotContent id="home-hero" v-slot="{ content }">        <div>            <strong>{{ content.title }}</strong>            <p>{{ content.subtitle }}</p>        </div>
        <template #loading>            <p>Loading...</p>        </template>
        <template #error="{ error }">            <p>Something went wrong: {{ error.message }}</p>        </template>    </SlotContent></template>

Initial content

When you provide the initial prop, the default slot renders immediately with the initial content while the actual content loads in the background:

components/HomeHero.vue

<script setup>import {SlotContent} from '@croct/plug-vue';</script>
<template>    <SlotContent id="home-hero" :initial="{ title: 'Welcome' }" v-slot="{ content }">        <h1>{{ content.title }}</h1>    </SlotContent></template>

Props

The following list describes the supported props:

id string

The ID of the slot to fetch.

You can specify the version of the slot by passing a versioned ID in the form id@version. For example, passing home-hero@1 will fetch the content for the home-hero slot in version 1. Not specifying a version number is the same as passing home-hero@latest, which will load the content for the latest version.

Best practice

Always specify a version to ensure the front end receives content with the expected structure despite future schema changes.

For more information, see Slot versioning.

initial(optional) JSON

An initial value to render while loading the actual content.

Auto-provided

If you are using the Croct CLI, you do not need to set an initial value unless you want to use a different one.

This value is required for server-side rendering. For client-side rendering, when this prop is provided, the default slot renders immediately with the initial content. Without it, the #loading slot renders until the content is available.

fallback(optional) JSON

A fallback value to render in case of an error.

Auto-provided

If you are using the Croct CLI, you do not need to set a fallback unless you want to use a different one.

If not specified, the #error slot renders on failure.

expiration(optional) number

The cache expiration time in milliseconds, extended on every render.

If negative, the cache never expires. By default, the cache expires after 60 seconds.

The SDK caches the result to prevent network requests on concurrent renders and re-renders.

Default:60000

cacheKey(optional) string

A unique key to identify the cache entry.

By default, the cache key is derived from the slot ID, locale, and attributes. You can specify a custom cache key to force re-fetching even if the other parameters are the same.

preferredLocale(optional) string

The locale code to fetch the content.

The code consists of a two-part string that specifies the language and, optionally, the country. For example, en represents English, en-us stands for English (United States), and pt-br for Portuguese (Brazil). It is case-insensitive and supports both hyphens and underscores as separators to accommodate the different conventions used by browsers, libraries, and other systems.

If no content is available in the preferred locale, the default locale content is returned instead.

Default:default locale

timeout(optional) number

The maximum fetch time in milliseconds.

Once reached, the SDK will abort the request and reject the promise with a timeout error.

attributes(optional) object

The map of attributes to inject in the evaluation context.

The attributes can be referenced in audience conditions using the context variable. For example, suppose you pass the following attributes:

{cities: ["New York", "San Francisco"]}

You can then reference them in queries like:

context's cities include location's cityName

For more information, see Context variables.

The following restrictions apply to the attributes:

Up to 30 entries and 5 levels deep
Keys can be either numbers or non-empty strings with a maximum length of 50 characters
Values can be null, numbers, booleans, strings (up to 50 characters), or nested maps
Nested maps follow the same constraints for keys and values

Slots

The following list describes the supported slots:

#default { content: JSON, metadata?: object }: The default scoped slot receives an object with the slot content and optional metadata.
This slot renders when content is available, either from the initial prop or after fetching.
#loading none: A named slot that renders while the content is being fetched.
This slot is not used when the initial prop is provided, since the default slot renders immediately in that case.
#error { error: Error }: A named slot that renders when fetching fails.
This slot receives the error object. It is not used when a fallback prop is provided.