Set settings (Beta)

1
element.setSettings(settings: SetSettingsInput): Promise<Record<string, ResolvedValue | BindingInput | null>>

1
// ResolvedValue (static values)
2
type ResolvedValue =
3
  | string
4
  | number
5
  | boolean
6
  | null
7
  | LinkResolvedValue
8
  | VideoResolvedValue
9
  | RichTextResolvedValue;
10
11
// BindingInput (bind to a data source)
12
type BindingInput =
13
  | { sourceType: 'prop'; propId: string }
14
  | { sourceType: 'cms'; collectionId: string; fieldId: string }
15
  | { sourceType: 'page'; fieldKey: string }
16
  | { sourceType: 'locale'; fieldKey: string }
17
  | { sourceType: 'localeItem'; fieldKey: string };

1
// Bind to a parent component prop
2
{ sourceType: 'prop', propId: 'prop_3' }
3
4
// Bind to a CMS field
5
{ sourceType: 'cms', collectionId: 'col_abc123', fieldId: 'field_author' }
6
7
// Bind to a locale field
8
{ sourceType: 'locale', fieldKey: 'languageCode' }
9
10
// Bind to a page field
11
{ sourceType: 'page', fieldKey: 'seoTitle' }

1
type AttributeEntry = {
2
  name: string | BindingValue
3
  value: string | BindingValue
4
}

1
const element = await webflow.getSelectedElement()
2
3
if (element) {
4
5
  // Set static values
6
  await element.setSettings({ tag: 'h1', domId: 'my-id' })
7
8
  // Bind a setting to a component prop
9
  await element.setSettings({ domId: { sourceType: 'prop', propId: 'prop_3' } })
10
11
  // Reset a setting to its default and disconnect any binding
12
  await element.setSettings({ altText: null })
13
14
  // Replace all custom attributes on the element
15
  await element.setSettings({
16
    attributes: [
17
      { name: 'data-label', value: 'primary' },
18
      { name: 'data-index', value: '1' },
19
    ],
20
  })
21
22
}