Set component settings (Beta)

`component.setSettings(settings)`

Updates one or more settings on a component. All fields are optional; only the fields that you provide are updated. Changes take effect immediately without requiring an explicit save. To set only the name of a component, see Set component name.

Beta

These methods are in public beta and may change with future releases.

Syntax

1 component.setSettings(settings: Partial<ComponentSettings>): Promise<null>

Parameters

settings : Partial<ComponentSettings> — An object containing the fields to update. All fields are optional.

Property	Type	Required	Description
`name`	`string`	No	A new name for the component. Must be a non-empty string.
`group`	`string`	No	A group for the component. Pass an empty string to remove the group.
`description`	`string`	No	A description for the component. Pass an empty string to clear it.

Returns

Promise<null>

A Promise that resolves to null once the settings have been updated.

Example

1 const components = await webflow.getAllComponents();
2 const component = components[0];
3 
4 // Update only the description
5 await component.setSettings({
6   description: 'Updated hero layout with video background',
7 });
8 
9 // Move to a different group
10 await component.setSettings({ group: 'Legacy' });
11 
12 // Update all settings at once
13 await component.setSettings({
14   name: 'Hero Section v2',
15   group: 'Sections',
16   description: 'Redesigned hero component',
17 });

Try this example

Designer Ability

Designer Ability	Permission	Locale	Branch	Workflow	Sitemode
canModifyComponents	any	any	any	Canvas	Design

1	const components = await webflow.getAllComponents();
2	const component = components[0];
3
4	// Update only the description
5	await component.setSettings({
6	description: 'Updated hero layout with video background',
7	});
8
9	// Move to a different group
10	await component.setSettings({ group: 'Legacy' });
11
12	// Update all settings at once
13	await component.setSettings({
14	name: 'Hero Section v2',
15	group: 'Sections',
16	description: 'Redesigned hero component',
17	});