Skip to content

UIBlurEffect ​

UIBlurEffect represents a blur effect: it blurs what is behind a visual effect view and covers it with a translucent layer of color. The blur style is fixed at creation.

A blur effect is immutable and has no properties; the same object can be given to multiple effect views. Once created, you can't read back which style it is.

Inheritance: EventTarget → NSObject → UIVisualEffect → UIBlurEffect

For how to use it to make a blurred panel, see the guide Creating blur and glass effects.

Constructor ​

It can't be created with new: new UIBlurEffect() throws TypeError: Illegal constructor: UIBlurEffect is not created with new; use UIBlurEffect.effectWithStyle(style). Use the static method below.

Static methods ​

UIBlurEffect.effectWithStyle()

Creates a blur effect with a given style. Most interfaces use the 'systemMaterial' group, which follows light and dark mode.

Examples ​

js
const blur = UIBlurEffect.effectWithStyle('systemMaterial');
const panel = new UIVisualEffectView(blur);
const toolbar = new UIVisualEffectView(blur);

Effect: panel and toolbar share the same blur effect, and both show a standard-thickness blur. Not verified in the simulator.

Corresponding iOS API ​

ObjCJS
[UIBlurEffect effectWithStyle:UIBlurEffectStyleSystemMaterial]UIBlurEffect.effectWithStyle('systemMaterial')

See also ​