Developers
Start building
Themes/Theme SDK/Modules/editor/Definers

Definers

The definers of @poltura/theme-sdk/editor.

On this page
import { … } from '@poltura/theme-sdk/editor';

definePreviewScenarios

Declares the theme's own preview scenarios; default-export the result from src/preview-scenarios.ts.

definePreviewScenarios(scenarios: PreviewScenarios): PreviewScenarios

Keep the file pure data: it is bundled into every page. System domains such as cart always exist.

Parameters

  • scenarios: PreviewScenarios: The domains, each with its choices.

Returns: The same domains.

Example

import { definePreviewScenarios } from '@poltura/theme-sdk/editor';

export const scenarios = definePreviewScenarios([
  {
    key: 'reviews',
    label: 'Reviews',
    options: [
      { value: 'live', label: 'Live data' },
      { value: 'empty', label: 'No reviews yet' },
    ],
  },
]);
Last updated