Get style property

style.getProperty(prop, options?)

Retrieve the value of a specific css property in a Style object.

Syntax

1
style.getProperty(
2
  prop: {{STYLE_PROPERTY}},
3
  options?: {
4
    breakpoint?: {{BREAKPOINT_ID}},
5
    pseudo?: {{PSEUDO_STATE_KEY}},
6
    variantId?: {{VARIANT_ID}}
7
  }
8
): Promise<null | {{PROPERTY_MAP}}>

Parameters

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

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

  • breakpoint: BreakpointId - Identifies the responsive breakpoint to get styles for.

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

  • pseudo: PseudoStateKey - Specifies a CSS pseudo-class to get styles 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<PropertyMap[p] | Variable | null>

Returns a Promise that resolves to:

• PropertyMap[p] - The value of the provided style property, if one exists.
• A Variable representing the value of the provided style property, if a variable is used as the value of the provided style property.
• null - If value doesn’t exist for the provided style property, this method will return null.

Example

1
// Get Selected Element
2
const selectedElement = await webflow.getSelectedElement()
3
4
// Get Element Styles
5
if (selectedElement?.styles) {
6
7
    const styles = await selectedElement.getStyles()
8
    const selectedPropertyList = await Promise.all(styles.map(async style => {
9
10
      const styleName = await style.getName()
11
      const property = await style.getProperty(`box-shadow`)
12
      console.log(`Style Name: ${styleName}, box-shadow: ${property}`)
13
14
    }))
15
16
  }

Designer Ability

Checks for authorization only