Module: Spree::Admin::NavigationHelper

Defined in:
app/helpers/spree/admin/navigation_helper.rb

Instance Method Summary collapse

Instance Method Details

#button(text, icon_name = nil, button_type = 'submit', options = {}) ⇒ Object

Override: Add disable_with option to prevent multiple request on consecutive clicks



176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'app/helpers/spree/admin/navigation_helper.rb', line 176

def button(text, icon_name = nil, button_type = 'submit', options = {})
  if icon_name
    icon = content_tag(:span, '', class: "icon icon-#{icon_name}")
    text = "#{icon} #{text}"
  end
  button_tag(
    text.html_safe,
    options.merge(
      type: button_type,
      class: "btn btn-primary #{options[:class]}",
      'data-disable-with' => "#{Spree.t(:saving)}..."
    )
  )
end

#button_link_to(text, url, html_options = {}) ⇒ Object 



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'app/helpers/spree/admin/navigation_helper.rb', line 191

def button_link_to(text, url, html_options = {})
  if html_options[:method] &&
      !html_options[:method].to_s.casecmp('get').zero? &&
      !html_options[:remote]
    form_tag(url, method: html_options.delete(:method), class: 'd-inline') do
      button(text, html_options.delete(:icon), nil, html_options)
    end
  else
    if html_options['data-update'].nil? && html_options[:remote]
      object_name, action = url.split('/')[-2..-1]
      html_options['data-update'] = [action, object_name.singularize].join('_')
    end

    html_options.delete('data-update') unless html_options['data-update']

    html_options[:class] = html_options[:class] ? "btn #{html_options[:class]}" : 'btn btn-outline-secondary'

    if html_options[:icon]
      icon = content_tag(:span, '', class: "icon icon-#{html_options[:icon]}")
      text = "#{icon} #{text}"
    end

    link_to(text.html_safe, url, html_options)
  end
end

#configurations_sidebar_menu_item(link_text, url, options = {}) ⇒ Object 



217
218
219
220
221
222
223
224
225
226
227
 
# File 'app/helpers/spree/admin/navigation_helper.rb', line 217

def configurations_sidebar_menu_item(link_text, url, options = {})
  is_selected = url.ends_with?(controller.controller_name) ||
    url.ends_with?("#{controller.controller_name}/edit") ||
    url.ends_with?("#{controller.controller_name.singularize}/edit")

  options[:class] = 'sidebar-menu-item d-block w-100'
  options[:class] << ' selected' if is_selected
  content_tag(:li, options) do
    link_to(link_text, url, class: "#{'text-success' if is_selected} py-1 px-3 d-block sidebar-submenu-item")
  end
end

#klass_for(name) ⇒ Object

finds class for a given symbol / string

Example : :products returns Spree::Product :my_products returns MyProduct if MyProduct is defined :my_products returns My::Product if My::Product is defined if cannot constantize it returns nil This will allow us to use cancan abilities on tab



116
117
118
119
120
 
# File 'app/helpers/spree/admin/navigation_helper.rb', line 116

def klass_for(name)
  model_name = name.to_s

  ["Spree::#{model_name.classify}", model_name.classify, model_name.tr('_', '/').classify].find(&:safe_constantize).try(:safe_constantize)
end

#link_to_clone(resource, options = {}) ⇒ Object 



122
123
124
125
126
127
128
 
# File 'app/helpers/spree/admin/navigation_helper.rb', line 122

def link_to_clone(resource, options = {})
  options[:data] = { action: 'clone', 'original-title': Spree.t(:clone) }
  options[:class] = 'btn btn-primary btn-sm with-tip'
  options[:method] = :post
  options[:icon] = :clone
  button_link_to '', clone_object_url(resource), options
end

#link_to_clone_promotion(promotion, options = {}) ⇒ Object 



130
131
132
133
134
135
136
 
# File 'app/helpers/spree/admin/navigation_helper.rb', line 130

def link_to_clone_promotion(promotion, options = {})
  options[:data] = { action: 'clone', 'original-title': Spree.t(:clone) }
  options[:class] = 'btn btn-warning btn-sm with-tip'
  options[:method] = :post
  options[:icon] = :clone
  button_link_to '', clone_admin_promotion_path(promotion), options
end

#link_to_delete(resource, options = {}) ⇒ Object 



151
152
153
154
155
156
157
 
# File 'app/helpers/spree/admin/navigation_helper.rb', line 151

def link_to_delete(resource, options = {})
  url = options[:url] || object_url(resource)
  name = options[:name] || Spree.t(:delete)
  options[:class] = 'btn btn-danger btn-sm delete-resource'
  options[:data] = { confirm: Spree.t(:are_you_sure), action: 'remove' }
  link_to_with_icon 'delete', name, url, options
end

#link_to_edit(resource, options = {}) ⇒ Object 



138
139
140
141
142
143
 
# File 'app/helpers/spree/admin/navigation_helper.rb', line 138

def link_to_edit(resource, options = {})
  url = options[:url] || edit_object_url(resource)
  options[:data] = { action: 'edit' }
  options[:class] = 'btn btn-primary btn-sm'
  link_to_with_icon('edit', Spree.t(:edit), url, options)
end

#link_to_edit_url(url, options = {}) ⇒ Object 



145
146
147
148
149
 
# File 'app/helpers/spree/admin/navigation_helper.rb', line 145

def link_to_edit_url(url, options = {})
  options[:data] = { action: 'edit' }
  options[:class] = 'btn btn-primary btn-sm'
  link_to_with_icon('edit', Spree.t(:edit), url, options)
end

#link_to_with_icon(icon_name, text, url, options = {}) ⇒ Object 



159
160
161
162
163
164
165
166
167
168
169
 
# File 'app/helpers/spree/admin/navigation_helper.rb', line 159

def link_to_with_icon(icon_name, text, url, options = {})
  options[:class] = (options[:class].to_s + " icon-link with-tip action-#{icon_name}").strip
  options[:title] = text if options[:no_text]
  text = options[:no_text] ? '' : content_tag(:span, text, class: 'text')
  options.delete(:no_text)
  if icon_name
    icon = content_tag(:span, '', class: "#{'mr-2' unless text.empty?} icon icon-#{icon_name}")
    text = "#{icon} #{text}"
  end
  link_to(text.html_safe, url, options)
end

#main_menu_item(text, url: nil, icon: nil) ⇒ Object

Single main menu item



62
63
64
65
66
67
68
 
# File 'app/helpers/spree/admin/navigation_helper.rb', line 62

def main_menu_item(text, url: nil, icon: nil)
  link_to url, 'data-toggle': 'collapse', class: 'd-flex w-100 p-3 position-relative align-items-center' do
    content_tag(:span, nil, class: "icon icon-#{icon} mr-2") +
      content_tag(:span, " #{text}", class: 'text') +
      content_tag(:span, nil, class: 'icon icon-chevron-left position-absolute')
  end
end

#main_menu_tree(text, icon: nil, sub_menu: nil, url: '#') ⇒ Object

Main menu tree menu



71
72
73
74
75
76
 
# File 'app/helpers/spree/admin/navigation_helper.rb', line 71

def main_menu_tree(text, icon: nil, sub_menu: nil, url: '#')
  content_tag :li, class: 'sidebar-menu-item d-block w-100' do
    main_menu_item(text, url: url, icon: icon) +
      render(partial: "spree/admin/shared/sub_menu/#{sub_menu}")
  end
end

#main_part_classes ⇒ Object 



229
230
231
232
233
234
235
 
# File 'app/helpers/spree/admin/navigation_helper.rb', line 229

def main_part_classes
  if cookies['sidebar-minimized'] == 'true'
    'col-12 sidebar-collapsed'
  else
    'col-9 offset-3 col-md-10 offset-md-2'
  end
end

#main_sidebar_classes ⇒ Object 



237
238
239
240
241
242
243
 
# File 'app/helpers/spree/admin/navigation_helper.rb', line 237

def main_sidebar_classes
  if cookies['sidebar-minimized'] == 'true'
    'col-3 col-md-2 sidebar'
  else
    'p-0 col-3 col-md-2 sidebar'
  end
end

#per_page_dropdown ⇒ Object

the per_page_dropdown is used on index pages like orders, products, promotions etc. this method generates the select_tag



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'app/helpers/spree/admin/navigation_helper.rb', line 80

def per_page_dropdown
  # there is a config setting for admin_products_per_page, only for the orders page
  if @products && per_page_default = Spree::Config.admin_products_per_page
    per_page_options = []
    5.times do |amount|
      per_page_options << (amount + 1) * Spree::Config.admin_products_per_page
    end
  else
    per_page_default = Spree::Config.admin_orders_per_page
    per_page_options = %w{15 30 45 60}
  end

  selected_option = params[:per_page].try(:to_i) || per_page_default

  select_tag(:per_page,
             options_for_select(per_page_options, selected_option),
             class: "form-control pull-right js-per-page-select per-page-selected-#{selected_option}")
end

#per_page_dropdown_params(args = nil) ⇒ Object

helper method to create proper url to apply per page filtering fixes github.com/spree/spree/issues/6888



101
102
103
104
105
106
 
# File 'app/helpers/spree/admin/navigation_helper.rb', line 101

def per_page_dropdown_params(args = nil)
  args = params.permit!.to_h.clone
  args.delete(:page)
  args.delete(:per_page)
  args
end

#spree_icon(icon_name) ⇒ Object 



171
172
173
 
# File 'app/helpers/spree/admin/navigation_helper.rb', line 171

def spree_icon(icon_name)
  icon_name ? content_tag(:i, '', class: icon_name) : ''
end

#tab(*args) ⇒ Object

Makes an admin navigation tab (<li> tag) that links to a routing resource under /admin. The arguments should be a list of symbolized controller names that will cause this tab to be highlighted, with the first being the name of the resouce to link (uses URL helpers).

Option hash may follow. Valid options are

* :label to override link text, otherwise based on the first resource name (translated)
* :route to override automatically determining the default route
* :match_path as an alternative way to control when the tab is active, /products would
  match /admin/products, /admin/products/5/variants etc.  Can be a String or a Regexp.
  Controller names are ignored if :match_path is provided.

Example:

# Link to /admin/orders, also highlight tab for ProductsController and ShipmentsController
tab :orders, :products, :shipments



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'app/helpers/spree/admin/navigation_helper.rb', line 18

def tab(*args)
  options = { label: args.first.to_s }

  # Return if resource is found and user is not allowed to :admin
  return '' if (klass = klass_for(options[:label])) && cannot?(:admin, klass)

  options = options.merge(args.pop) if args.last.is_a?(Hash)
  options[:route] ||= "admin_#{args.first}"

  destination_url = options[:url] || spree.send("#{options[:route]}_path")
  titleized_label = Spree.t(options[:label], default: options[:label], scope: [:admin, :tab]).titleize

  css_classes = ['sidebar-menu-item d-block w-100 position-relative']

  selected = if options[:match_path].is_a? Regexp
               request.fullpath =~ options[:match_path]
             elsif options[:match_path]
               request.fullpath.starts_with?("#{spree.admin_path}#{options[:match_path]}")
             else
               args.include?(controller.controller_name.to_sym)
             end

  link = if options[:icon]
           link_to_with_icon(
             options[:icon],
             titleized_label,
             destination_url,
             class: 'w-100 p-3 d-flex align-items-center'
           )
         else
           link_to(
             titleized_label,
             destination_url,
             class: "sidebar-submenu-item w-100 py-1 px-3 d-block #{'text-success' if selected}"
           )
         end

  css_classes << 'selected' if selected

  css_classes << options[:css_class] if options[:css_class]
  content_tag('li', link, class: css_classes.join(' '))
end

#wrapper_classes ⇒ Object 



245
246
247
 
# File 'app/helpers/spree/admin/navigation_helper.rb', line 245

def wrapper_classes
  'sidebar-minimized' if cookies['sidebar-minimized'] == 'true'
end