Delete a variant (Beta)

component.deleteVariant(options)

Deletes a variant from a component by ID.

You cannot delete the base variant.

Syntax

1
component.deleteVariant(options: DeleteVariantOptions): Promise<void>

Related interfaces:

1
interface DeleteVariantById {
2
  id: string;
3
}
4
5
type DeleteVariantOptions = DeleteVariantById;

Parameters

• options: DeleteVariantOptions — An object specifying the variant to delete:

  • id: string — The ID of the variant to delete.

Returns

Promise<void>

A Promise that resolves when the variant is deleted.

Example

1
const component = await webflow.getCurrentComponent()
2
3
if (component) {
4
  await component.deleteVariant({ id: 'variant-456' })
5
}

Designer Ability