Set style property

style.setProperty(prop, value, options?)

Manage the CSS of a Style by setting a specific style property at the given breakpoint and pseudo-state.

Syntax

1
style.setProperty(
2
  prop: {{STYLE_PROPERTY}},
3
  value: string | VariableReference,
4
  options?: {
5
    breakpoint?: {{BREAKPOINT_ID}},
6
    pseudo?: {{PSEUDO_STATE_KEY}},
7
    variantId?: {{VARIANT_ID}}
8
  }
9
): Promise<void>

Parameters

• prop: StyleProperty - The property to set. See the Style Properties reference for a list of supported properties.

• value: String | VariableReference - The value to set. You can set the value to a string or a variable reference.

• options: StyleOptions - An object that filters properties by breakpoint, pseudo-state, and/or variant. (Optional)

  • breakpoint: BreakpointId - Identifies the responsive breakpoint to set the style property for.

    1
    type BreakpointId = "xxl" | "xl" | "large" | "main" | "medium" | "small" | "tiny"

  • pseudo: PseudoStateKey - Specifies a CSS pseudo-class to set the style property for.

    1
    type PseudoStateKey = "noPseudo" | "nth-child(odd)" | "nth-child(even)" |
    2
      "first-child" | "last-child" | "hover" | "active" |
    3
      "visited" | "focus" | "focus-visible" | "focus-within" |
    4
      "placeholder" | "empty" | "before" | "after"

  • variantId: string - The ID of the variant to target. 'base' is not a valid value. (Optional)

Returns

Promise<null>

A Promise that resolves to null

Example

1
// Retrieve the style by name
2
const retrievedStyle = await webflow.getStyleByName(styleName);
3
4
// Set a property for a specific breakpoint and pseudo-state
5
const options: StyleOptions = { breakpoint: "xl", pseudo: "hover" }
6
await retrievedStyle?.setProperty('background-color', 'blue', options)
7
8
// Set a property for a specific variant
9
await retrievedStyle?.setProperty('color', 'red', { variantId: 'variant-123' })
10
11
// Set a property combining variant, breakpoint, and pseudo-state
12
await retrievedStyle?.setProperty('font-size', '24px', {
13
  variantId: 'variant-123',
14
  breakpoint: 'medium',
15
  pseudo: 'hover',
16
})

Designer Ability