Svelte SDK reference

Developer preview

This feature is in developer preview. Use with caution as it may change unexpectedly. For more information, contact us.
ExportDescription
UniformCompositionRenders a full Canvas composition tree
UniformComponentInternal component renderer (for advanced usage)
UniformSlotRenders child components from a named slot
UniformTextRenders text parameters with inline editing support
UniformRichTextRenders rich text parameters with formatting
DefaultNotImplementedComponentFallback component for unknown types
getUniformCurrentCompositionGet the current composition data from context
getUniformCurrentComponentGet the current component data from context
getUniformContextualEditingSet up custom contextual editing
createUniformApiEnhancerCreate an API-based composition enhancer
getClientConditionsCompositionEvaluate client-side visibility rules
getClientVisibilityRulesGet client-side visibility rule definitions
convertComponentToPropsConvert a ComponentInstance to flattened props
getParameterAttributesGet inline editing data attributes
createComponentResolverCreate a resolver from a component map
resolveComponentResolve a component from a map or resolver function
ComponentMapType for the component mapping object
ComponentPropsType for component props (flattened)
RenderComponentResolverType for the custom resolver function
ExportDescription
createUniformLoadCreate a SvelteKit load function for fetching compositions
createUniformHandleCreate a SvelteKit handle hook for preview mode
createPreviewHandlerCreate preview API endpoint handlers (GET, POST, OPTIONS)
createVercelIsrConfigCreate ISR configuration for Vercel deployments
createRevalidateHandlerCreate an ISR revalidation endpoint handler
createRouteFetcherLow-level route fetcher (used internally by createUniformLoad)
createUniformEntriesCreate entry data for static generation
resolvePathFromParamsHelper to resolve the path from SvelteKit route parameters
logCompositionIssuesLog composition validation issues
logRouteResponseLog route resolution responses
UniformPreviewDataType for preview cookie data
UniformPageDataType for page data from the load function
UNIFORM_PREVIEW_COOKIE_NAMECookie name constant for preview state
ExportDescription
UniformContextProvider component for the Uniform Context engine
PersonalizeRenders personalized content based on visitor scores
PersonalizeEdgeEdge-mode personalization renderer
PersonalizeStandardStandard-mode personalization renderer
TestRenders A/B test variations based on distribution
TestEdgeEdge-mode test renderer
TestStandardStandard-mode test renderer
TrackTracks behavior when content enters the viewport
TrackFragmentTracks behavior on page load (no wrapper element)
getUniformContextGet the Context instance from the nearest provider
getScoresReactive access to visitor scores (Svelte 5 $state)
getQuirksReactive access to visitor quirks (Svelte 5 $state)
isPersonalizedCheck if inside a Personalize component
ExportDescription
RouteClientClient for resolving routes and fetching compositions
flattenValuesExtract values from asset parameters
EMPTY_COMPOSITIONEmpty composition constant (for playground pages)
RootComponentInstanceType for composition root data
ComponentInstanceType for individual component data
CANVAS_DRAFT_STATEConstant for draft content state
CANVAS_PUBLISHED_STATEConstant for published content state
ExportDescription
ContextThe core personalization and scoring engine
CookieTransitionDataStoreStore for persisting visitor data in cookies
enableContextDevToolsPlugin for enabling the Uniform DevTools browser extension
enableDebugConsoleLogDrainPlugin for debug logging to console
ManifestV2Type for the personalization manifest
UNIFORM_DEFAULT_COOKIE_NAMEDefault cookie name for visitor data

type ComponentProps<TProps = unknown> = TProps & { component: ComponentInstance | RootComponentInstance; };
type ComponentMap = Record<string, Component<ComponentProps<any>>>;

Keys can be:

  • "hero": matches type "hero" with no variant
  • "hero__featured": matches type "hero" with variant "featured" (double underscore)
type RenderComponentResolver = ( component: ComponentInstance ) => Component<ComponentProps<any>> | null;
type UniformContextComponentProps = { context: Context; outputType?: 'standard' | 'edge'; trackRouteOnRender?: boolean; includeTransferState?: 'always' | 'never' | 'server-only'; };
type PersonalizeComponentProps<TVariation> = { name: string; variations: TVariation[]; component: Component<TVariation & { personalizationResult: PersonalizationResult }>; algorithm?: string; wrapperComponent?: Component<{ personalizationOccurred: boolean }>; count?: number; compositionMetadata?: CompositionMetadata; };
type TestComponentProps<TVariation> = { name: string; variations: TVariation[]; component: Component<TVariation>; loadingMode?: 'default' | 'none' | Component; compositionMetadata?: CompositionMetadata; };