Merge d511913 into 9abc1be

app/assets/javascripts/rails_admin/ra.horizontal-scroll-list.coffee

@@ -0,0 +1,16 @@
+(->
+  $ = jQuery
+
+  setFrozenColPositions = ->
+    $listForm = $('#bulk_form')
+    return unless $listForm.is('.ra-horizontal-scroll-list')
+    $listForm.find('table tr').each (index, tr) ->
+      firstPosition = 0
+      $(tr).find('.ra-horizontal-scroll-frozen').each (idx, td) ->
+        tdLeft = $(td).position().left
+        firstPosition = tdLeft if idx == 0
+        td.style.left = "#{tdLeft - firstPosition}px"
+
+  $(window).on('load', setFrozenColPositions) # Update after link icons load.
+  $(document).on('rails_admin.dom_ready', setFrozenColPositions)
+)()

app/assets/javascripts/rails_admin/rails_admin.js

@@ -15,5 +15,6 @@
 //=  require 'rails_admin/ra.i18n'
 //=  require 'rails_admin/bootstrap/bootstrap'
 //=  require 'rails_admin/ra.widgets'
+//=  require 'rails_admin/ra.horizontal-scroll-list'
 //=  require 'rails_admin/ui'
 //=  require 'rails_admin/custom/ui'

app/assets/stylesheets/rails_admin/ra.horizontal-scroll-table.scss

@@ -0,0 +1,29 @@
+.ra-horizontal-scroll-table {
+  margin-bottom: 20px;
+  overflow-x: auto;
+  .table {
+    margin-bottom: 0;
+  }
+
+  .ra-horizontal-scroll-frozen {
+    position: sticky;
+  }
+
+  // Remove transparency on frozen cells.
+  $table-bg-default: if($table-bg == transparent, if($body-bg == transparent, #fff, $body-bg), $table-bg) !default;
+  .table-striped > tbody > tr:nth-child(even) > td, .table-striped > thead > tr > th {
+    background-color: $table-bg-default;
+  }
+  $table-bg-header-sort: #e2eff6 !default;
+  .table .ra-horizontal-scroll-frozen {
+    &.headerSortUp, &.headerSortDown {
+      background-color: $table-bg-header-sort;
+    }
+  }
+
+  // border-right isn't sticky
+  .ra-horizontal-scroll-frozen-last {
+    box-shadow: -1px 0 0 0 $table-border-color inset;
+    padding-right: $table-condensed-cell-padding + 1px;
+  }
+}

app/assets/stylesheets/rails_admin/rails_admin.scss.erb

@@ -55,6 +55,7 @@
 @import "rails_admin/bootstrap-datetimepicker-build";
 @import "rails_admin/ra.filtering-multiselect";
 @import "rails_admin/ra.widgets";
+@import "rails_admin/ra.horizontal-scroll-table";
 @import "rails_admin/jquery.colorpicker";
 
 

app/views/rails_admin/main/index.html.haml

@@ -12,10 +12,22 @@
   properties = @model_config.list.with(controller: self.controller, view: self, object: @abstract_model.model.new).visible_fields
   checkboxes = @model_config.list.checkboxes?
   # columns paginate
-  sets = get_column_sets(properties)
-  properties = sets[params[:set].to_i] || []
-  other_left = ((params[:set].to_i - 1) >= 0) && sets[params[:set].to_i - 1].present?
-  other_right = sets[params[:set].to_i + 1].present?
+  horiz_scroll_config = RailsAdmin::Config.horizontal_scroll_list
+  horiz_scroll_enabled = !!horiz_scroll_config
+  if horiz_scroll_enabled
+    if horiz_scroll_config.is_a?(Hash)
+      horiz_scroll_frozen_cols = horiz_scroll_config[:num_frozen_columns]
+      horiz_scroll_css = horiz_scroll_config[:css]
+    end
+    horiz_scroll_frozen_cols ||= 3 # by default, freeze checkboxes, links & first property (usually id?)
+    horiz_scroll_frozen_cols -= 1 unless checkboxes
+  else
+    horiz_scroll_frozen_cols = 0
+    sets = get_column_sets(properties)
+    properties = sets[params[:set].to_i] || []
+    other_left = ((params[:set].to_i - 1) >= 0) && sets[params[:set].to_i - 1].present?
+    other_right = sets[params[:set].to_i + 1].present?
+  end
 
 - content_for :contextual_tabs do
   - if checkboxes
@@ -68,43 +80,54 @@
         %li{class: "#{'active' if scope.to_s == params[:scope] || (params[:scope].blank? && index == 0)}"}
           %a{href: index_path(params.merge(scope: scope, page: nil)), class: 'pjax'}= I18n.t("admin.scopes.#{@abstract_model.to_param}.#{scope}", default: I18n.t("admin.scopes.#{scope}", default: scope.to_s.titleize))
 
-  = form_tag bulk_action_path(model_name: @abstract_model.to_param), method: :post, id: "bulk_form", class: "form" do
+  = form_tag bulk_action_path(model_name: @abstract_model.to_param), method: :post, id: "bulk_form", class: ["form", horiz_scroll_frozen_cols > 0 ? "ra-horizontal-scroll-list" : nil].compact.join(' ') do
     = hidden_field_tag :bulk_action
     - if description.present?
       %p
         %strong= description
 
-    %table.table.table-condensed.table-striped
-      %thead
-        %tr
-          - if checkboxes
-            %th.shrink
-              %input.toggle{type: "checkbox"}
-          - if other_left
-            %th.other.left.shrink= "..."
-          - properties.each do |property|
-            - selected = (sort == property.name.to_s)
-            - if property.sortable
-              - sort_location = index_path params.except('sort_reverse').except('page').merge(sort: property.name).merge(selected && sort_reverse != "true" ? {sort_reverse: "true"} : {})
-              - sort_direction = (sort_reverse == 'true' ? "headerSortUp" : "headerSortDown" if selected)
-            %th{class: "#{property.sortable && "header pjax" || nil} #{sort_direction if property.sortable && sort_direction} #{property.css_class} #{property.type_css_class}", :'data-href' => (property.sortable && sort_location), rel: "tooltip", title: "#{property.hint}"}= capitalize_first_letter(property.label)
-          - if other_right
-            %th.other.right.shrink= "..."
-          %th.last.shrink
-      %tbody
-        - @objects.each do |object|
-          %tr{class: "#{@abstract_model.param_key}_row #{@model_config.list.with(object: object).row_css_class}"}
+    .table-wrapper{class: horiz_scroll_enabled && 'ra-horizontal-scroll-table'}
+      %table.table.table-condensed.table-striped
+        %thead
+          %tr
+            - horiz_scroll_i = horiz_scroll_frozen_cols
             - if checkboxes
-              %td= check_box_tag "bulk_ids[]", object.id, false
-            - if @other_left_link ||= other_left && index_path(params.except('set').merge(params[:set].to_i != 1 ? {set: (params[:set].to_i - 1)} : {}))
-              %td.other.left= link_to "...", @other_left_link, class: 'pjax'
-            - properties.map{ |property| property.bind(:object, object) }.each do |property|
-              - value = property.pretty_value
-              %td{class: "#{property.css_class} #{property.type_css_class}", title: strip_tags(value.to_s)}= value
-            - if @other_right_link ||= other_right && index_path(params.merge(set: (params[:set].to_i + 1)))
-              %td.other.right= link_to "...", @other_right_link, class: 'pjax'
-            %td.last.links
-              %ul.inline.list-inline= menu_for :member, @abstract_model, object, true
+              %th.shrink{class: [(horiz_scroll_i -= 1) > -1 && 'ra-horizontal-scroll-frozen', horiz_scroll_i == 0 && 'ra-horizontal-scroll-frozen-last']}
+                %input.toggle{type: "checkbox"}
+            - if horiz_scroll_enabled
+              %th.last.shrink{class: [(horiz_scroll_i -= 1) > -1 && 'ra-horizontal-scroll-frozen', horiz_scroll_i == 0 && 'ra-horizontal-scroll-frozen-last']}
+            - elsif other_left
+              %th.other.left.shrink= "..."
+            - properties.each do |property|
+              - selected = (sort == property.name.to_s)
+              - if property.sortable
+                - sort_location = index_path params.except('sort_reverse').except('page').merge(sort: property.name).merge(selected && sort_reverse != "true" ? {sort_reverse: "true"} : {})
+                - sort_direction = (sort_reverse == 'true' ? "headerSortUp" : "headerSortDown" if selected)
+              %th{class: [property.sortable && "header pjax", property.sortable && sort_direction, property.css_class, property.type_css_class, (horiz_scroll_i -= 1) > -1 && 'ra-horizontal-scroll-frozen', horiz_scroll_i == 0 && 'ra-horizontal-scroll-frozen-last'], :'data-href' => (property.sortable && sort_location), rel: "tooltip", title: "#{property.hint}"}= capitalize_first_letter(property.label)
+            - unless horiz_scroll_enabled
+              - if other_right
+                %th.other.right.shrink= "..."
+              %th.last.shrink
+        %tbody
+          - @objects.each do |object|
+            - horiz_scroll_i = horiz_scroll_frozen_cols
+            %tr{class: "#{@abstract_model.param_key}_row #{@model_config.list.with(object: object).row_css_class}"}
+              - if checkboxes
+                %td{class: [(horiz_scroll_i -= 1) > -1 && 'ra-horizontal-scroll-frozen', horiz_scroll_i == 0 && 'ra-horizontal-scroll-frozen-last']}= check_box_tag "bulk_ids[]", object.id, false
+              - td_links = capture do
+                %td.last.links{class: [(horiz_scroll_i -= 1) > -1 && 'ra-horizontal-scroll-frozen', horiz_scroll_i == 0 && 'ra-horizontal-scroll-frozen-last']}
+                  %ul.inline.list-inline= menu_for :member, @abstract_model, object, true
+              - if horiz_scroll_enabled
+                = td_links
+              - elsif @other_left_link ||= other_left && index_path(params.except('set').merge(params[:set].to_i != 1 ? {set: (params[:set].to_i - 1)} : {}))
+                %td.other.left= link_to "...", @other_left_link, class: 'pjax'
+              - properties.map{ |property| property.bind(:object, object) }.each do |property|
+                - value = property.pretty_value
+                %td{class: [property.css_class, property.type_css_class, (horiz_scroll_i -= 1) > -1 && 'ra-horizontal-scroll-frozen', horiz_scroll_i == 0 && 'ra-horizontal-scroll-frozen-last' ], title: strip_tags(value.to_s)}= value
+              - unless horiz_scroll_enabled
+                - if @other_right_link ||= other_right && index_path(params.merge(set: (params[:set].to_i + 1)))
+                  %td.other.right= link_to "...", @other_right_link, class: 'pjax'
+                = td_links
 
     - if @model_config.list.limited_pagination
       .row

lib/rails_admin/config.rb

@@ -59,6 +59,9 @@ class << self
       # Set the max width of columns in list view before a new set is created
       attr_accessor :total_columns_width
 
+      # Enable horizontal-scroll table in list view, ignore total_columns_width
+      attr_accessor :horizontal_scroll_list
+
       # set parent controller
       attr_accessor :parent_controller
 
@@ -285,6 +288,7 @@ def reset
         @excluded_models = []
         @included_models = []
         @total_columns_width = 697
+        @horizontal_scroll_list = nil
         @label_methods = [:name, :title]
         @main_app_name = proc { [Rails.application.engine_name.titleize.chomp(' Application'), 'Admin'] }
         @registry = {}

spec/integration/config/list/rails_admin_config_list_spec.rb

@@ -474,4 +474,87 @@
       end
     end
   end
+
+  describe 'horizontal-scroll list option' do
+    all_team_columns = ['', '', 'Id', 'Created at', 'Updated at', 'Division', 'Name', 'Logo url', 'Team Manager', 'Ballpark', 'Mascot', 'Founded', 'Wins', 'Losses', 'Win percentage', 'Revenue', 'Color', 'Custom field', 'Main Sponsor', 'Players', 'Some Fans', 'Comments']
+
+    it "displays all fields on one page when true" do
+      RailsAdmin.config do |config|
+        config.horizontal_scroll_list = true
+      end
+      FactoryGirl.create_list :team, 3
+      visit index_path(model_name: 'team')
+      cols = all('th').collect(&:text)
+      expect(cols[0..4]).to eq(all_team_columns[0..4])
+      expect(cols).to contain_exactly(*all_team_columns)
+      expect(page).to have_selector('.table-wrapper.ra-horizontal-scroll-table')
+      expect(page).to have_selector('.ra-horizontal-scroll-list')
+      expect(all('.ra-horizontal-scroll-frozen').count).to eq(12)
+      expect(all('th.ra-horizontal-scroll-frozen').count).to eq(3)
+      expect(all('td.ra-horizontal-scroll-frozen').count).to eq(9)
+      expect(all('.ra-horizontal-scroll-frozen-last').count).to eq(4)
+    end
+
+    it "displays all fields with custom frozen columns" do
+      RailsAdmin.config do |config|
+        config.horizontal_scroll_list = {num_frozen_columns: 2}
+      end
+      FactoryGirl.create_list :team, 3
+      visit index_path(model_name: 'team')
+      cols = all('th').collect(&:text)
+      expect(cols[0..4]).to eq(all_team_columns[0..4])
+      expect(cols).to contain_exactly(*all_team_columns)
+      expect(page).to have_selector('.table-wrapper.ra-horizontal-scroll-table')
+      expect(page).to have_selector('.ra-horizontal-scroll-list')
+      expect(all('.ra-horizontal-scroll-frozen').count).to eq(8)
+      expect(all('th.ra-horizontal-scroll-frozen').count).to eq(2)
+      expect(all('td.ra-horizontal-scroll-frozen').count).to eq(6)
+      expect(all('.ra-horizontal-scroll-frozen-last').count).to eq(4)
+    end
+
+    it "displays all fields with no checkboxes" do
+      RailsAdmin.config do |config|
+        config.horizontal_scroll_list = true
+      end
+      RailsAdmin.config Team do
+        list do
+          checkboxes false
+        end
+      end
+      FactoryGirl.create_list :team, 3
+      visit index_path(model_name: 'team')
+      cols = all('th').collect(&:text)
+      expect(cols[0..3]).to eq(all_team_columns[1..4])
+      expect(cols).to contain_exactly(*all_team_columns[1..-1])
+      expect(all('.ra-horizontal-scroll-frozen').count).to eq(8)
+      expect(all('th.ra-horizontal-scroll-frozen').count).to eq(2)
+      expect(all('td.ra-horizontal-scroll-frozen').count).to eq(6)
+      expect(all('.ra-horizontal-scroll-frozen-last').count).to eq(4)
+    end
+
+    it "displays all fields with no frozen columns" do
+      RailsAdmin.config do |config|
+        config.horizontal_scroll_list = {num_frozen_columns: 0}
+      end
+      FactoryGirl.create_list :team, 3
+      visit index_path(model_name: 'team')
+      cols = all('th').collect(&:text)
+      expect(cols[0..4]).to eq(all_team_columns[0..4])
+      expect(cols).to contain_exactly(*all_team_columns)
+      expect(page).to have_selector('.table-wrapper.ra-horizontal-scroll-table')
+      expect(page).not_to have_selector('.ra-horizontal-scroll-list')
+      expect(all('.ra-horizontal-scroll-frozen').count).to eq(0)
+      expect(all('.ra-horizontal-scroll-frozen-last').count).to eq(0)
+    end
+
+    it "displays sets when not set" do
+      visit index_path(model_name: 'team')
+      expect(all('th').collect(&:text)).to eq ['', 'Id', 'Created at', 'Updated at', 'Division', 'Name', 'Logo url', '...', '']
+      expect(page).to have_selector('.table-wrapper')
+      expect(page).not_to have_selector('.table-wrapper.ra-horizontal-scroll-table')
+      expect(page).not_to have_selector('.ra-horizontal-scroll-list')
+      expect(all('.ra-horizontal-scroll-frozen').count).to eq(0)
+      expect(all('.ra-horizontal-scroll-frozen-last').count).to eq(0)
+    end
+  end
 end