Get component settings (Beta)

component.getSettings()

Retrieves the settings of a component, including its name, group, and description. Returns empty strings for group and description if they are not set. To get only the name of a component, see Get component name.

Syntax

1
component.getSettings(): Promise<ComponentSettings>

Returns

Promise<ComponentSettings>

A Promise that resolves to a ComponentSettings object with the following properties:

Example

1
const components = await webflow.getAllComponents();
2
const component = components[0];
3
4
const settings = await component.getSettings();
5
console.log(settings.name);        // 'Hero Section'
6
console.log(settings.group);       // 'Sections'
7
console.log(settings.description); // 'A reusable hero with heading and CTA'

Designer Ability

Checks for authorization only