Skip to content

UIVibrancyEffect ​

UIVibrancyEffect represents a vibrancy effect: it makes text and icons placed over a blur pick up the colors of the content underneath, instead of being a flat layer of gray.

A vibrancy effect is built from a blur effect and used on another visual effect view: that effect view goes into the blur panel's contentView, and text and icons go into its own contentView.

A vibrancy effect is immutable and has no properties. Once created, you can't read back which style it is.

Inheritance: EventTarget → NSObject → UIVisualEffect → UIVibrancyEffect

Constructor ​

It can't be created with new; use the static method below.

Static methods ​

UIVibrancyEffect.effectForBlurEffect()

Creates a vibrancy effect from a blur effect. Choose style according to whether the content is text, filled shapes, or separators.

Examples ​

js
const blur = UIBlurEffect.effectWithStyle('systemMaterial');
const panel = new UIVisualEffectView(blur);
const vivid = new UIVisualEffectView(
  UIVibrancyEffect.effectForBlurEffect(blur, { style: 'label' }));
panel.contentView.addSubview(vivid);

Effect: Text placed in vivid.contentView picks up the colors of the content behind the panel. Not verified in the simulator.

Corresponding iOS API ​

ObjCJS
[UIVibrancyEffect effectForBlurEffect:blur]UIVibrancyEffect.effectForBlurEffect(blur)
[UIVibrancyEffect effectForBlurEffect:blur style:UIVibrancyEffectStyleLabel]UIVibrancyEffect.effectForBlurEffect(blur, { style: 'label' })

See also ​