Search Docs
Loading...
Skip to content

Content Moderation Editor

Content moderation made easy. Decide what type of imagery to restrict and receive automatic notifications flagging content that might be violating your guidelines.

Content Moderation Editor starter kit showing content validation interface

10 mins
estimated time
Download
StackBlitz
GitHub

Pre-requisites#

This guide assumes basic familiarity with JavaScript or TypeScript.

  • Node.js v20+ with npm – Download
  • Supported browsers – Chrome 114+, Edge 114+, Firefox 115+, Safari 15.6+
    See Browser Support for the full list
New Project
Existing Project

Get Started#

Start fresh with a standalone Content Moderation Editor project. This creates a complete, ready-to-run React application.

Step 1: Clone the Repository#

Terminal
git clone https://github.com/imgly/starterkit-content-moderation-react-web.git
git clone https://github.com/imgly/starterkit-content-moderation-react-web.git

The src/ folder contains the editor code:

src/
├── app/                          # Demo application
├── imgly/
│   ├── config/
│   │   ├── actions.ts                # Export/import actions
│   │   ├── features.ts               # Feature toggles
│   │   ├── i18n.ts                   # Translations
│   │   ├── plugin.ts                 # Main configuration plugin
│   │   ├── settings.ts               # Engine settings
│   │   └── ui/
│   │       ├── canvas.ts                 # Canvas configuration
│   │       ├── components.ts             # Custom component registration
│   │       ├── dock.ts                   # Dock layout configuration
│   │       ├── index.ts                  # Combines UI customization exports
│   │       ├── inspectorBar.ts           # Inspector bar layout
│   │       ├── navigationBar.ts          # Navigation bar layout
│   │       └── panel.ts                  # Panel configuration
│   └── index.ts                  # Editor initialization function
└── index.tsx                 # Application entry point

Step 2: Install Dependencies#

Install the required packages:

Terminal
cd starterkit-content-moderation-react-web
npm install
cd starterkit-content-moderation-react-web
npm install

Step 3: Download Assets#

CE.SDK requires engine assets (fonts, icons, UI elements) to function. These must be served as static files from your project’s public/ directory.

Terminal
curl -O https://cdn.img.ly/packages/imgly/cesdk-js/1.73.0/imgly-assets.zip
unzip imgly-assets.zip -d public/
rm imgly-assets.zip
curl -O https://cdn.img.ly/packages/imgly/cesdk-js/1.73.0/imgly-assets.zip
unzip imgly-assets.zip -d public/
rm imgly-assets.zip
src/index.tsx
const config = {
  // ...
  baseURL: '/assets'
  // ...
};

Step 4: Run the Development Server#

Terminal
npm run dev
npm run dev

Open http://localhost:5173 in your browser.

Set Up a Scene#

CE.SDK offers multiple ways to load content into the editor. Choose the method that matches your use case:

src/index.ts
// Create a blank design canvas - starts with an empty design scene
await cesdk.actions.run('scene.create');


// Load from a template archive - restores a previously saved project
await cesdk.loadFromArchiveURL('https://example.com/template.zip');


// Load from an image URL - creates a new scene with the image
await cesdk.createFromImage('https://example.com/image.jpg');


// Load from a scene file - restores a scene from JSON
await cesdk.loadFromURL('https://example.com/scene.json');

The createDesignScene() method is ideal for design workflows, as it creates a blank canvas ready for content.

Customize Assets#

The Content Moderation 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' });

Import from File Picker#

src/imgly/config/actions.ts
// Let users open images from their device
cesdk.actions.register('importImage', async () => {
  const blobURL = await cesdk.utils.loadFile({
    accept: 'image/*',
    returnType: 'objectURL'
  });
  await cesdk.createFromImage(blobURL);
});

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);
});

Upload to Your Backend#

src/imgly/config/actions.ts
// Override the built-in exportDesign action to send to your server
cesdk.actions.register('exportDesign', async (exportOptions) => {
  const { blobs } = await cesdk.utils.export(exportOptions);


  const formData = new FormData();
  formData.append('design', blobs[0], 'design.png');


  const response = await fetch('/api/upload', {
    method: 'POST',
    body: formData
  });


  const { url } = await response.json();
  console.log('Uploaded to:', url);
});

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'
]);


// Customize the inspector bar
cesdk.ui.setInspectorBarOrder([
  'ly.img.fill.inspectorBar',
  'ly.img.separator',
  'ly.img.filter.inspectorBar'
]);

The Order API methods follow a consistent pattern across all UI areas:

  • get*Order() – Retrieve the current component order
  • set*Order() – Replace the entire order
  • insert*OrderComponent() – Add components relative to existing ones

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

Custom Components#

Build custom UI components using the builder system and integrate them in the editor. Custom components receive reactive state updates and can interact with the engine API.

src/imgly/config/ui/components.ts
// Register a custom component
cesdk.ui.registerComponent('my-custom-button', ({ builder, engine }) => {
  const selectedBlocks = engine.block.findAllSelected();


  builder.Button('apply-effect', {
    label: 'Apply Effect',
    isDisabled: selectedBlocks.length === 0,
    onClick: () => {
      // Apply custom logic to selected blocks
    }
  });
});


// Add the component to the navigation bar
cesdk.ui.insertNavigationBarOrderComponent(
  'ly.img.spacer',
  'my-custom-button',
  'after'
);

Custom components automatically re-render when the engine state they depend on changes—no manual subscription management required.

See Register New Component for the complete builder API and component patterns.

Settings & Features#

Fine-tune editor behavior through settings and features.

Settings configure core engine behavior—rendering, input handling, and history management:

src/imgly/config/settings.ts
cesdk.engine.editor.setSettingBool('page/dimOutOfPageAreas', true);
cesdk.engine.editor.setSettingBool('mouse/enableZoomControl', true);
cesdk.engine.editor.setSettingBool('features/undoHistory', true);

Features toggle which editing tools and panels appear in the UI:

src/imgly/config/features.ts
// Toggle editor features
cesdk.feature.enable('ly.img.crop', true);
cesdk.feature.enable('ly.img.filter', true);
cesdk.feature.enable('ly.img.adjustment', true);

See Settings and Features for the complete reference.

Explore Plugins#

CE.SDK has a rich plugin ecosystem that extends the editor with powerful capabilities. Plugins can add new features, integrate third-party services, or customize editor behavior.

Background Removal#

Add AI-powered background removal that runs entirely client-side. The background removal plugin processes images directly in the browser without sending data to external servers.

src/imgly/config/plugin.ts
import BackgroundRemovalPlugin from '@imgly/plugin-background-removal';


// Add background removal capability
await cesdk.addPlugin(BackgroundRemovalPlugin());

See Background Removal for setup instructions and configuration options.

Export print-ready PDF/X-3 files with CMYK color profiles for professional printing workflows.

src/imgly/config/plugin.ts
import PrintReadyPDFPlugin from '@imgly/plugin-print-ready-pdf';


// Add print-ready PDF export capability
await cesdk.addPlugin(PrintReadyPDFPlugin());

See Print Ready PDF for setup instructions and configuration options.

AI Integration#

Extend the editor with generative AI capabilities for text-to-image generation, image enhancement, and intelligent editing features. CE.SDK integrates with various AI providers.

src/imgly/config/plugin.ts
import AIPlugin from '@imgly/plugin-ai-generation';


// Configure AI generation
await cesdk.addPlugin(AIPlugin({
  provider: 'your-ai-provider',
  apiKey: 'your-api-key'
}));

See AI Integration for provider setup and supported AI features.

Custom Asset Sources#

Connect external asset libraries like Unsplash, Getty Images, or your own content management system. Asset sources let users browse and insert content from any source.

src/imgly/config/plugin.ts
import UnsplashAssetSource from '@imgly/plugin-unsplash';


// Add Unsplash integration
await cesdk.addPlugin(UnsplashAssetSource({
  accessKey: 'your-unsplash-access-key'
}));

See Custom Asset Sources for integration patterns.

Discover More Plugins#

Explore the full plugin ecosystem in the IMG.LY plugins repository. Available plugins include:

  • Vectorizer – Convert raster images to vectors
  • Design Presets – Pre-built design templates
  • Social Media Templates – Platform-specific sizing
  • And more – Check the repository for the latest additions

How Content Moderation Works#

The Content Moderation Editor adds a validation sidebar that checks all images in your design against content policies. When users click “Validate Content”, the system:

  1. Finds all image blocks in the current scene
  2. Sends each image to a content moderation API
  3. Displays results with visual indicators (success, warning, failed)
  4. Allows block selection to quickly navigate to flagged content

Validation Flow#

The moderation check scans images for four categories of inappropriate content:

src/moderation.ts
import type { CreativeEngine } from '@cesdk/cesdk-js';


import { getImageUrl } from './imgly/utils';


// Check all images in the scene
export async function checkImageContent(
  engine: CreativeEngine
): Promise<ModerationResult[]> {
  // Find all image blocks
  const imageBlocks = engine.block
    .findByKind('image')
    .map((blockId) => ({
      blockId,
      url: getImageUrl(engine, blockId) ?? '',
      blockName: engine.block.getName(blockId)
    }))
    .filter(({ url }) => url);


  // Check each image against the moderation API
  const results = await Promise.all(
    imageBlocks.flatMap(async (block) => {
      const categories = await checkImageContentAPI(block.url);
      return categories.map((category) => ({
        ...category,
        ...block
      }));
    })
  );


  return results.flat();
}

Content Categories#

The moderation API checks for:

CategoryDescriptionThreshold
WeaponsHandguns, rifles, machine guns, threatening knives>80% = failed, >40% = warning
AlcoholWine, beer, cocktails, champagne>80% = failed, >40% = warning
DrugsCannabis, syringes, glass pipes, bongs, pills>80% = failed, >40% = warning
NudityRaw or partial nudity>80% = failed, >40% = warning

Connecting Your Own API#

Replace the demo endpoint with your own content moderation service:

src/moderation.ts
const MODERATION_API_URL = 'https://your-api.example.com/moderate';


export async function checkImageContentAPI(
  url: string
): Promise<ModerationCheckResult[]> {
  const response = await fetch(MODERATION_API_URL, {
    method: 'POST',
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify({ imageUrl: url })
  });


  const results = await response.json();


  // Map your API response to ModerationCheckResult format
  return [
    {
      name: 'Weapons',
      description: 'Detected weapons in image',
      state: results.weapons > 0.8 ? 'failed' : results.weapons > 0.4 ? 'warning' : 'success'
    },
    // ... other categories
  ];
}

Block Selection#

When a user clicks “Select” on a flagged result, the editor navigates to that block:

src/imgly/utils.ts
import type { CreativeEngine } from '@cesdk/cesdk-js';


export function selectBlocks(engine: CreativeEngine, blockIds: number[]): void {
  engine.block.select(blockIds);
  // The editor automatically zooms to the selected block
}

Use Cases#

The Content Moderation Editor is designed for platforms that need to ensure user-generated content meets community guidelines and legal requirements. Common use cases include:

User-Generated Content Platforms#

Allow users to create and customize designs while automatically checking for policy violations before publishing:

src/app/publish.ts
// Validate before allowing publish
async function handlePublish(cesdk: CreativeEditorSDK) {
  const results = await checkImageContent(cesdk.engine);
  const violations = results.filter(r => r.state === 'failed');


  if (violations.length > 0) {
    // Block publish and show violations to user
    showViolationModal(violations);
    return;
  }


  // Safe to publish
  await publishDesign(cesdk);
}

Validate customer uploads before production to avoid printing inappropriate content on merchandise:

  • T-shirt and apparel customization – Check uploaded images before printing
  • Photo products – Validate images for photo books, calendars, and gifts
  • Marketing materials – Ensure brand-safe content for business cards and flyers

Marketing and Advertising Platforms#

Ensure ad creatives comply with platform policies before submission:

src/app/adValidation.ts
// Add custom categories for advertising compliance
const adPolicyResults = await checkImageContentAPI(imageUrl);


// Extend with platform-specific rules
const platformResults = await checkPlatformCompliance(imageUrl, {
  platform: 'facebook',
  rules: ['no-before-after', 'no-misleading-claims']
});

Enterprise Content Management#

Integrate moderation into design approval workflows:

  • Pre-approval validation – Automatically flag content before human review
  • Compliance logging – Track moderation results for audit trails
  • Role-based access – Allow admins to override warnings with justification

Customizing Moderation Rules#

Adjust thresholds and add custom categories based on your platform’s needs:

src/moderation.ts
// Custom threshold configuration
const THRESHOLDS = {
  strict: { failed: 0.5, warning: 0.2 },    // Family-friendly platforms
  moderate: { failed: 0.8, warning: 0.4 },  // General audience (default)
  relaxed: { failed: 0.95, warning: 0.7 }   // Adult-only platforms
};


function getState(confidence: number, mode: keyof typeof THRESHOLDS): ModerationState {
  const { failed, warning } = THRESHOLDS[mode];
  if (confidence > failed) return 'failed';
  if (confidence > warning) return 'warning';
  return 'success';
}

Key Capabilities#

The Content Moderation Editor includes everything needed for content validation workflows.

Content Detection

Content Detection

Automatically detect inappropriate content including weapons, alcohol, drugs, and nudity in images.

API Integration

API Integration

Connect to external content moderation APIs for comprehensive policy validation.

Visual Feedback

Visual Feedback

Display validation results with clear success, warning, and failure states for each check.

Block Selection

Block Selection

Automatically highlight and select blocks that fail content moderation checks.

Full Design Editing

Full Design Editing

Complete design editing capabilities with text, shapes, stickers, and image editing.

Export Options

Export Options

Export validated designs to multiple formats including PNG, JPEG, and PDF.


Troubleshooting#

Editor doesn’t load#

  • Check the container element exists: Ensure your container element is in the DOM before calling create()
  • Verify the baseURL: Assets must be accessible from the CDN or your self-hosted location
  • Check console errors: Look for CORS or network errors in browser developer tools

Moderation API fails#

  • Check network connectivity: Ensure the moderation API endpoint is accessible
  • Verify image URLs: Images must be publicly accessible URLs for the API to fetch
  • Check CORS settings: If using a custom API, ensure CORS headers allow requests from your domain

Results don’t appear#

  • Check for image blocks: Moderation only checks image blocks, not other content types
  • Verify images have URLs: Images must have valid source URLs to be checked

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
  • Localization – Add translations and language support