Module: Alchemy::Admin::BaseHelper

Includes:
NavigationHelper, BaseHelper
Included in:
AttachmentsHelper, IngredientsHelper, LinkDialog::BaseTab, PagesHelper
Defined in:
app/helpers/alchemy/admin/base_helper.rb

Overview

This module contains helper methods for rendering dialogs and confirmation windows.

The most important helpers for module developers are:

Instance Method Summary collapse

Methods included from NavigationHelper

#alchemy_main_navigation_entry, #entry_active?, #main_navigation_css_classes, #navigate_module, #sorted_alchemy_modules, #url_for_module, #url_for_module_sub_navigation

Methods included from BaseHelper

#render_icon, #render_message, #warning

Instance Method Details

#alchemy_admin_js_translations(locale = ::I18n.locale) ⇒ Object 



76
77
78
79
80
81
 
# File 'app/helpers/alchemy/admin/base_helper.rb', line 76

def alchemy_admin_js_translations(locale = ::I18n.locale)
  render partial: "alchemy/admin/translations/#{locale}", formats: [:js]
rescue ActionView::MissingTemplate
  # Fallback to default translations
  render partial: "alchemy/admin/translations/en", formats: [:js]
end

#alchemy_body_class ⇒ Object

Appends the current controller and action to body as css class.



255
256
257
258
259
260
261
262
 
# File 'app/helpers/alchemy/admin/base_helper.rb', line 255

def alchemy_body_class
  [
    controller_name,
    action_name,
    content_for(:main_menu_style),
    content_for(:alchemy_body_class)
  ].compact
end

#alchemy_datepicker(object, method, html_options = {}) ⇒ Object

Renders a textfield ready to display a datepicker

A Javascript observer converts this into a fancy Datepicker. If you pass ‘datetime’ as :type the datepicker will also have a Time select. If you pass ‘time’ as :type the datepicker will only have a Time select.

This helper always renders “text” as input type because: HTML5 supports input types like ‘date’ but Browsers are using the users OS settings to validate the input format. Since Alchemy is localized in the backend the date formats should be aligned with the users locale setting in the backend but not the OS settings.

Date Example

<%= alchemy_datepicker(@person, :birthday) %>

Datetime Example

<%= alchemy_datepicker(@page, :public_on, type: 'datetime') %>

Time Example

<%= alchemy_datepicker(@meeting, :starts_at, type: 'time') %>

Parameters:

  • object (ActiveModel::Base) —

    An instance of a model

  • method (String or Symbol) —

    The attribute method to be called for the date value

  • html_options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (html_options):

  • :data-datepicker-type (String) — default: type —

    The value of the data attribute for the type

  • :class (String) — default: type —

    CSS classes of the input field

  • :value (String) — default: value of method on object —

    The value the input displays. If you pass a String its parsed with Time.parse



231
232
233
234
235
236
237
238
239
240
241
 
# File 'app/helpers/alchemy/admin/base_helper.rb', line 231

def alchemy_datepicker(object, method, html_options = {})
  type = html_options.delete(:type) || "date"
  date = html_options.delete(:value) || object.send(method.to_sym).presence
  date = Time.zone.parse(date) if date.is_a?(String)
  value = date&.iso8601

  input_field = text_field object.class.name.demodulize.underscore.to_sym,
    method.to_sym, {type: "text", class: type, value: value}.merge(html_options)

  content_tag("alchemy-datepicker", input_field, "input-type" => type)
end

#button_with_confirm(value = "", url = "", options = {}, html_options = {}) ⇒ Object

Note:

The method option in the html_options hash gets passed to the form_tag helper!

Returns a form and a button that opens a modal confirm dialog.

After confirmation it proceeds to send the form’s action.

Example:

<%= button_with_confirm('pay', '/admin/orders/1/pay', message: 'Do you really want to mark this order as payed?') %>

Parameters:

  • value (String) (defaults to: "") —

    The content inside the <a> tag

  • url (String) (defaults to: "") —

    The url that gets opened after confirmation

  • options (Hash) (defaults to: {}) —

    Options for the Alchemy confirm dialog (see also app/assets/javascripts/alchemy/alchemy.confirm_dialog.js.coffee)

  • html_options (Hash) (defaults to: {}) —

    HTML options that get passed to the button_tag helper.



143
144
145
146
147
148
149
150
151
 
# File 'app/helpers/alchemy/admin/base_helper.rb', line 143

def button_with_confirm(value = "", url = "", options = {}, html_options = {})
  options = {
    message: Alchemy.t(:confirm_to_proceed),
    title: Alchemy.t(:please_confirm)
  }.merge(options)
  form_tag url, {method: html_options.delete(:method), class: "button-with-confirm"} do
    button_tag value, html_options.merge("data-turbo-confirm" => options[:message])
  end
end

#clipboard_select_tag_options(items) ⇒ Object

(internal) Returns options for the clipboard select tag



265
266
267
268
269
270
271
272
273
274
275
 
# File 'app/helpers/alchemy/admin/base_helper.rb', line 265

def clipboard_select_tag_options(items)
  options = items.map do |item|
    name = if item.respond_to?(:display_name_with_preview_text)
      item.display_name_with_preview_text
    else
      item.name
    end
    [name, item.id]
  end
  options_for_select(options)
end

#current_alchemy_user_name ⇒ Object

Returns a string showing the name of the currently logged in user.

In order to represent your own User‘s class instance, you should add a alchemy_display_name method to your User class



21
22
23
24
25
26
 
# File 'app/helpers/alchemy/admin/base_helper.rb', line 21

def current_alchemy_user_name
  name = current_alchemy_user.try(:alchemy_display_name)
  if name.present?
    content_tag :span, "#{Alchemy.t("Logged in as")} #{name}", class: "current-user-name"
  end
end

#delete_button(url, options = {}, html_options = {}) ⇒ Object

A delete button with confirmation window.

Parameters:

  • title (Hash) —

    a customizable set of options

  • message (Hash) —

    a customizable set of options

  • icon (Hash) —

    a customizable set of options



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'app/helpers/alchemy/admin/base_helper.rb', line 162

def delete_button(url, options = {}, html_options = {})
  options = {
    title: Alchemy.t("Delete"),
    message: Alchemy.t("Are you sure?"),
    icon: "delete-bin-2"
  }.merge(options)

  if html_options[:title]
    tooltip = html_options.delete(:title)
  end
  button = button_with_confirm(
    render_icon(options[:icon]),
    url, options, {
      method: "delete",
      class: "icon_button #{html_options.delete(:class)}".strip
    }.merge(html_options)
  )
  if tooltip
    content_tag("sl-tooltip", button, content: tooltip)
  else
    button
  end
end

#hint_with_tooltip(text, icon: "alert") ⇒ String

Renders a hint with tooltip

Example

<%= hint_with_tooltip('Page layout is missing', icon: 'info') %>

Parameters:

  • text (String) —

    • The text displayed in the tooltip

  • icon: ('alert'String) (defaults to: "alert") —

    • Icon name

Returns:

  • (String) 


292
293
294
295
296
 
# File 'app/helpers/alchemy/admin/base_helper.rb', line 292

def hint_with_tooltip(text, icon: "alert")
  content_tag :"sl-tooltip", class: "like-hint-tooltip", content: text, placement: "bottom" do
    render_icon(icon)
  end
end

#link_to_confirm_dialog(link_string = "", message = "", url = "", html_options = {}) ⇒ Object

Returns a link that opens a modal confirmation to delete window.

Example:

<%= link_to_confirm_dialog('delete', 'Do you really want to delete this comment?', '/admin/comments/1') %>

Parameters:

  • link_string (String) (defaults to: "") —

    The content inside the <a> tag

  • message (String) (defaults to: "") —

    The message that is displayed in the dialog

  • url (String) (defaults to: "") —

    The url that gets opened after confirmation (Note: This is an Ajax request with a method of DELETE!)

  • html_options (Hash) (defaults to: {}) —

    HTML options get passed to the link

Options Hash (html_options):

  • :title (String) — default: Alchemy.t(:please_confirm) —

    The dialog title

  • :message (String) — default: message —

    The message displayed in the dialog

  • :ok_label (String) — default: Alchemy.t("Yes") —

    The label for the ok button

  • :cancel_label (String) — default: Alchemy.t("No") —

    The label for the cancel button



114
115
116
117
118
119
120
121
122
 
# File 'app/helpers/alchemy/admin/base_helper.rb', line 114

def link_to_confirm_dialog(link_string = "", message = "", url = "", html_options = {})
  link_to(link_string, url,
    html_options.merge(
      data: {
        "turbo-method": :delete,
        "turbo-confirm": message
      }
    ))
end

#link_to_dialog(content, url, options = {}, html_options = {}) ⇒ Object

This helper renders the link to an dialog.

We use this for our fancy modal dialogs in the Alchemy cockpit.

Example

<%= link_to_dialog('Edit', edit_product_path, {size: '200x300'}, {class: 'icon_button'}) %>

Parameters:

  • content (String) —

    The string inside the link tag

  • url (String or Hash) —

    The url of the action displayed inside the dialog.

  • options (Hash) (defaults to: {}) —

    options for the dialog.

  • html_options (Hash) (defaults to: {}) —

    HTML options passed to the link_to helper

Options Hash (options):

  • :size (String) —

    String with format of “WidthxHeight”. I.E. (“420x280”)

  • :title (String) —

    Text for the dialog title bar.

  • :modal (Boolean) — default: true —

    Show as modal window.



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'app/helpers/alchemy/admin/base_helper.rb', line 52

def link_to_dialog(content, url, options = {}, html_options = {})
  default_options = {modal: true}
  options = default_options.merge(options)
  if html_options[:title]
    tooltip = html_options.delete(:title)
  end
  anchor = link_to(content, url, html_options.merge(
    "data-dialog-options" => options.to_json,
    :is => "alchemy-dialog-link"
  ))
  if tooltip
    content_tag("sl-tooltip", anchor, content: tooltip)
  else
    anchor
  end
end

#link_url_regexp ⇒ Object

Returns the regular expression used for external url validation in link dialog.



278
279
280
 
# File 'app/helpers/alchemy/admin/base_helper.rb', line 278

def link_url_regexp
  Alchemy.config.format_matchers.link_url || /^(mailto:|\/|[a-z]+:\/\/)/
end

#page_layout_missing_warning ⇒ Object

Renders a warning icon with a hint that explains the user that the page layout is missing



300
301
302
303
304
 
# File 'app/helpers/alchemy/admin/base_helper.rb', line 300

def page_layout_missing_warning
  hint_with_tooltip(
    Alchemy.t(:page_definition_missing)
  )
end

#render_alchemy_title ⇒ Object

(internal) Renders translated Module Names for html title element.



187
188
189
190
191
192
193
194
 
# File 'app/helpers/alchemy/admin/base_helper.rb', line 187

def render_alchemy_title
  title = if content_for?(:title)
    content_for(:title)
  else
    Alchemy.t(controller_name, scope: :modules)
  end
  "Alchemy CMS - #{title}"
end

#render_hint_for(element, icon_options = {}) ⇒ Object

Render a hint icon with tooltip for given object. The model class needs to include the hints module



245
246
247
248
249
250
251
252
 
# File 'app/helpers/alchemy/admin/base_helper.rb', line 245

def render_hint_for(element, icon_options = {})
  return unless element.has_hint?

  content_tag "sl-tooltip", class: "like-hint-tooltip", placement: "bottom-start" do
    render_icon("question", icon_options) +
      content_tag(:span, element.hint.html_safe, slot: "content")
  end
end

#sites_for_select ⇒ Object

Used for site selector in Alchemy cockpit.



84
85
86
87
88
 
# File 'app/helpers/alchemy/admin/base_helper.rb', line 84

def sites_for_select
  Alchemy::Site.all.map do |site|
    [site.name, site.id]
  end
end

#translations_for_select ⇒ Object

Used for translations selector in Alchemy cockpit user settings.



70
71
72
73
74
 
# File 'app/helpers/alchemy/admin/base_helper.rb', line 70

def translations_for_select
  Alchemy::I18n.available_locales.sort.map do |locale|
    [Alchemy.t(locale, scope: :translations), locale]
  end
end