# Svelte SDK reference

> Exports and type definitions of the Uniform packages for Svelte and SvelteKit.

Source: https://docs.uniform.app/docs/sdk/svelte/reference

> **Developer preview:**
>
> This feature is in developer preview and may change unexpectedly. For more information, contact support@uniform.dev.

## Import reference

### @uniformdev/canvas-svelte

| Export | Description |
| --- | --- |
| `UniformComposition` | Renders a full Canvas composition tree |
| `UniformComponent` | Internal component renderer (for advanced usage) |
| `UniformSlot` | Renders child components from a named slot |
| `UniformText` | Renders text parameters with inline editing support |
| `UniformRichText` | Renders rich text parameters with formatting |
| `DefaultNotImplementedComponent` | Fallback component for unknown types |
| `getUniformCurrentComposition` | Get the current composition data from context |
| `getUniformCurrentComponent` | Get the current component data from context |
| `getUniformContextualEditing` | Set up custom contextual editing |
| `createUniformApiEnhancer` | Create an API-based composition enhancer |
| `getClientConditionsComposition` | Evaluate client-side visibility rules |
| `getClientVisibilityRules` | Get client-side visibility rule definitions |
| `convertComponentToProps` | Convert a `ComponentInstance` to flattened props |
| `getParameterAttributes` | Get inline editing data attributes |
| `createComponentResolver` | Create a resolver from a component map |
| `resolveComponent` | Resolve a component from a map or resolver function |
| `ComponentMap` | Type for the component mapping object |
| `ComponentProps` | Type for component props (flattened) |
| `RenderComponentResolver` | Type for the custom resolver function |

### @uniformdev/canvas-sveltekit

| Export | Description |
| --- | --- |
| `createUniformLoad` | Create a SvelteKit load function for fetching compositions |
| `createUniformHandle` | Create a SvelteKit handle hook for preview mode |
| `createPreviewHandler` | Create preview API endpoint handlers (GET, POST, OPTIONS) |
| `createVercelIsrConfig` | Create ISR configuration for Vercel deployments |
| `createRevalidateHandler` | Create an ISR revalidation endpoint handler |
| `createRouteFetcher` | Low-level route fetcher (used internally by `createUniformLoad`) |
| `createUniformEntries` | Create entry data for static generation |
| `resolvePathFromParams` | Helper to resolve the path from SvelteKit route parameters |
| `logCompositionIssues` | Log composition validation issues |
| `logRouteResponse` | Log route resolution responses |
| `UniformPreviewData` | Type for preview cookie data |
| `UniformPageData` | Type for page data from the load function |
| `UNIFORM_PREVIEW_COOKIE_NAME` | Cookie name constant for preview state |

### @uniformdev/context-svelte

| Export | Description |
| --- | --- |
| `UniformContext` | Provider component for the Uniform Context engine |
| `Personalize` | Renders personalized content based on visitor scores |
| `PersonalizeEdge` | Edge-mode personalization renderer |
| `PersonalizeStandard` | Standard-mode personalization renderer |
| `Test` | Renders A/B test variations based on distribution |
| `TestEdge` | Edge-mode test renderer |
| `TestStandard` | Standard-mode test renderer |
| `Track` | Tracks behavior when content enters the viewport |
| `TrackFragment` | Tracks behavior on page load (no wrapper element) |
| `getUniformContext` | Get the Context instance from the nearest provider |
| `getScores` | Reactive access to visitor scores (Svelte 5 `$state`) |
| `getQuirks` | Reactive access to visitor quirks (Svelte 5 `$state`) |
| `isPersonalized` | Check if inside a Personalize component |

### @uniformdev/canvas

| Export | Description |
| --- | --- |
| `RouteClient` | Client for resolving routes and fetching compositions |
| `flattenValues` | Extract values from asset parameters |
| `EMPTY_COMPOSITION` | Empty composition constant (for playground pages) |
| `RootComponentInstance` | Type for composition root data |
| `ComponentInstance` | Type for individual component data |
| `CANVAS_DRAFT_STATE` | Constant for draft content state |
| `CANVAS_PUBLISHED_STATE` | Constant for published content state |

### @uniformdev/context

| Export | Description |
| --- | --- |
| `Context` | The core personalization and scoring engine |
| `CookieTransitionDataStore` | Store for persisting visitor data in cookies |
| `enableContextDevTools` | Plugin for enabling the Uniform DevTools browser extension |
| `enableDebugConsoleLogDrain` | Plugin for debug logging to console |
| `ManifestV2` | Type for the personalization manifest |
| `UNIFORM_DEFAULT_COOKIE_NAME` | Default cookie name for visitor data |

---

## Type definitions

### ComponentProps

```ts
type ComponentProps<TProps = unknown> = TProps & {
  component: ComponentInstance | RootComponentInstance;
};
```

### ComponentMap

```ts
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)

### RenderComponentResolver

```ts
type RenderComponentResolver = (
  component: ComponentInstance
) => Component<ComponentProps<any>> | null;
```

### UniformContextComponentProps

```ts
type UniformContextComponentProps = {
  context: Context;
  outputType?: 'standard' | 'edge';
  trackRouteOnRender?: boolean;
  includeTransferState?: 'always' | 'never' | 'server-only';
};
```

### PersonalizeComponentProps

```ts
type PersonalizeComponentProps<TVariation> = {
  name: string;
  variations: TVariation[];
  component: Component<TVariation & { personalizationResult: PersonalizationResult }>;
  algorithm?: string;
  wrapperComponent?: Component<{ personalizationOccurred: boolean }>;
  count?: number;
  compositionMetadata?: CompositionMetadata;
};
```

### TestComponentProps

```ts
type TestComponentProps<TVariation> = {
  name: string;
  variations: TVariation[];
  component: Component<TVariation>;
  loadingMode?: 'default' | 'none' | Component;
  compositionMetadata?: CompositionMetadata;
};
```
