For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Resources
Get started
ReferenceGuidesExamplesChangelog
ReferenceGuidesExamplesChangelog
  • Designer API
    • Introduction
    • Getting Started
    • Webflow CLI
    • Error Handling
    • App Modes
  • Elements
    • Creating & Retrieving Elements
    • Element Properties & Methods
    • Element Types & Methods
  • Styles
    • Managing Style Properties
    • Managing Variable Modes
  • Components
      • Create a component instance
      • Open a component canvas
      • Set the selected variant
      • Select a component
      • Exit out of a component
      • Get root element
      • Get component name
      • Get component
      • Set component name
      • Get component settings
      • Set component settings
      • Get props
      • Create a prop
      • Create multiple props
      • Get a prop
      • Get a prop by name
      • Set prop settings
      • Remove a prop
  • Variables & Collections
    • Variable Collections
    • Variables
    • Variable Modes
  • Assets
  • Pages & Folders
  • Utilities
    • User Events & Notifications
    • App Intents & Connections
  • Additional Resources
    • API Playground
    • FAQs
LogoLogo
Resources
Get started
On this page
  • ComponentElement.getComponent()
  • Syntax
  • Returns
  • Designer Ability
ComponentsManaging Components

Get component

Was this page helpful?
Previous

Set component name

Next
Built with

ComponentElement.getComponent()

Get the Component Definition associated to a Component Instance

Syntax

1element.getComponent(): Promise<Component>

Returns

Promise<Component>

A promise that resolves to a Component Object associated with a Component Instance.

1//Get User Selected Element from the Designer
2const parent = await webflow.getSelectedElement();
3
4// Check if this selected element is a Component Instance
5if(parent && !parent.configurable && parent.type === 'ComponentInstance'){
6 console.log(await parent.getComponent().getName());
7 }

Designer Ability

Checks for authorization only

Designer AbilityLocaleBranchWorkflowSitemode
canAccessCanvasanyanyanyany