Search Docs
Loading...
Skip to content

Perfectly Clear Editor for SvelteKit

One-click image enhancement using the Perfectly Clear (eyeQ) plugin — scene-aware correction running entirely in-browser via WebAssembly.

Perfectly Clear Editor starter kit showing Image enhancement interface

10 mins
estimated time
Download
StackBlitz
GitHub

Prerequisites#

Before you begin, make sure you have the following:

  • Node.js v20+ and npm installed locally – Download Node.js
  • A supported browser – Chrome 114+, Edge 114+, Firefox 115+, Safari 15.6+
    See Browser Support for the full list.
  • A Perfectly Clear (eyeQ) API key authorized for the origin you’ll run on (the runtime validates the page hostname). Contact your Perfectly Clear account manager or see the Perfectly Clear plugin guide.
New Project
Existing Project

Get Started#

Create a new SvelteKit application with Perfectly Clear Editor integration.

Step 1: Create a New Project#

Terminal
npm create svelte@latest your-project-name
cd your-project-name
npm install
npm create svelte@latest your-project-name
cd your-project-name
npm install

Step 2: Clone the Starter Kit#

Clone the starter kit and copy the editor configuration to your project:

Terminal
git clone https://github.com/imgly/starterkit-perfectlyclear-editor-ts-web.git
cp -r starterkit-perfectlyclear-editor-ts-web/src/imgly ./src/lib/imgly
rm -rf starterkit-perfectlyclear-editor-ts-web
git clone https://github.com/imgly/starterkit-perfectlyclear-editor-ts-web.git
cp -r starterkit-perfectlyclear-editor-ts-web/src/imgly ./src/lib/imgly
rm -rf starterkit-perfectlyclear-editor-ts-web

Step 3: Install Dependencies#

Core Editor#

Terminal
npm install @cesdk/cesdk-js@1.76.0
npm install @cesdk/cesdk-js@1.76.0

Perfectly Clear Plugin#

Terminal
npm install @imgly/plugin-perfectlyclear-web@1.76.0
npm install @imgly/plugin-perfectlyclear-web@1.76.0

Step 4: Download Assets#

Terminal
curl -O https://cdn.img.ly/packages/imgly/cesdk-js/1.76.0/imgly-assets.zip
unzip imgly-assets.zip -d static/
rm imgly-assets.zip
curl -O https://cdn.img.ly/packages/imgly/cesdk-js/1.76.0/imgly-assets.zip
unzip imgly-assets.zip -d static/
rm imgly-assets.zip

Step 5: Create the Editor Component#

Create src/lib/PerfectlyClearEditor.svelte:

<script lang="ts">
  import { onMount, onDestroy } from 'svelte';
  import { browser } from '$app/environment';
  import type CreativeEditorSDK from '@cesdk/cesdk-js';
  import { initPerfectlyClearEditor } from '$lib/imgly';


  let container: HTMLDivElement;
  let cesdk: CreativeEditorSDK | null = null;


  onMount(async () => {
    if (browser) {
      const CreativeEditorSDK = (await import('@cesdk/cesdk-js')).default;
      cesdk = await CreativeEditorSDK.create(container, {
        baseURL: '/assets',
      });
      await initPerfectlyClearEditor(cesdk, { perfectlyClear: { apiKey: 'YOUR_PFC_API_KEY' } });
    }
  });


  onDestroy(() => {
    cesdk?.dispose();
  });
</script>


<div bind:this={container} style="width: 100%; height: 100vh;"></div>

Step 6: Use the Component#

Use the component in a page route (e.g., src/routes/+page.svelte):

<script lang="ts">
  import PerfectlyClearEditor from '$lib/PerfectlyClearEditor.svelte';
</script>


<PerfectlyClearEditor />

Using Image Enhancement#

The editor provides two ways to generate Image enhancements:

Via Dock Panel#

  1. Click the “Enhance” button in the canvas menu (left sidebar)
  2. The selected block enters a pending state while the WebAssembly runtime processes the image
  3. Enter your URL or text content
  4. Customize colors and size
  5. Click “Generate” to add the Image enhancement to your design

Via Canvas Menu#

  1. Right-click on the canvas
  2. Select “Enhance” from the canvas menu
  3. The selected block enters a pending state while the WebAssembly runtime processes the image

Customize Assets#

The Perfectly Clear Editor uses asset source plugins to provide built-in libraries for templates, stickers, shapes, and fonts. The starter kit includes a curated selection—customize what’s included based on your needs.

Asset sources are added via plugins in src/imgly/index.ts. Enable or disable individual sources:

src/imgly/index.ts
import {
  FiltersAssetSource,
  StickerAssetSource,
  TextAssetSource,
  VectorShapeAssetSource,
  EffectsAssetSource,
  // ...
} from '@cesdk/cesdk-js/plugins';


// Add only the sources you need
await cesdk.addPlugin(new FiltersAssetSource());
await cesdk.addPlugin(new StickerAssetSource());
await cesdk.addPlugin(new TextAssetSource());
await cesdk.addPlugin(new VectorShapeAssetSource());
await cesdk.addPlugin(new EffectsAssetSource());
// ...

For production deployments, self-hosting assets is required—the IMG.LY CDN is intended for development only. See Serve Assets for downloading assets, configuring baseURL, and excluding unused sources to optimize load times.

Configure Actions#

Actions are functions that handle user interactions like exporting designs, saving scenes, and importing files. CE.SDK provides built-in actions that you can run directly or override with custom implementations.

Key built-in actions:

  • exportDesign – Export the current design to PNG, JPEG, PDF, or other formats
  • saveScene – Save the scene as a JSON string for later editing
  • importScene – Import a previously saved scene (supports .scene and .cesdk formats)
  • exportScene – Export the scene as a JSON file or .cesdk archive with all assets
  • uploadFile – Handle file uploads with progress tracking

Use cesdk.actions.run() to execute any action:

// Run a built-in action
await cesdk.actions.run('exportDesign', { mimeType: 'image/png' });

Export and Save#

src/imgly/config/actions.ts
// Register export action that downloads the edited design
cesdk.actions.register('exportDesign', async (exportOptions) => {
  const { blobs, options } = await cesdk.utils.export(exportOptions);
  await cesdk.utils.downloadFile(blobs[0], options.mimeType);
});

Customize (Optional)#

Theming#

CE.SDK supports light and dark themes out of the box, plus automatic system preference detection. Switch between themes programmatically:

src/imgly/config/settings.ts
// 'light' | 'dark' | 'system' | (() => 'light' | 'dark')
cesdk.ui.setTheme('dark');

See Theming for custom color schemes, CSS variables, and advanced styling options.

Localization#

Customize UI labels and add support for multiple languages. The i18n system supports translation keys for all UI elements:

src/imgly/config/i18n.ts
// Override specific labels
cesdk.i18n.setTranslations({
  en: {
    'actions.export.image': 'Download Design',
    'common.cancel': 'Cancel',
    'common.apply': 'Apply'
  }
});


// Add a new language
cesdk.i18n.setTranslations({
  de: {
    'actions.export.image': 'Design herunterladen'
  }
});


// Set the active locale
cesdk.i18n.setLocale('de');

See Localization for supported languages, translation key reference, and right-to-left language support.

UI Layout#

CE.SDK Editor UI Areas

Customize the editor interface by modifying the dock, inspector bar, navigation bar, and canvas menu. CE.SDK provides Order APIs to control which components appear and in what sequence.

src/imgly/config/ui/navigationBar.ts
// Get current navigation bar components
const navOrder = cesdk.ui.getNavigationBarOrder();


// Add a custom button to the navigation bar
cesdk.ui.insertNavigationBarOrderComponent(
  'ly.img.spacer',
  { id: 'my-custom-action' },
  'after'
);


// Rearrange dock items
cesdk.ui.setDockOrder([
  'ly.img.assetLibrary.dock',
  'ly.img.separator',
  'my-custom-dock-item'
]);

See Dock, Inspector Bar, Navigation Bar, Canvas Menu, and Canvas for detailed layout customization options.

Key Capabilities#

Image Enhancement

Image Enhancement

Generate customizable Image enhancements with custom colors, sizes, and content. Add them to any design with a single click.

Professional Filters

Professional Filters

Apply color grading with LUT filters, duotone effects, and customizable image adjustments.

Text & Typography

Text & Typography

Add styled text with comprehensive typography controls, fonts, and visual effects.

Asset Libraries

Asset Libraries

Access built-in collections of templates, stickers, shapes, and graphics, plus import custom assets.

Privacy-First

Privacy-First

All processing happens locally in the browser. No data is sent to external servers.

Export Options

Export Options

Export to multiple formats including PNG, JPEG, and PDF with quality and size controls.


Troubleshooting#

SSR Error: “window is not defined”#

CE.SDK requires browser APIs. Use dynamic imports with the browser check from $app/environment to ensure client-only loading.

Image enhancement panel doesn’t open#

  • Check plugin installation: Ensure @imgly/plugin-perfectlyclear-web is installed (and that you pass a valid apiKey)
  • Verify plugin setup: Check that setupPerfectlyClearPlugin(cesdk, { apiKey }) is called with a non-empty key during initialization

Watermark appears in production#

  • Add your license key: Set the license property in your configuration
  • Sign up for a trial: Get a free trial license at img.ly/forms/free-trial

Next Steps#

  • Configuration – Complete list of initialization options
  • Serve Assets – Self-host engine assets for production
  • Actions – Build custom export and save workflows
  • Theming – Customize colors and appearance