Skip to content

AI-native design editor. Open-source Figma alternative.

1004 B
Raw Blame

title: useEffectsControls description: Effects-panel helpers for shadows, blurs, expansion state, and scrub/commit flows.

useEffectsControls

useEffectsControls() is the effects-property composable used by effects panels.

It provides helpers for:

  • default effects
  • shadow vs blur logic
  • expanded item state
  • scrub-preview editing
  • commit-on-finish updates
  • effect type and color changes

Usage

import { useEffectsControls } from '@open-pencil/vue/controls/effects'

const effects = useEffectsControls()

Basic example

const { effectOptions, createDefaultEffect, toggleExpand, scrubEffect, commitEffect } = useEffectsControls()

Practical examples

Add a default effect

const effect = effects.createDefaultEffect()

Preview scrub changes, then commit

effects.scrubEffect(node, index, { radius: 12 })
effects.commitEffect(node, index, { radius: 12 })

Related APIs