Skip to content

Addon Builder

The Addon Builder is the heart of OptionBay. It's a powerful, drag-and-drop React interface that allows you to build complex product customization forms with ease.

Interface Overview

When you edit an Option Group, you are presented with the Builder interface.

  1. Toolbar: Contains the Add Field button and the Save controls.
  2. Field List: Your current fields, which you can drag to reorder.
  3. Settings Panel: Appears when you click on a field to edit its specific configuration.

Available Field Types

OptionBay supports a wide range of input types to cover every use case:

Field TypeBest For...
TextSingle line inputs like names or short messages.
TextareaLonger messages like "Gift Note" or "Special Instructions".
NumberQuantities, dimensions, or any numeric data.
SelectDropdown lists for choosing one item from many.
RadioChoosing one option where all choices are visible.
CheckboxSelecting multiple items from a list.
Single CheckboxA simple toggle (Yes/No) for things like "Add Warranty".
Image SwatchesChoosing between patterns, materials, or styles visually.
Color SwatchesSelecting colors from a palette.
File UploadCollecting logos, photos, or documents from customers.
EmailCapturing an email address for digital delivery or contact info.

Common Field Settings

Every field has a set of common attributes you can configure:

General Settings

  • Label: The title of the field shown to the customer.
  • Description: Helpful instructions shown below the input.
  • Required: If checked, the customer must fill this field before they can add the product to their cart.

Pricing & Weight Settings

You can attach costs and physical weight to almost any field:

  • Price Type:
    • Flat Fee: A fixed cost.
    • Percentage Increase: Adds a percentage of the base product price.
    • Character Count: Cost multiplied by the number of characters typed (for text fields).
    • Formula: Advanced math-based pricing.
  • Price: The numeric amount to add to the product total.
  • Formula: (Only for Formula type) Use placeholders like [char_count], [base_price], [quantity], or [value] to build complex calculations.
  • Weight: The amount of physical weight to add to the product (affects shipping calculations).

Appearance

  • Placeholder: Ghost text shown inside the input (available for Text, Textarea, and Number fields).

Reordering Fields

To change the order in which fields appear on the product page, simply grab the handle on the left of any field in the builder list and drag it to your preferred position.

Next Steps

Released under the GPL-2.0 License.