Svelte

SSR CSR

Installation

Install the Svelte 5+ package with your preferred package manager. Use a Svelte-aware bundler so it resolves the package’s svelte export.

npm install @pictum/svelte

pnpm add @pictum/svelte

bun add @pictum/svelte

yarn add @pictum/svelte

Agent skill

Install the Svelte integration skill for coding agents that support Agent Skills:

npx skills add usepictum/skills@svelte

Icons

Render an icon with Icon, or use icon() when you need its URL or SVG markup in a script.

<script lang="ts">
import { Icon } from "@pictum/svelte";
</script>

<Icon
  name="devicon:svelte"
  aria-label="Svelte"
  class="size-6"
/>

import { icon } from "@pictum/svelte";

// Generate the URL without making a request.
const url = icon("devicon:svelte").url;

// Fetch canonical SVG markup.
const svg = await icon("devicon:svelte").svg();

Avatars

Render a generated avatar or portrait with Avatar, or use avatar() to pass the selected image URL to another service. Generated avatars also provide canonical SVG markup.

<script lang="ts">
import { Avatar } from "@pictum/svelte";
</script>

<Avatar
  seed="customer-123"
  variant="portrait"
  gender="female"
  format="webp"
  size={256}
  alt="Customer"
  class="size-10"
/>

import { avatar } from "@pictum/svelte";

// Generate the URL without making a request.
const url = avatar("customer-123", {
  variant: "portrait",
  gender: "female",
  format: "webp",
}).url;

// Fetch canonical SVG markup.
const svg = await avatar("ada-lovelace", {
  variant: "monogram",
}).svg();

QR codes

Render scannable text or URLs with QrCode, or use qrCode() when script code needs the image URL or canonical SVG.

<script lang="ts">
import { QrCode } from "@pictum/svelte";
</script>

<QrCode
  value="https://pictum.dev"
  format="svg"
  quietZone={false}
  foreground="#4c1d95ff"
  background="#ede9fe"
  aria-label="Open Pictum"
  class="size-32"
/>

import { qrCode } from "@pictum/svelte";

// Generate the URL without making a request.
const url = qrCode("https://pictum.dev", {
  format: "svg",
  quietZone: false,
  foreground: "#4c1d95ff",
  background: "#ede9fe",
}).url;

// Fetch canonical SVG markup.
const svg = await qrCode("https://pictum.dev").svg();

Placeholders

Render square or custom-dimension images with Placeholder, or use placeholder() when script code needs the selected image URL or SVG markup.

<script lang="ts">
import { Placeholder } from "@pictum/svelte";
</script>

<Placeholder
  size={320}
  format="webp"
  density={2}
  background="#ffffff"
  color="#6d28d9"
  text="Coming soon"
  alt="Coming soon"
/>

import { placeholder } from "@pictum/svelte";

// Generate a custom-dimension URL without making a request.
const url = placeholder({
  width: 640,
  height: 360,
  format: "webp",
  density: 3,
  text: "Coming soon",
}).url;

// Fetch a square as canonical SVG markup.
const svg = await placeholder({
  size: 320,
  text: "Coming soon",
}).svg();

Use reactive helpers

Use useIcon, useAvatar, useQrCode, and usePlaceholder with values or getter functions. Read the current asset through .current.

<script lang="ts">
  import { useAvatar } from "@pictum/svelte";

  let seed = $state("customer-123");
  const asset = useAvatar(() => seed, { variant: "monogram" });
</script>

<img src={asset.current.url} alt="Customer" />

The package also re-exports the raw icon(), avatar(), qrCode(), and placeholder() helpers. Raw helpers return an asset immediately. Reading .url makes no request; .svg() fetches canonical SVG markup and is unavailable for portrait avatars.

Custom deployment

You do not need a provider to use Pictum’s production API. Components and reactive helpers work immediately after installation. Only add PictumProvider when a subtree should use another Pictum deployment:

<script lang="ts">
  import { PictumProvider } from "@pictum/svelte";
</script>

<PictumProvider options={{ baseUrl: "https://assets.example.com/v1" }}>
  <Dashboard />
</PictumProvider>

Pass options={{ baseUrl }} to one component or pass options to a use* reactive helper to override the provider. Raw helpers do not read provider context; pass baseUrl directly to those calls.

Getting started

Assets

Integrations

Reference

Installation

Agent skill

Icons

Avatars

QR codes

Placeholders

Use reactive helpers

Custom deployment

​Installation

​Agent skill

​Icons

​Avatars

​QR codes

​Placeholders

​Use reactive helpers

​Custom deployment

Installation

Agent skill

Icons

Avatars

QR codes

Placeholders

Use reactive helpers

Custom deployment