Disable or Enable Features

Enable Feature#

The following API allows to enable a custom or built-in feature (see the list of built-in features below):

enable(featureId: FeatureId | FeatureId[])

This method enables one or more features using their default predicates. If you need custom predicate logic, use the set() method instead (see below).

Tip: FeatureId can be an arbitrary string, so you can use this mechanism to toggle your own custom features, as well.

Example: Enable Single Feature#

// Enable a feature with its default predicate
cesdk.feature.enable('ly.img.delete');

Example: Enable Multiple Features#

// Enable multiple features at once
cesdk.feature.enable(['ly.img.delete', 'ly.img.duplicate']);

Example: Enable with Glob Pattern#

// Enable all video features
cesdk.feature.enable('ly.img.video.*');

// Enable all crop features
cesdk.feature.enable('ly.img.crop.*');

Disable Feature#

The disable() method provides a convenient way to explicitly disable one or more features:

disable(featureId: FeatureId | FeatureId[])

This method disables features by setting their enable/disable state to false. Note that disable() works best with enable() for simple on/off control. If you’ve used set() with boolean predicates, those will be evaluated first and may override the disable state.

Example: Disable Single Feature#

cesdk.feature.disable('ly.img.delete');

Example: Disable Multiple Features#

cesdk.feature.disable(['ly.img.delete', 'ly.img.duplicate']);

Example: Disable with Glob Pattern#

// Disable all video features
cesdk.feature.disable('ly.img.video.*');

// Disable all crop features
cesdk.feature.disable('ly.img.crop.*');

Set Feature#

The set() method is the unified approach for configuring feature state with custom predicates:

set(featureId: FeatureId, enabled: boolean | FeaturePredicate)

The enabled parameter can be:

• A boolean (true or false) to enable or disable the feature
• A function (predicate) that takes a context and returns a boolean

The predicate function receives an EnableFeatureContext with:

• engine: CreativeEngine - The engine instance
• isPreviousEnable: () => boolean - Returns the result of any previously registered predicates
• defaultPredicate: () => boolean - Returns the result of the default predicate

Understanding Predicate Chaining and Evaluation Order#

Multiple predicates can be registered for the same feature, forming a predicate chain. Understanding the evaluation order is crucial:

Evaluation Order:

1. Most recent set() predicate runs FIRST
2. Older set() predicates in reverse chronological order (most recent first)
3. enable()/disable() state runs LAST

This means:

• set() predicates can override enable() and disable() - They’re evaluated first
• Boolean predicates are always terminal - They immediately return their value without continuing the chain
• Function predicates control the chain - The function implementation decides whether to call isPreviousEnable() (continue chain) or return directly (end chain)

Key Principles:

• Use enable() and disable() for simple on/off control
• Use set() when you need custom logic or want to override enable/disable
• Each set() call adds a new predicate to the front of the chain
• Boolean predicates (true/false) are always terminal - they cannot continue the chain
• Function predicates decide whether to continue the chain by calling isPreviousEnable(), or end it by returning directly

Example: Enable Feature#

cesdk.feature.set('ly.img.delete', true);

Example: Disable Feature#

cesdk.feature.set('ly.img.delete', false);

Important: Using set() with a boolean creates a terminal predicate. If you later call enable() or disable(), they won’t have an effect because set() predicates are evaluated first:

// This creates a terminal predicate
cesdk.feature.set('ly.img.delete', true);

// This won't disable the feature because set(true) is terminal
cesdk.feature.disable('ly.img.delete');
// Feature is still enabled!

// For simple on/off, use enable() and disable() instead:
cesdk.feature.enable('ly.img.delete'); // Enabled
cesdk.feature.disable('ly.img.delete'); // Now disabled

Example: Custom Predicate#

cesdk.feature.set('ly.img.delete', ({ engine }) => {
  const selectedBlocks = engine.block.findAllSelected();
  return selectedBlocks.length > 0;
});

Example: Extending Default Predicate#

You can extend the default predicate provided for built-in features:

cesdk.feature.set('ly.img.delete', ({ defaultPredicate }) => {
  // Only allow delete after 10 pm
  return defaultPredicate() && new Date().getHours() >= 22;
});

Example: Chaining Predicates#

Predicates can access the result of previously registered predicates:

// First, enable with default
cesdk.feature.enable('my.feature');

// Then, add additional logic that chains with previous predicates
cesdk.feature.set('my.feature', ({ isPreviousEnable }) => {
  // Disable the feature after 10 pm, otherwise use previous result
  return new Date().getHours() >= 22 ? false : isPreviousEnable();
});

Example: Overwriting Defaults for Custom Block Types#

Let’s say you introduced a new kind of block that represents an Avatar. You want to hide the duplicate & delete buttons in the canvas menu for this block:

cesdk.feature.set('ly.img.delete', ({ engine, isPreviousEnable }) => {
  const selectedBlock = engine.block.findAllSelected()[0];
  const kind = engine.block.getKind(selectedBlock);
  if (kind === 'avatar') {
    return false;
  } else {
    return isPreviousEnable();
  }
});

cesdk.feature.set('ly.img.duplicate', ({ engine, isPreviousEnable }) => {
  const selectedBlock = engine.block.findAllSelected()[0];
  const kind = engine.block.getKind(selectedBlock);
  if (kind === 'avatar') {
    return false;
  } else {
    return isPreviousEnable();
  }
});

Example: Glob Pattern with Predicate#

// Apply custom logic to all video features
cesdk.feature.set('ly.img.video.*', ({ engine }) => {
  return engine.scene.getMode() === 'Video';
});

Check Feature#

The following API allows to query if the feature is currently enabled:

isEnabled(featureId: FeatureId): boolean

This method returns true if the feature is currently enabled, false otherwise.

Example#

if (!cesdk.feature.isEnabled('ly.img.navigation.close')) {
  return null;
}

// Check multiple features
if (
  cesdk.feature.isEnabled('ly.img.delete') &&
  cesdk.feature.isEnabled('ly.img.duplicate')
) {
  console.log('Both delete and duplicate are enabled');
}

// Check with glob pattern
if (cesdk.feature.isEnabled('ly.img.video.*')) {
  console.log('All video features are enabled');
}

List Features#

The list() method returns all registered feature IDs, with optional pattern matching:

list(options?: { matcher?: string }): FeatureId[]

This method is useful for discovering available features and debugging feature configurations.

Example: List All Features#

const allFeatures = cesdk.feature.list();
console.log('All features:', allFeatures);

Example: List with Pattern Matching#

// List all video features
const videoFeatures = cesdk.feature.list({ matcher: 'ly.img.video.*' });

// List all crop features
const cropFeatures = cesdk.feature.list({ matcher: 'ly.img.crop.*' });

// List all navigation features
const navFeatures = cesdk.feature.list({ matcher: 'ly.img.navigation.*' });

Get Feature Predicates#

The get() method allows you to retrieve the predicates associated with a feature:

get(featureId: FeatureId): FeaturePredicate[] | undefined

This is useful for debugging or understanding what predicates have been registered for a feature.

Example#

const predicates = cesdk.feature.get('ly.img.delete');
console.log(`Feature has ${predicates?.length || 0} predicates`);

Glob Pattern Support#

All main Feature API methods support glob pattern matching for batch operations, allowing you to control multiple related features at once.

Supported Methods#

• enable(pattern) - Enable all matching features
• disable(pattern) - Disable all matching features
• set(pattern, predicate) - Set all matching features
• isEnabled(pattern) - Check if all matching features are enabled
• list({ matcher: pattern }) - List features matching pattern

Pattern Syntax#

• * matches any sequence of characters within a segment
• ly.img.video.* matches all features starting with ly.img.video.
• ly.img.crop.* matches all features starting with ly.img.crop.

Examples#

// Enable all video features
cesdk.feature.enable('ly.img.video.*');

// Disable all crop features
cesdk.feature.disable('ly.img.crop.*');

// Check if all navigation features are enabled
const allEnabled = cesdk.feature.isEnabled('ly.img.navigation.*');

// Set all filter features with custom predicate
cesdk.feature.set('ly.img.filter.*', ({ engine }) => {
  const selectedBlocks = engine.block.findAllSelected();
  return selectedBlocks.some((id) => engine.block.hasEffects(id));
});

// List all features in a namespace
const allVideoFeatures = cesdk.feature.list({ matcher: 'ly.img.video.*' });

Best Practices#

• Use glob patterns to manage related features together
• Combine with predicates for conditional bulk operations
• Use list() with matchers to discover available features in a namespace

Built-In Features#

The following features are built-in to CE.SDK: