@builder.io/sdk-vue/lib/edge/components/content-variants/content-variants.types.d.ts

Builder.io SDK for Vue

import type { BuilderRenderContext, RegisteredComponent } from '../../context/types';
import type { ApiVersion } from '../../types/api-version';
import type { BuilderContent } from '../../types/builder-content';
import type { Nullable } from '../../types/typescript';
import type { ExtraFrameworkProps } from './extra-framework-props-types';
export interface ContentVariantsPrps extends ExtraFrameworkProps {
    /**
     * The Builder content JSON to render (required).
     */
    content?: Nullable<BuilderContent>;
    /**
     * The Builder content `model` to render (required).
     */
    model?: string;
    /**
     * Additional data to inject into your Builder content (optional).
     */
    data?: {
        [key: string]: any;
    };
    /**
     *
     */
    context?: BuilderRenderContext;
    /**
     * Your API Key: needed to enable visual editing, and to dynamically fetch symbols (required).
     */
    apiKey: string;
    /**
     * Sets the host of Builder API calls. (Defaults to global `https://cdn.builder.io`)
     */
    apiHost?: string;
    apiVersion?: ApiVersion;
    /**
     * An array of custom components to register (optional).
     */
    customComponents?: RegisteredComponent[];
    /**
     * The component to use for rendering links. Defaults to anchor element `<a>`.
     */
    linkComponent?: any;
    /**
     * A boolean to enable or disable tracking (optional). Defaults to `true`.
     */
    canTrack?: boolean;
    /**
     * If provided, the API will auto-resolve localized objects to the value of this `locale` key (optional).
     */
    locale?: string;
    /**
     * A boolean to enable or disable enriching API content (optional).
     *
     * Enriching will Include multilevel references in the response. Defaults to `false`.
     */
    enrich?: boolean;
    /**
     * The element that wraps your content. Defaults to `<div>` ('ScrollView' in React Native).
     */
    contentWrapper?: any;
    /**
     * Additonal props to pass to `contentWrapper`. Defaults to `{}`.
     */
    contentWrapperProps?: any;
    /**
     * The element that wraps your blocks. Defaults to `<div>` ('ScrollView' in React Native).
     */
    blocksWrapper?: any;
    /**
     * Additonal props to pass to `blocksWrapper`. Defaults to `{}`.
     */
    blocksWrapperProps?: any;
    /**
     * List of hosts to allow editing content from.
     */
    trustedHosts?: string[];
    /**
     * A CSP nonce to use for the SDK's inlined `<script>` and `<style>` tags.
     */
    nonce?: string;
}