Building Block

Last update: Edit

1 Introduction

Building blocks are components that can be re-used to streamline the page creation process. By pre-configuring and styling building blocks, users can easily click together interfaces without having to worry about the details of styling guidelines or user experience.

Building blocks are stored in the app’s UI resources package. This keeps them in sync with the app theme, and provides a handy place to consolidate all design-related data.

To create a building block, simply right-click a widget anywhere in your app in Studio Pro and select Create building block. The widget along with its contents will be added as a new building block. The building block will now automatically appear in the Building blocks tab of the Toolbox.

As the purpose of building blocks is to facilitate design rather than functionality, building blocks should be devoid of references to other documents. This is to prevent users from facing confusing errors when using building blocks in their pages. It also mitigates the chance of errors when importing building blocks from a different app.

2 Common Properties

For more information on properties in this section, see the Common Section section in Properties Common in the Page Editor.

3 Designer Properties

The size of a page as displayed in the page editor can be controlled through two properties.

Canvas Width

This defines the width in pixels of the page in the page editor.

Default: 800

Canvas Height

This defines the preferred minimum height in pixels of the page in the page editor.

Default: 600

These properties only change what is seen in the editor. They have no effect on the actual application.

4 General Properties

4.1 Display Name

The display name determines the name of the building block that will appear in the toolbox.

4.2 Image

The image selected will appear in the Building Blocks tab of Studio’s Toolbox and Studio Pro’s Toolbox in Tile View. Selecting a representative image will allow users to easily distinguish between building blocks. If left blank, Studio will display a generic default image. Any image selected will be scaled down to 200x200 pixels.

4.3 Category

The category is used to group building blocks inside the Toolbox.

4.4 Category Weight

The category weight determines the order of categories inside the Toolbox (in ascending order). If building blocks with the same category have different category weights, the lowest is used to determine the position.

4.5 Documentation URL

The documentation URL can be used to link to a documentation page for the building block. These links will appear in the Building Blocks tab of Studio’s Toolbox.