Drag and Drop Area HubL Tags
Drag and drop areas allow developers to create sections of pages and global partials that support layout, stylistic and content changes directly within the content editors. See the creating a drag and drop area tutorial for an introduction to setting up drag and drop areas.
Drag and drop areas are based on a 12 column responsive grid. Drag and drop tags render markup with class names designating columns and rows. You'll need to add a stylesheet to target those class names. An example of layout styles you could implement can be found in the HubSpot CMS Boilerplate. Your stylesheet can be added to the template using {{ require_css() }}.
Please note: drag and drop areas can't be used in blog post and email templates at this time.
A drag and drop area is a container that makes a portion of the web page editable in terms of its structure, design, and content. The body of a {% dnd_area %} tag supplies the default content for the drag and drop area.
Modules themselves cannot contain drag and drop areas. To provide content creators an interface for adding uniform content within a module, use repeatable fields and groups instead.
A dnd_area tag can contain the following parameters:
| Parameter | Type | Description | Default |
|---|---|---|---|
class
| String | A class added to the wrapping div of a dnd_area | |
label
| String | Used in the editor to label the area in the sidebar. |
dnd_area tags can also contain dnd_section tags.
Please note: a content creator can swap a page's template for another template of the same type, depending on whether it has dnd_area tags.
- Templates built with the visual drag and drop layout editor can be swapped for other drag and drop templates or coded templates with or without
dnd_areatags. - Coded templates with dnd_area tags can only be swapped for other coded templates with
dnd_areatags. - Coded templates without
dnd_areatags can only be swapped for other coded templates withoutdnd_areatags.
A {% dnd_section %} is a top-level row, and must be nested within a {% dnd_area %} tag. Sections can also be defined as a template, and then included into a dnd_area, making them ideal for quickly scaffolding out a template.
A dnd_section tag can contain the following parameters:
| Parameter | Type | Description |
|---|---|---|
background_color
| Dict | A dict which supports specifying a background color. |
background_image
| Dict | A dict which supports specifying a background image. |
background_linear_gradient
| Dict | A dict which supports specifying a linear gradient background. |
full_width
| Boolean | A boolean which determines if the section is intended to be full width or constrained by an inner container. |
margin
| Dict | A dict which supports specifying margin values in |
max_width
| Integer | A pixel value which sets a content max-width on a wrapping dict. |
padding
| Dict | A dict which supports specifying padding values in |
vertical_alignment
| String | Vertical alignment of child content. Available options include:
|
Please note: you can only use one background parameter per dnd_section tag.
dnd_section tags can also contain the following tags:
- dnd_column
- dnd_module
A {% dnd_column %} is a vertical structural building block that occupies one or more layout columns defined by its parent row.
This HubL tag must be nested within a {% dnd_area %} tag.
A dnd_column tag can contain the following parameters:
| Parameter | Type | Description |
|---|---|---|
background_color
| Dict | A dict which supports specifying a background color. |
background_image
| Dict | A dict which supports specifying a background image. |
background_linear_gradient
| Dict | A dict which supports specifying a linear gradient background. |
margin
| Dict | A dict which supports specifying margin values in |
max_width
| Integer | A pixel value which sets a content max-width on a wrapping dict. |
padding
| Dict | A dict which supports specifying padding values in |
vertical_alignment
| String | Vertical alignment of child content. Available options include:
|
Please note: you can only use one background parameter per dnd_column tag.
A dnd_column tag can also contain dnd_row.
A {% dnd_row %} is a horizontal structural building block that creates a nested 12-column layout grid in which columns and modules can be placed.
This HubL tag must be nested within a {% dnd_area %} tag.
A dnd_row tag can include the following parameters:
| Parameter | Type | Description |
|---|---|---|
background_color
| Dict | A dict which supports specifying a background color. |
background_image
| Dict | A dict which supports specifying a background image. |
background_linear_gradient
| Dict | A dict which supports specifying a linear gradient background. |
margin
| Dict | A dict which supports specifying margin values in |
max_width
| Integer | A pixel value which sets a content max-width on a wrapping dict. |
padding
| Dict | A dict which supports specifying padding values in |
vertical_alignment
| String | Vertical alignment of child content. Available options include:
|
Please note: you can only use one background parameter per dnd_row tag.
A dnd_row can also contain the following tags:
- dnd_column
- dnd_module
A {% dnd_module %} is a module wrapped within a div where layout, styles and content can be added. The module is specified by referencing its path, which can either be a HubSpot default module (using the @hubspot/ namespace), or modules you have built, specifying their path within the design manager file tree.
This HubL tag must be nested within a {% dnd_area %} tag.
A dnd_module tag can contain the following parameters:
| Parameter | Type | Description |
|---|---|---|
path
Required
| String | The path to a module. |
horizontal_alignment
| String | Horizontal positioning, supports:
|
offset
| Integer | The offset from 0 in the 12 column grid. |
width
| Integer | The number of columns occupying the 12 column grid. |
flexbox_positioning
Deprecated
| String | Deprecated do not use. Instead, use
|
Have an old module which has a field name that matches one of the dnd_module parameters above? You can pass default values through a fields parameter, much like you would a field group.
There are a few ways to set backgrounds on column, section and row dnd elements, background_image, background_linear_gradient, and background_color.
The column, section, and row dnd tags support background colors. You can set the default background color for a drag and drop element using background_color. This parameter is a string based parameter and can include the following formats outlined in the example below.
The column, section and row dnd elements support background linear gradients. You can set a default gradient using the background_linear_gradient parameter. The parameter expects a dict. Currently only supports two color stops.
| Parameter | Type | Description |
|---|---|---|
direction
| String | The direction of the gradient.
|
colors
| array | Array of color strings. Currently supports 2 values, the start and end. Values are provided as strings, and the following formats are supported:
|
The column, section and row dnd elements support background images. You can provide a default background image by using the background_image parameter which expects a dict.
| Key | Type | Description |
|---|---|---|
backgroundPosition
| String | The background position of the image. Supports a string indicating vertical position followed by horizontal.
|
backgroundSize
| String | The CSS background size property used for the image.
|
imageUrl
| String | Absolute URL to the image. |
When you are using style based parameters such as backgrounds, margins, or padding, the class names are automatically computed for your sections, columns, rows, and modules. The property values you have assigned are then added to those automatically created class names and the resulting CSS code is then placed before the closing </body> tag on the page in a <style> tag.
Drag and drop styles can also be different at different breakpoints to offer a responsive look.
Thank you for your feedback, it means a lot to us.