Variant

Add a Variant property to your component for designers to choose from a predefined list of options.

Syntax

// Prop definition
props.Variant({
    name: string,
    options: string[],
    group?: string,
    tooltip?: string,
    defaultValue?: string,
})
// Prop value
string

Prop Definition

Define the Variant prop in your Webflow code component with a name and list of options. Optionally, you can add a group, tooltip text, and a default value that matches one of the pre-defined options.

props.Variant({
    name: string,
    options: string[],
    group?: string,
    tooltip?: string,
    defaultValue?: string,
})

Properties

• name: The name for the property.
• group: The group for this property. (optional)
• tooltip: The tooltip for the property. (optional)
• options: Array of available variant options.
• defaultValue: Default selected option. (optional)

Example

import { declareComponent } from '@webflow/react';
import { props } from '@webflow/data-types';
import { MyComponent } from "./MyComponent";
export default declareComponent(MyComponent, {
    name: "MyComponent",
    description: "A component with a Variant property",
    props: {
        style: props.Variant({
            name: "Button Style",
            group: "Style",
            options: ["Primary", "Secondary", "Tertiary"],
            defaultValue: "Primary"
        })
    }
});

Prop Value

The Variant prop provides a string value representing the selected option to your React component.

string

Properties

• n/a

Webflow properties panel

Example

import React from "react";
interface MyComponentProps {
    style?: "Primary" | "Secondary" | "Tertiary";
}
export const MyComponent = ({ style }: MyComponentProps) => {
    return (
        <button className={`button button--${style?.toLowerCase()}`}>
        Click me
        </button>
    );
}

When to use

Use a Variant prop when you want designers to:

• Choose from predefined visual styles
• Switch between component variations / themes
• Control component appearance

Best practices

• Use clear, descriptive option names
• Provide a sensible default value
• Keep options list manageable