Wix Blocks: Adding Code to Your Custom Panels

Blocks enables you to create custom panels for your action bars, so that when a site creator clicks an action bar button (for example, the Settings button) - a custom panel opens, instead of the default panel. 

Creating your panel has two main parts. First, design your panel by adding its elements and customizing them. Then add code to your panel, to determine how it interacts with the widget or to control the behavior of the panel itself. 

Add code to your custom panel

1. Make sure that you are in the Panels tab. 
2. Make sure that your panel is selected in the Panels section on the left menu (or create a new panel, if you haven't created it yet). 

1. Go to your panel's code section. 

Panel elements

Custom panels are made of unique user interface (UI) elements, such as buttons, checkboxes, drop-down lists and more. See the list of elements and the Velo API reference for all panel elements.

Velo modules for Blocks custom panels

To enable panel elements to interact with your widget and perform actions in the editor, use one or more of the following modules in your panel code:

The wix-widget module controls your widget's properties, design presets, and more.

1

The wix-editor module interacts with the Editor to remove or restore widget elements, open Dashboard panels, and more.

1

Add code that interacts with your widget

Write whatever you want to happen in the onReady function of your panel's code. For example, in a shopping widget, you can turn a "special sale" property on and off, through a toggle element in the widget's props. 

1

Here is a way for showing and hiding an element through the panel code.

1

Here is an example of changing the widget's design preset from the panel code. The panel has three buttons, for three different presets, and looks like this: 

Here is the panel's code:

1

Add code that interacts with an inner (nested) widget

This example shows how to set a "Sale" or "No Sale" tag in the widget props, but for an inner (nested) widget.

1

Add code that interacts with your panel

In some cases, you might want to manipulate what happens within the panel itself. For example, you might want some of the panel elements to be hidden if they are irrelevant. 

This panel for the Login Bar Settings button has a toggle, which determines whether or not to show a greeting before the user's name. 

To make your toggle switch work:

1. Select the toggle switch element.
2. Change the ID to a meaningful name in Properties & Events The toggle switch here is called showGreetingSwitch.
3. Change the ID of the text box element. Here it is called greetingText.
4. Add the following code to your panel's onReady() function:

1

Add code that interacts with a collection

In the panel code, you can access your app collections and perform various actions, query, insert, etc. You can also access a collection on a site where your app is installed. Just make sure to use the app namespace.

For example, write this in the panel code to query your app's collection:

1

Next Steps

After making your panel work, don't forget the next steps:

• Connect your panel to an action button, if you haven't done it yet. When a site builder clicks that action button, your panel will open.

• Test your panel across editors. We recommend that you install your app on both on a Wix Editor and a Wix Studio site, to check how the panels work and look the way you want them to.