Advanced Table

Default

Summary

Default (Required Props)

Year	New Enrollments	Scheduled Meetings	Attendance Rate	Completed Classes	Class Completion Rate	Graduated Students
2021	20	10	51%	3	33%	19
Q1	2	35	32%	15	52%	36
January	16	20	11%	13	47%	28
10	34	28	97%	20	15%	17
20	43	23	66%	26	47%	9
February	20	41	95%	26	83%	43
15	19	35	69%	8	75%	23
2022	25	17	75%	5	45%	32
Q1	2	35	32%	15	52%	36
January	16	20	11%	13	47%	28
15	34	28	97%	20	15%	17
25	43	23	66%	26	47%	9
May	20	41	95%	26	83%	43
2	19	35	69%	8	75%	23
2023	10	15	65%	4	49%	29
Q1	2	35	32%	15	52%	36
March	16	20	11%	13	47%	28
10	34	28	97%	20	15%	17
11	43	23	66%	26	47%	9
April	20	41	95%	26	83%	43
15	19	35	69%	8	75%	23

The AdvancedTable kit accepts tree data and automatically renders expansion controls for nested subrows, to any depth, based on the data it is given. In it's simplest form, the kit has three required props:

id

A unique id is required to allow the table functionality to work properly. Without it, certain functions like the action bar, expand/collapse caching, or selectable rows will not be able to properly reference the correct table.

You must also set table_id when using subcomponents like table_header or table_body.

table_data

table_data accepts an array of objects as the table data. Each object is a table row, and each key:value pair within an object is a column value within that row. Nested children within a data object are automatically rendered as subrows under their parent row.

For a visual of the data structure needed for table_data, see here.

column_definitions

Column definitions are the single most important part of building a table as they are responsible for building the underlying data model that is used for all sorting, expansion, etc. column_definitions in the AdvancedTable kit is an array of objects as seen in the code snippet below. Each object within the array has two REQUIRED items:

accessor: this is the key from your data for the value you want rendered in that column
label: this is what will be rendered as the column header label

There is also one optional item that is only required if the table has nested data:

cellAccessors: This is an array of strings that represent keys from your data object. This is only required for the first column in case of nested data. If you have nested data, the AdvancedTable needs to know what to render in that first column for nested items. This array represents the nested data in the order you want it rendered.

<% column_definitions = [
    {
      accessor: "year",
      label: "Year",
      cellAccessors: ["quarter", "month", "day"],
    },
    {
      accessor: "newEnrollments",
      label: "New Enrollments",
    },
    {
      accessor: "scheduledMeetings",
      label: "Scheduled Meetings",
    },
    {
      accessor: "attendanceRate",
      label: "Attendance Rate",
    },
    {
      accessor: "completedClasses",
      label: "Completed Classes",
    },
    {
      accessor: "classCompletionRate",
      label: "Class Completion Rate",
    },
    {
      accessor: "graduatedStudents",
      label: "Graduated Students",
    }
] %>

<%= pb_rails("advanced_table", props: { id: "beta_table", table_data: @table_data, column_definitions: column_definitions }) %>

Table Props

Year	New Enrollments	Scheduled Meetings	Attendance Rate	Completed Classes	Class Completion Rate	Graduated Students
2021	20	10	51%	3	33%	19
Q1	2	35	32%	15	52%	36
January	16	20	11%	13	47%	28
10	34	28	97%	20	15%	17
20	43	23	66%	26	47%	9
February	20	41	95%	26	83%	43
15	19	35	69%	8	75%	23
2022	25	17	75%	5	45%	32
Q1	2	35	32%	15	52%	36
January	16	20	11%	13	47%	28
15	34	28	97%	20	15%	17
25	43	23	66%	26	47%	9
May	20	41	95%	26	83%	43
2	19	35	69%	8	75%	23
2023	10	15	65%	4	49%	29
Q1	2	35	32%	15	52%	36
March	16	20	11%	13	47%	28
10	34	28	97%	20	15%	17
11	43	23	66%	26	47%	9
April	20	41	95%	26	83%	43
15	19	35	69%	8	75%	23

This kit uses the Table kit under the hood which comes with its own set of props. If you want to apply certain Table props to that underlying kit, you can do so by using the optional table_props prop. This prop must be an object that contains valid Table props. For a full list of Table props, see here.

This doc example showcases the use of two table props, including how to render the vertical borders between columns.

<% column_definitions = [
    {
      accessor: "year",
      label: "Year",
      cellAccessors: ["quarter", "month", "day"],
    },
    {
      accessor: "newEnrollments",
      label: "New Enrollments",
    },
    {
      accessor: "scheduledMeetings",
      label: "Scheduled Meetings",
    },
    {
      accessor: "attendanceRate",
      label: "Attendance Rate",
    },
    {
      accessor: "completedClasses",
      label: "Completed Classes",
    },
    {
      accessor: "classCompletionRate",
      label: "Class Completion Rate",
    },
    {
      accessor: "graduatedStudents",
      label: "Graduated Students",
    }
] %>

<%= pb_rails("advanced_table", props: { id: "table_props_table", table_data: @table_data, column_definitions: column_definitions, table_props: { vertical_border: true, container: false }}) %>

Table with No Subrows or Expansion

Year	New Enrollments	Scheduled Meetings	Attendance Rate	Completed Classes	Class Completion Rate	Graduated Students
2021	20	10	51%	3	33%	19
2022	25	17	75%	5	45%	32
2023	10	15	65%	4	49%	29
2024	15	34	32%	6	67%	65

<% column_definitions = [
    {
      accessor: "year",
      label: "Year",
      cellAccessors: ["quarter", "month", "day"],
    },
    {
      accessor: "newEnrollments",
      label: "New Enrollments",
    },
    {
      accessor: "scheduledMeetings",
      label: "Scheduled Meetings",
    },
    {
      accessor: "attendanceRate",
      label: "Attendance Rate",
    },
    {
      accessor: "completedClasses",
      label: "Completed Classes",
    },
    {
      accessor: "classCompletionRate",
      label: "Class Completion Rate",
    },
    {
      accessor: "graduatedStudents",
      label: "Graduated Students",
    }
] %>

<%= pb_rails("advanced_table", props: { id: "table-no-children", enable_toggle_expansion: "none", table_data: @table_data_no_subrows, column_definitions: column_definitions }) %>

Available Props

Props	Type	Values
align_content	enum \| responsive	start end center spaceBetween spaceAround spaceEvenly
align_items	enum \| responsive	start end center
border_radius	enum	none xs sm md lg xl rounded
cursor	enum	auto default none contextMenu help pointer progress wait cell
dark	boolean	true false
flex	enum \| responsive	auto initial 0 1 2 3 4 5 6 7 8 9 10 11 12 none
flex_direction	enum \| responsive	row column rowReverse columnReverse
flex_wrap	enum \| responsive	wrap nowrap wrapReverse
justify_content	enum \| responsive	start end center spaceBetween spaceAround spaceEvenly
line_height	enum	loosest looser loose normal tight tighter tightest
margin_right	array	none xxs xs sm md lg xl
margin_left	array	none xxs xs sm md lg xl
margin_top	array	none xxs xs sm md lg xl
margin_bottom	array	none xxs xs sm md lg xl
margin_x	array	none xxs xs sm md lg xl
margin_y	array	none xxs xs sm md lg xl
margin	array	none xxs xs sm md lg xl
width	string
min_width	string
max_width	string
gap	string \| responsive
column_gap	string \| responsive
row_gap	string \| responsive
number_spacing	enum	tabular
order	enum \| responsive	none first 1 2 3 4 5 6 7 8 9 10 11 12
overflow_x	enum	scroll visible hidden auto
overflow_y	enum	scroll visible hidden auto
overflow	enum	scroll visible hidden auto
padding_right	array	none xxs xs sm md lg xl
padding_left	array	none xxs xs sm md lg xl
padding_top	array	none xxs xs sm md lg xl
padding_bottom	array	none xxs xs sm md lg xl
padding_x	array	none xxs xs sm md lg xl
padding_y	array	none xxs xs sm md lg xl
padding	array	none xxs xs sm md lg xl
position	enum	relative absolute fixed sticky static
shadow	enum	none deep deeper deepest
text_align	enum \| responsive	start end left right center justify justifyAll matchParent
truncate	enum	none 1 2 3 4 5
vertical_align	enum \| responsive	baseline super top middle bottom sub text-top text-bottom
z_index	enum \| responsive	1 2 3 4 5 6 7 8 9 10 max
top	enum \| object	xxs xs sm md lg xl xxl
inset	boolean	true false
right	enum \| object	xxs xs sm md lg xl xxl
bottom	enum \| object	xxs xs sm md lg xl xxl
left	enum \| object	xxs xs sm md lg xl xxl
height	string
max_height	string
min_height	string
hover	object
group_hover	boolean	true false

Props	Type	Values	Default
actions	react.reactnode[] \| react.reactnode
cascade_collapse	boolean	true false
column_definitions	array
column_group_border_color	enum	text_lt_default text_lt_light text_lt_lighter text_dk_default text_dk_light text_dk_lighter	none
column_visibility_control	genericobject
custom_sort	boolean	true false
enable_toggle_expansion	enum	all header none	header
enable_sorting_removal	boolean	true false
expanded_control	genericobject
expand_by_depth	array
on_expand_by_depth_click	function
initial_loading_rows_count	number
inline_row_loading	boolean	true false	false
loading	boolean \| string		false
on_row_toggle_click	function
on_toggle_expansion_click	function
pagination	boolean	true false
pagination_props	genericobject
pinned_rows	genericobject
responsive	enum	scroll none	scroll
row_styling	array
scroll_bar_none	boolean	true false	false
selectable_rows	boolean	true false	false
show_actions_bar	boolean	true false	true
persist_toggle_expansion_button	boolean	true false	false
sort_control	genericobject
sort_parent_only	boolean	true false
sticky_left_column	array
table_data	array
table_options	genericobject
table_props	genericobject
toggle_expansion_icon	string \| string[]
on_row_selection_change	function
on_custom_sort_click	function
virtualized_rows	boolean	true false
allow_full_screen	boolean	true false
full_screen_control	function
enable_sorting	boolean	true false
sort_icon	string \| string[]
collapsible_trail	boolean	true false
sub_row_headers	array

Contribute to Playbook

When you start designing a new feature, you may come across a Design Token or Component that isn’t defined in Playbook. If so, you should open an issue or reach out to the team to make a contribution.

Contribute on GitHub

As the highest-rated residential remodeler in the nation, our international technology team builds a custom suite of products that continuously transform our business.

Power

Tech @ Power

Open Positions

About Power

Connect

Github

Connect Chat

Advanced Table

Default

id

table_data

column_definitions

Available Props

align_content

align_items

border_radius

cursor

dark

flex

flex_direction

flex_wrap

justify_content

line_height

margin_right

margin_left

margin_top

margin_bottom

margin_x

margin_y

margin

width

min_width

max_width

gap

column_gap

row_gap

number_spacing

order

overflow_x

overflow_y

overflow

padding_right

padding_left

padding_top

padding_bottom

padding_x

padding_y

padding

position

shadow

text_align

truncate

vertical_align

z_index

top

inset

right

bottom

left

height

max_height

min_height

hover

group_hover

actions

cascade_collapse

column_definitions

column_group_border_color

column_visibility_control

custom_sort

enable_toggle_expansion

enable_sorting_removal

expanded_control

expand_by_depth

on_expand_by_depth_click

initial_loading_rows_count

inline_row_loading

loading

on_row_toggle_click

on_toggle_expansion_click

pagination

pagination_props

pinned_rows

responsive

row_styling

scroll_bar_none

selectable_rows