Setting

A section or block definition comes with a list of settings. Those settings will be used by the editor UI to render the proper content form of a section (or block).

For instance, if your section includes 2 settings, let's say a title (text) and a background image (image), then the editor UI will generate for this section a form with 2 input elements: a text input for the input and an image picker to select the background image.

Default definition setting attributes

Name	Type	Description
label	string	Label displayed in the editor UI as the input label.
id	string	Identifier of the section. Required when you want to display the value of the setting inside the HTML template of the section or block. It has to be unique among the settings of a section.
type	string	Describe which kind of input the editor UI will render. See below for a list of available types.
default	string	When a section or a block is added to the page, in order to avoid blank content, Maglev will fill the section or block content with the default value of each setting. A value is required.
advanced	boolean	If the setting is not content related, the editor UI will put this setting in a different tab in the section form.

Available types and their options

text

Display a text input, simple or a rich text editor depending on the setting options.

Definition:

Option	Type	Description
html	boolean	Enable the rich text editor for this setting. False by default.
line_break	boolean	If true (and if the html option is also true), will cause the carriage return (enter key) to generate a <br> tag instead of closing the current element. False by default
nb_rows	integer	Number of rows for the rich text editor.

app/theme/sections/sample.yml

settings:
- label: "Title"
  id: title
  type: text
  # html: true
  # line_break: true
  # nb_rows: 5

Usage in the HTML/ERB template:

Template

app/views/theme/sections/sample.html.erb

<%= maglev_block.setting_tag :title, html_tag: :h2 %>

Raw template

<h2 <%= section.settings.title.dom_data %>>
  <%= raw section.settings.title %>
</h2>

image

Display an image picker to let the content editor choose or upload any image.

Definition:

app/theme/sections/sample.yml

settings:
- label: "Screenshot"
  id: screenshot
  type: image
  default: "/samples/images/default.svg"

Usage in the HTML/ERB template:

Template

app/views/theme/sections/sample.html.erb

<%= maglev_section.setting_tag :screenshot, class: 'my-css-class' %>

Raw template

<img 
    <%= section.settings.screenshot.dom_data %>
    src="<%= section.settings.screenshot %>"
    alt="<%= section.settings.screenshot.alt_text %>"
    class="my-css-class"
/>

List of properties:

<p><img src="<%= maglev_section.settings.screenshot.url %>" alt="<%= maglev_section.settings.screenshot.alt_text %>" /></p>

Property	Type	Description
url	string	Url of the image
width	integer	Width of the original image (in px)
height	integer	Height of the original image (in px)
alt_text	string	Alternate text added by the content editor
to_s	string	Alias of the url method

link

Display a link picker. The content editor will have the choice between a link to an external URL, a page or an email address.

Definition:

Option	Type	Description
with_text	Boolean	False if the developer only needs an url. Otherwise, the editor UI will present a text field in addition on the URL picker.

app/theme/sections/sample.yml

settings:
- label: "Call to action"
  id: cta_link
  type: link
  with_text: true
  default: "/"

Usage in the HTML/ERB template:

Template

app/views/theme/sections/sample.html.erb

<%= maglev_section.setting_tag :cta_link %>

Template without text

<%= maglev_section.setting_tag :cta_link do %>
   Call us
<% end %>

Raw template (without text)

<a 
  href="<%= section.settings.cta_link.href %>" 
  <% if section.settings.cta_link.open_new_window? %>target="_blank"<% end %>
>
  Call us
</a>

List of properties:

Property	Type	Description
href	String	URL of the page / external URL / email address.
text	String	Text typed by the content editor (if functionality enabled by the with_text option.
open_new_window?	Boolean	True if the content editor wants the link to be opened in a new browser tab.
target_blank	String	Returns _blank or nil depending on the property above.
to_s	String	Alias of the href property.

collection_item

This setting type allows content editors to select an instance of any ActiveRecord class of the main Ruby on Rails application. For instance, in your e-commerce site, if your section is named featured_product_01, chances are big that you will need a collection_item setting type to let your editors pick the product of their choice among the products table.

Definition:

Option	Type	Description
collection_id	String	ID of the collection as set up in theme.yml file

app/theme/sections/sample.yml

settings:
- label: "Product"
  id: collection_item
  type: collection_item
  collection_id: products

Usage in the HTML/ERB template:

Template

app/views/theme/sections/sample.html.erb

<%= maglev_section.setting_tag :product, class: 'featured-product' do |product| %>
  <h2><%= product.name %></h2>
  <p><%= number_to_currency product.price %></p>
<% end %>

Raw template

app/views/theme/sections/sample.html.erb

<% if maglev_section.settings.product.exists? %>
  <div class="featured-product" data-maglev-id="<%= section.settings.product.dom_data %>">
    <h2><%= maglev_section.settings.product.item.name %></h2>
    <p><%= number_to_currency maglev_section.settings.product.item.price %></p>
  </div>
<% end %>

If the content editor hasn't chosen an item or if the item doesn't exist anymore, the setting tag won't rendered.

List of properties:

Property	Type	Description
exists?	Boolean	True if the collection item exists in DB.
item	Model	The collection item loaded from the DB.

color

Display a color picker. The content editor will have to choose between a selection of color presets defined by the developer.

Definition:

Option	Type	Description
presets	Array of strings	List of hexadecimal colors.

app/theme/sections/sample.yml

settings:
- label: "Background color"
  id: background_color
  type: color
  presets: ["#F87171", "#FBBF24", "#34D399"]
  default: "#F87171"

Usage in the HTML/ERB template:

app/views/theme/sections/sample.html.erb

<div class="banner" style="background-color: <%= section.settings.background_color %>">
  <h2>Hello world</h2>
</div>

List of properties:

Property	Type	Description
dark?	Boolean	True if the brightness index of this color is less than 128.
light?	Boolean	True if the brightness index of this color is great than 155.
brightness	Integer	Value between 0 and 255.

checkbox

Display a toggle input.

Definition:

app/theme/sections/sample.yml

settings:
- label: "Display warning message ?"
    id: cta_link
    type: checkbox
    default: false

Usage in the HTML/ERB template:

app/views/theme/sections/sample.html.erb

<% if section.settings.display_warning_message.true? %>
  <div>My warning message</div>
<% end %>

Don't write <% if section.settings.display_warning_message %>

since the condition will always be true. Instead, use true?or false?.

List of properties:

Property	Type	Description
true?	Boolean
false?	Boolean

icon

Display a popup to select an icon among a set of icons. Follow the instructions here to set up the icon library.

Definition:

app/theme/sections/sample.yml

settings:
- label: "Icon"
    id: cta_icon
    type: icon
    default: 'fa fa-github'

Usage in the HTML/ERB template:

<div>
  <%= maglev_section.setting_tag :icon, html_tag: 'i' %>
</div>

select

Display an HTML select field to let the editor pick one of the options defined in the section definition.

Definition:

app/theme/sections/sample.yml

settings:
- label: "Animation on scroll"
  id: aos_class
  type: select
  select_options:
  - label: Fade
    value: fade-up
  - label: Flip
    value: flip-left
  - label: Zoom
    value: zoom-in
  default: fade-up

Usage in the HTML/ERB template:

<div class="<%= section.settings.aos_class %>">
   My amazing content
</div>

hint

Display an information in the section content editing form. For instance, it could be used to give some tips to the content editors.

It is not intended to be displayed.

Definition:

app/theme/sections/sample.yml

settings:
- label: "This text will be displayed in the editor UI"
    id: some_hint
    type: hint

divider

Display a line between 2 adjacent settings in the editor UI. The label can be displayed if the with_hintoption is enabled.

It is not intended to be displayed.

Definition:

app/theme/sections/sample.yml

settings:
- label: "This text will be displayed in the editor UI"
    id: a_divider_n_hint
    type: divider
    with_hint: true

---

Translating setting labels

While the label property defines the default text displayed in the editor UI, you can translate these labels by adding translations to your main application's locale files. The translations follow a specific naming convention under the maglev.themes namespace.

Translation structure

In your RoR application, add your translations in your locale files (config/locales/[locale].yml) following this structure:

en:
  maglev:
    themes:
      [theme_name]:
        sections:
          [section_name]:
            settings:
              [setting_id]: "Translated Label"

Example

For instance, if you want to translate the "title" setting label of a "showcase" section in a theme named "simple":

en:
  maglev:
    themes:
      simple:
        sections:
          showcase:
            settings:
              title: "Title 😎"

The system will automatically use these translations in the editor interface when displaying setting labels. If no translation is found, it will fall back to the label value defined in the section's YAML file.