@webflow/designer-extension-typings 2.1.0 → 2.1.1

package/elements-generated.d.ts

@@ -277,6 +277,9 @@ interface ComponentElement
   getComponent(): Promise<Component>;
   getSlots(): Promise<Array<SlotInstanceElement>>;
   getSelectedSlot(): Promise<SlotInstanceElement | null>;
+  getTextPropElement(
+    propId: string
+  ): Promise<TextPropElement | RichTextPropElement | null>;
   getProps(): Promise<Array<InstancePropSummary>>;
   getResolvedProps(): Promise<Array<ResolvedInstanceProp>>;
   searchProps(
@@ -286,6 +289,7 @@ interface ComponentElement
     props: Array<SetInstancePropEntry>
   ): Promise<Array<SetInstancePropEntry>>;
   resetAllProps(): Promise<null>;
+  unlinkComponent(): Promise<AnyElement>;
 }
 
 interface UnknownElement

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webflow/designer-extension-typings",
-  "version": "2.1.0",
+  "version": "2.1.1",
   "license": "MIT",
   "description": "Typings for the Webflow Designer Extension API",
   "main": "",

package/slots.d.ts

@@ -14,3 +14,23 @@ interface SlotInstanceElement {
   append(child: Component): Promise<null>;
   prepend(child: Component): Promise<null>;
 }
+
+interface FullTextPropId {
+  readonly component: string;
+  readonly element: string;
+  readonly prop: string;
+}
+
+interface TextPropElement {
+  readonly id: FullTextPropId;
+  readonly type: 'TextPropElement';
+  getDisplayName(): Promise<string>;
+  getChildren(): Promise<AnyElement[]>;
+}
+
+interface RichTextPropElement {
+  readonly id: FullTextPropId;
+  readonly type: 'RichTextPropElement';
+  getDisplayName(): Promise<string>;
+  getChildren(): Promise<AnyElement[]>;
+}

package/styles.d.ts

@@ -175,7 +175,7 @@ interface Style {
   /**
    * Retrieve a variable mode from the style.
    * @param collection - The collection from which to get the currently applied mode.
-   * @param options - Options to get variable mode based on breakpoints and pseudo classes / states.
+   * @param options - Options to get variable mode based on breakpoints, pseudo classes / states, and component variants.
    * @example
    * ```ts
    * const collection = await webflow.getVariableCollectionById('collection-id');
@@ -184,29 +184,31 @@ interface Style {
    */
   getVariableMode(
     collection: VariableCollection,
-    options?: BreakpointAndPseudo
+    options?: StyleOptions
   ): Promise<null | VariableMode>;
   /**
    * Sets a variable mode for the style.
    * @param collection - The collection that the mode being set belongs to.
    * @param mode - The variable mode to set.
-   * @param options - Options to set variable mode based on breakpoints and pseudo classes / states.
+   * @param options - Options to set variable mode based on breakpoints, pseudo classes / states, and component variants.
    * @example
    * ```ts
    * const collection = await webflow.getVariableCollectionById('collection-id');
    * const mode = await collection.getVariableModeByName('Dark');
-   * await myStyle.setVariableMode(collection, mode);
+   * await myStyle.setVariableMode(collection, mode, {
+   *   variantId: 'variant-dark',
+   * });
    * ```
    */
   setVariableMode(
     collection: VariableCollection,
     mode: VariableMode,
-    options?: BreakpointAndPseudo
+    options?: StyleOptions
   ): Promise<null>;
   /**
    * Removes a variable mode from the style.
    * @param collection - The collection that the mode being removed belongs to.
-   * @param options - Options to remove variable mode based on breakpoints and pseudo classes / states.
+   * @param options - Options to remove variable mode based on breakpoints, pseudo classes / states, and component variants.
    * @example
    * ```ts
    * const collection = await webflow.getVariableCollectionById('collection-id');
@@ -215,23 +217,23 @@ interface Style {
    */
   removeVariableMode(
     collection: VariableCollection,
-    options?: BreakpointAndPseudo
+    options?: StyleOptions
   ): Promise<null>;
   /**
    * Retrieve all variable modes applied on the style.
-   * @param options - Options to get variable modes based on breakpoints and pseudo classes / states.
+   * @param options - Options to get variable modes based on breakpoints, pseudo classes / states, and component variants.
    * @example
    * ```ts
    * const modes = await myStyle.getVariableModes();
    * ```
    */
   getVariableModes(
-    options?: BreakpointAndPseudo
+    options?: StyleOptions
   ): Promise<VariableModeStylePropertyMap>;
   /**
    * Sets variable modes for the style.
    * @param props - The variable modes to set.
-   * @param options - Options to set variable modes based on breakpoints and pseudo classes / states.
+   * @param options - Options to set variable modes based on breakpoints, pseudo classes / states, and component variants.
    * @example
    * ```ts
    * await myStyle.setVariableModes({
@@ -242,12 +244,12 @@ interface Style {
    */
   setVariableModes(
     props: VariableModeStylePropertyMap,
-    options?: BreakpointAndPseudo
+    options?: StyleOptions
   ): Promise<null>;
   /**
    * Removes variable modes from the style.
    * @param modes - The variable modes to remove from the style.
-   * @param options - Options to remove variable modes based on breakpoints and pseudo classes / states.
+   * @param options - Options to remove variable modes based on breakpoints, pseudo classes / states, and component variants.
    * @example
    * ```ts
    * const collection = await webflow.getVariableCollectionById('collection-id');
@@ -258,17 +260,17 @@ interface Style {
    */
   removeVariableModes(
     modes: Array<VariableMode>,
-    options?: BreakpointAndPseudo
+    options?: StyleOptions
   ): Promise<null>;
   /**
    * Removes all variable modes from the style.
-   * @param options - Options to remove all variable modes based on breakpoints and pseudo classes / states.
+   * @param options - Options to remove all variable modes based on breakpoints, pseudo classes / states, and component variants.
    * @example
    * ```ts
    * await myStyle.removeAllVariableModes();
    * ```
    */
-  removeAllVariableModes(options?: BreakpointAndPseudo): Promise<null>;
+  removeAllVariableModes(options?: StyleOptions): Promise<null>;
   /**
    * Retrieves the parent style for a combo class and otherwise returns null.
    * @example