Remove a style property

style.remove(prop, options?)

Remove a single style-property from a Style object.

Syntax

style.removeProperty(
prop: {{STYLE_PROPERTY}},
options?: {
breakpoint?: {{BREAKPOINT_ID}},
pseudo?: {{PSEUDO_STATE_KEY}},
variantId?: {{VARIANT_ID}}
}
): Promise<void>

Parameters

  • prop: StyleProperty - The name of the property to remove from the style. 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 remove the property from.

      type BreakpointId = "xxl" | "xl" | "large" | "main" | "medium" | "small" | "tiny"
    • pseudo: PseudoStateKey - Specifies a CSS pseudo-class to remove the property from.

      type PseudoStateKey = "noPseudo" | "nth-child(odd)" | "nth-child(even)" |
      "first-child" | "last-child" | "hover" | "active" |
      "visited" | "focus" | "focus-visible" | "focus-within" |
      "placeholder" | "empty" | "before" | "after"
    • variantId: string - The ID of the variant to target. 'base' is not a valid value. (Optional)

Returns

Promise<void>

A Promise that resolves to undefined

Example

removeSingleStyleProperty: async (property: StyleProperty) => {
// Get Selected Element
const selectedElement = await webflow.getSelectedElement()
if (selectedElement?.styles) {
// Get Element Styles
const styles = await selectedElement.getStyles()
const primaryStyle = styles[0]
await primaryStyle.removeProperty(property) // Remove the property from the style
}
},

Designer Ability

Designer AbilityLocaleBranchWorkflowSitemode
canModifyStyleBlocksAnyAnyCanvasDesign