Class: Playbook::PbAdvancedTable::TableHeader

Inherits:
KitBase
  • Object
show all
Includes:
ColumnLayoutHelper
Defined in:
app/pb_kits/playbook/pb_advanced_table/table_header.rb

Constant Summary

Constants inherited from KitBase

KitBase::EMPTY_HASH

Constants included from Border

Border::BORDER_PROP_MAP, Border::BORDER_VALUES

Constants included from MaxHeight

MaxHeight::MAX_HEIGHT_VALUES

Constants included from MinHeight

MinHeight::MIN_HEIGHT_VALUES

Constants included from Height

Height::HEIGHT_VALUES

Constants included from VerticalAlign

VerticalAlign::SCREEN_SIZES, VerticalAlign::VERTICAL_ALIGN_VALUES

Constants included from Bottom

Bottom::BOTTOM_VALUES

Constants included from Playbook::PositionPropsCss

Playbook::PositionPropsCss::POSITION_VALUES

Constants included from Right

Right::RIGHT_VALUES

Constants included from Top

Top::TOP_VALUES

Constants included from Left

Left::LEFT_VALUES

Constants included from Truncate

Truncate::TRUNCATE_VALUES

Constants included from Overflow

Overflow::OVERFLOW_VALUES

Constants included from TextAlign

TextAlign::SCREEN_SIZES, TextAlign::TEXT_ALIGN_VALUES

Constants included from BorderRadius

BorderRadius::BORDER_RADIUS_VALUES

Constants included from Hover

Hover::HOVER_ATTRIBUTES, Hover::HOVER_BACKGROUND_VALUES, Hover::HOVER_COLOR_VALUES, Hover::HOVER_SCALE_VALUES, Hover::HOVER_SHADOW_VALUES, Hover::HOVER_UNDERLINE_VALUES, Hover::HOVER_VISIBLE_VALUES

Constants included from Playbook::Position

Playbook::Position::POSITION_VALUES

Constants included from Order

Order::ORDER_VALUES, Order::SCREEN_SIZES

Constants included from FlexShrink

FlexShrink::FLEX_SHRINK_VALUES, FlexShrink::SCREEN_SIZES

Constants included from FlexGrow

FlexGrow::FLEX_GROW_VALUES, FlexGrow::SCREEN_SIZES

Constants included from Flex

Flex::FLEX_VALUES, Flex::SCREEN_SIZES

Constants included from AlignSelf

AlignSelf::ALIGN_SELF_VALUES, AlignSelf::SCREEN_SIZES

Constants included from AlignContent

AlignContent::ALIGN_CONTENT_VALUES, AlignContent::SCREEN_SIZES

Constants included from AlignItems

AlignItems::ALIGN_ITEMS_VALUES, AlignItems::SCREEN_SIZES

Constants included from JustifySelf

JustifySelf::JUSTIFY_SELF_VALUES, JustifySelf::SCREEN_SIZES

Constants included from JustifyContent

JustifyContent::JUSTIFY_CONTENT_VALUES, JustifyContent::SCREEN_SIZES

Constants included from FlexWrap

FlexWrap::FLEX_WRAP_VALUES, FlexWrap::SCREEN_SIZES

Constants included from FlexDirection

FlexDirection::FLEX_DIRECTION_VALUES, FlexDirection::SCREEN_SIZES

Constants included from Cursor

Cursor::CURSOR_VALUES

Constants included from Display

Display::DISPLAY_SIZE_VALUES, Display::DISPLAY_VALUES

Constants included from LineHeight

LineHeight::LINE_HEIGHT_VALUES

Constants included from Shadow

Shadow::SHADOW_VALUES

Constants included from NumberSpacing

NumberSpacing::NUMBER_SPACING_VALUES

Constants included from ZIndex

ZIndex::SCREEN_SIZES, ZIndex::Z_INDEX_VALUES

Constants included from Spacing

Spacing::BREAK_METHOD_VALUES, Spacing::GAP_VALUES, Spacing::MAX_WIDTH_VALUES, Spacing::MIN_WIDTH_VALUES, Spacing::SCREEN_SIZES, Spacing::SCREEN_SIZE_VALUES, Spacing::SPACING_HASH_SKIP_KEYS, Spacing::SPACING_PROP_MAP, Spacing::SPACING_VALUES, Spacing::WIDTH_VALUES

Instance Attribute Summary

Attributes included from Playbook::Props

#values

Instance Method Summary collapse

Methods included from ColumnLayoutHelper

#build_column_layout_styles, #build_column_layout_styles_from_column, #css_length, #read_styling_length

Methods inherited from KitBase

#combined_html_options, #global_inline_props, #object, #pb_content_tag, #react_component

Methods included from Border

border_class_for, border_class_for_prop, #border_options, #border_props, #border_values, included

Methods included from MaxHeight

included, #max_height_options, #max_height_props, #max_height_values

Methods included from MinHeight

included, #min_height_options, #min_height_props, #min_height_values

Methods included from Height

#height_options, #height_props, #height_values, included

Methods included from VerticalAlign

included, #vertical_align_options, #vertical_align_props, #vertical_align_values

Methods included from Bottom

#bottom_options, #bottom_values, included

Methods included from Playbook::PositionPropsCss

#positioning_css

Methods included from Right

included, #right_options, #right_values

Methods included from Top

included, #top_options, #top_values

Methods included from Left

included, #left_options, #left_values

Methods included from Truncate

included, #truncate_options, #truncate_props, #truncate_values

Methods included from Overflow

included, #overflow_options, #overflow_props, #overflow_values

Methods included from TextAlign

included, #text_align_options, #text_align_props, #text_align_values

Methods included from BorderRadius

#border_radius_options, #border_radius_props, #border_radius_values, included

Methods included from Hover

#hover_attributes, #hover_background_values, #hover_color_values, #hover_options, #hover_props, #hover_scale_values, #hover_shadow_values, #hover_underline_values, #hover_values, #hover_visible_values, included

Methods included from Playbook::Position

included, #position_options, #position_values

Methods included from Order

included, #order_options, #order_props, #order_values

Methods included from FlexShrink

#flex_shrink_options, #flex_shrink_props, #flex_shrink_values, included

Methods included from FlexGrow

#flex_grow_options, #flex_grow_props, #flex_grow_values, included

Methods included from Flex

#flex_options, #flex_props, #flex_values, included

Methods included from AlignSelf

#align_self_options, #align_self_props, #align_self_values, included

Methods included from AlignContent

#align_content_options, #align_content_props, #align_content_values, included

Methods included from AlignItems

#align_items_options, #align_items_props, #align_items_values, included

Methods included from JustifySelf

included, #justify_self_options, #justify_self_props, #justify_self_values

Methods included from JustifyContent

included, #justify_content_options, #justify_content_props, #justify_content_values

Methods included from FlexWrap

#flex_wrap_options, #flex_wrap_props, #flex_wrap_values, included

Methods included from FlexDirection

#flex_direction_options, #flex_direction_props, #flex_direction_values, included

Methods included from Cursor

#cursor_options, #cursor_props, #cursor_values, included

Methods included from Display

#display_options, #display_props, #display_size_values, #display_values, included

Methods included from LineHeight

included, #line_height_options, #line_height_props, #line_height_values

Methods included from Shadow

included, #shadow_options, #shadow_props, #shadow_values

Methods included from NumberSpacing

included, #number_spacing_options, #number_spacing_values

Methods included from ZIndex

included, #screen_size_values, #z_index_options, #z_index_props, #z_index_values

Methods included from Spacing

#break_method_values, #column_gap_options, #column_gap_props, #filter_classname, #gap_options, #gap_props, #gap_values, included, #max_width_options, #max_width_props, #max_width_values, #min_width_options, #min_width_props, #min_width_values, #row_gap_options, #row_gap_props, #screen_size_values, #spacing_options, #spacing_props, #spacing_values, #width_options, #width_props, #width_values

Methods included from Classnames

#dark_props, #generate_classname, #generate_classname_without_spacing, included

Methods included from Playbook::Props

#initialize, #prop

Methods included from Playbook::PbKitHelper

#deprecated_kit_warning, #pb_rails

Methods included from Playbook::PbFormsHelper

#pb_form_with

Instance Method Details

#classname ⇒ Object 



32
33
34
35
36
37
38
 
# File 'app/pb_kits/playbook/pb_advanced_table/table_header.rb', line 32

def classname
  additional_classes = []
  additional_classes << "advanced-table-responsive-#{responsive} pinned-left" if responsive == "scroll"
  additional_classes << "selectable-rows-enabled" if selectable_rows && enable_toggle_expansion == "none"

  generate_classname("pb_advanced_table_header", "pb_table_thead", *additional_classes, separator: " ")
end

#find_original_column_def(accessor) ⇒ Object

Get original column definition for custom rendering by accessor



95
96
97
 
# File 'app/pb_kits/playbook/pb_advanced_table/table_header.rb', line 95

def find_original_column_def(accessor)
  find_column_def_by_accessor(column_definitions, accessor)
end

#find_original_column_def_by_id(id) ⇒ Object

Get original column definition for custom rendering by id



100
101
102
 
# File 'app/pb_kits/playbook/pb_advanced_table/table_header.rb', line 100

def find_original_column_def_by_id(id)
  find_column_def_by_id(column_definitions, id)
end

#has_any_sub_rows? ⇒ Boolean

Check if any row in the table has children

Returns:



148
149
150
151
152
 
# File 'app/pb_kits/playbook/pb_advanced_table/table_header.rb', line 148

def has_any_sub_rows?
  return false if table_data.blank?

  table_data.any? { |row| row_has_children?(row) }
end

#has_custom_header_background_color?(cell) ⇒ Boolean

Check if header has custom background color

Returns:



162
163
164
 
# File 'app/pb_kits/playbook/pb_advanced_table/table_header.rb', line 162

def has_custom_header_background_color?(cell)
  cell[:header_background_color].present?
end

#has_header_renderer?(cell) ⇒ Boolean

Check if a header cell has a custom renderer

Returns:



105
106
107
108
109
110
 
# File 'app/pb_kits/playbook/pb_advanced_table/table_header.rb', line 105

def has_header_renderer?(cell)
  original_def = find_original_column_def_for_cell(cell)
  original_def&.dig(:header).present?
rescue
  false
end

#header_background_color(cell) ⇒ Object

Get header background color from column styling



132
133
134
135
136
137
 
# File 'app/pb_kits/playbook/pb_advanced_table/table_header.rb', line 132

def header_background_color(cell)
  original_def = find_original_column_def_for_cell(cell)
  return nil unless original_def

  original_def.dig(:column_styling, :header_background_color)
end

#header_component_info(cell, cell_index, row_index) ⇒ Object

Returns component info for header cell (uses background kit if custom bg color)



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'app/pb_kits/playbook/pb_advanced_table/table_header.rb', line 167

def header_component_info(cell, cell_index, row_index)
  header_id = cell[:accessor].present? ? cell[:accessor] : "header_#{row_index}_#{cell_index}"
  classname = [th_classname(is_first_column: cell_index.zero?), ("last-header-cell" if cell[:is_last_in_group] && cell_index != 0)].compact.join(" ")
  layout_styles = header_layout_styles(cell)
  style_hash = layout_styles.dup
  style_hash[:color] = cell[:header_font_color] if cell[:header_font_color].present?

  if has_custom_header_background_color?(cell)
    component_name = "background"
    component_props = {
      background_color: cell[:header_background_color],
      tag: "th",
      classname: classname,
    }
    component_props[:html_options] = {
      id: header_id,
      colspan: cell[:colspan],
      style: style_hash,
    }
  else
    component_name = "table/table_header"
    component_props = {
      id: header_id,
      colspan: cell[:colspan],
      classname: classname,
      sort_menu: cell[:accessor] ? cell[:sort_menu] : nil,
    }
    component_props[:html_options] = { style: style_hash } if style_hash.present?
  end

  { name: component_name, props: component_props }
end

#header_flex_justify(cell, cell_index, row_index) ⇒ Object

Flex justify for header cells: column_styling header_alignment when present (otherwisedefault by column/row index)



201
202
203
204
205
206
 
# File 'app/pb_kits/playbook/pb_advanced_table/table_header.rb', line 201

def header_flex_justify(cell, cell_index, row_index)
  ha = cell[:header_alignment]
  return header_alignment_to_justify(ha) if ha.present?

  default_header_flex_justify(cell_index, row_index)
end

#header_flex_text_align(cell) ⇒ Object

Flex text_align from column_styling header_alignment (default is end)



209
210
211
 
# File 'app/pb_kits/playbook/pb_advanced_table/table_header.rb', line 209

def header_flex_text_align(cell)
  (cell[:header_alignment].presence || "end").to_s
end

#header_font_color(cell) ⇒ Object

Get header font color from column styling



140
141
142
143
144
145
 
# File 'app/pb_kits/playbook/pb_advanced_table/table_header.rb', line 140

def header_font_color(cell)
  original_def = find_original_column_def_for_cell(cell)
  return nil unless original_def

  original_def.dig(:column_styling, :header_font_color)
end

#header_rows ⇒ Object 



48
49
50
51
52
53
54
55
56
 
# File 'app/pb_kits/playbook/pb_advanced_table/table_header.rb', line 48

def header_rows
  wrapped_columns = wrap_leaf_columns(column_definitions)

  rows = []
  max_depth = compute_max_depth(wrapped_columns)
  max_depth.times { rows << [] }
  process_columns(wrapped_columns, rows, 0, max_depth)
  rows
end

#render_header(cell) ⇒ Object

Render custom header content



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'app/pb_kits/playbook/pb_advanced_table/table_header.rb', line 113

def render_header(cell)
  return cell[:label] unless has_header_renderer?(cell)

  original_def = find_original_column_def_for_cell(cell)
  return cell[:label] unless original_def

  custom_renderer = original_def[:header]
  return cell[:label] unless custom_renderer

  # Call the custom renderer with the cell data and label
  begin
    result = custom_renderer.call(cell, cell[:label])
    result.present? ? result.to_s : cell[:label]
  rescue
    cell[:label]
  end
end

#render_select_all_checkbox ⇒ Object

Selectable Rows w/ Subrows - checkboxes part of toggleable first cell



80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'app/pb_kits/playbook/pb_advanced_table/table_header.rb', line 80

def render_select_all_checkbox
  if selectable_rows
    pb_rails("checkbox", props: {
               id: "#{table_id ? "#{table_id}-" : ''}select-all-rows",
               indeterminate_main: true,
               indeterminate_main_labels: ["", ""],
               name: "#{table_id ? "#{table_id}-" : ''}select-all-rows",
               data: {
                 action: "click->pb-advanced-table#toggleAllRowSelection",
               },
             })
  end
end

#render_select_all_header ⇒ Object

Selectable Rows No Subrows - checkboxes in their own first cell



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'app/pb_kits/playbook/pb_advanced_table/table_header.rb', line 59

def render_select_all_header
  if selectable_rows
    additional_classes = []
    additional_classes << "table-header-cells-custom"
    additional_classes << "header-cells-with-actions" if show_actions_bar
    additional_classes << "checkbox-cell-header"
    additional_classes << "pinned-left" if responsive == "scroll"
    pb_rails("table/table_header", props: {
               classname: additional_classes.join(" "),
             }) do
      pb_rails("checkbox", props: {
                 id: "#{table_id ? "#{table_id}-" : ''}select-all-rows",
                 indeterminate_main: true,
                 indeterminate_main_labels: ["", ""],
                 name: "#{table_id ? "#{table_id}-" : ''}select-all-rows",
               })
    end
  end
end

#show_toggle_all_button? ⇒ Boolean

Determines if the toggle-all button should be shown in the header based on inline row loading and persist toggle expansion button props

Returns:



155
156
157
158
159
 
# File 'app/pb_kits/playbook/pb_advanced_table/table_header.rb', line 155

def show_toggle_all_button?
  return false unless enable_toggle_expansion == "header" || enable_toggle_expansion == "all"

  has_any_sub_rows? || (inline_row_loading && persist_toggle_expansion_button)
end

#th_classname(is_first_column: false) ⇒ Object 



40
41
42
43
44
45
46
 
# File 'app/pb_kits/playbook/pb_advanced_table/table_header.rb', line 40

def th_classname(is_first_column: false)
  additional_classes = []
  additional_classes << "pinned-left" if is_first_column && responsive == "scroll" && !selectable_rows
  additional_classes << "header-cells-with-actions" if selectable_rows && show_actions_bar

  generate_classname("table-header-cells", *additional_classes, separator: " ")
end