> This page is for Designer API.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developers.webflow.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developers.webflow.com/_mcp/server.

# Get component settings (Beta)

> Retrieves the settings of a component, including its name, group, and description

## `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](/designer/reference/get-component-name).

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

### Syntax

```typescript
component.getSettings(): Promise<ComponentSettings>
```

### Returns

**Promise\<*ComponentSettings*>**

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

| Property      | Type     | Description                                                  |
| :------------ | :------- | :----------------------------------------------------------- |
| `name`        | `string` | The name of the component.                                   |
| `group`       | `string` | The group the component belongs to. Empty string if not set. |
| `description` | `string` | The description of the component. Empty string if not set.   |

### Example

```typescript
const components = await webflow.getAllComponents();
const component = components[0];

const settings = await component.getSettings();
console.log(settings.name);        // 'Hero Section'
console.log(settings.group);       // 'Sections'
console.log(settings.description); // 'A reusable hero with heading and CTA'
```

[Try this example](https://webflow.com/oauth/authorize?response_type=code\&client_id=19511de1ec410f9228d8dcbc9420e67916dea80d86d18f0c9a533eb475ea0f62)

---

### Designer Ability

Checks for authorization only

| Designer Ability    | Permission | Locale | Branch | Workflow | Sitemode |
| :------------------ | :--------- | :----- | :----- | :------- | :------- |
| **canAccessCanvas** | any        | any    | any    | any      | any      |