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 will not be able to properly reference the correct table.

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
gap	array	none xxs xs sm md lg xl
max_width	array	0% xs sm md lg xl xxl 0 none 100%
min_width	array	0% xs sm md lg xl xxl 0 none 100%
width	array	0% xs sm md lg xl xxl 0 none 100%
z_index	array	1 2 3 4 5 6 7 8 9 10
number_spacing	array	tabular
shadow	array	none deep deeper deepest
line_height	array	tightest tighter tight normal loose looser loosest
display	array	block inline_block inline flex inline_flex none grid
cursor	array	auto default none contextMenu help pointer progress wait cell crosshair text verticalText alias copy move noDrop notAllowed grab grabbing eResize nResize neResize nwResize sResize seResize swResize wResize ewResize nsResize neswResize nwseResize colResize rowResize allScroll zoomIn zoomOut
flex_direction	array	row column rowReverse columnReverse
flex_wrap	array	wrap nowrap wrapReverse
justify_content	array	start end center spaceBetween spaceAround spaceEvenly
justify_self	array	auto start end center stretch
align_items	array	flexStart flexEnd start end center baseline stretch
align_content	array	start end center spaceBetween spaceAround spaceEvenly
align_self	array	auto start end center stretch baseline
flex	array	auto initial 0 1 2 3 4 5 6 7 8 9 10 11 12 none
flex_grow	array	1 0
flex_shrink	array	1 0
order	array	1 2 3 4 5 6 7 8 9 10 11 12
position	array	relative absolute fixed sticky
hover	array
border_radius	array	none xs sm md lg xl rounded
text_align	array	start end left right center justify justify-all match-parent
overflow	array	visible hidden scroll auto
truncate	array	1 2 3 4 5
left	array	0 xxs xs sm md lg xl auto initial inherit
top	array	0 xxs xs sm md lg xl auto initial inherit
right	array	0 xxs xs sm md lg xl auto initial inherit
bottom	array	0 xxs xs sm md lg xl auto initial inherit
vertical_align	array	baseline super top middle bottom sub text-top text-bottom
height	array	auto xs sm md lg xl xxl xxxl
min_height	array	auto xs sm md lg xl xxl xxxl
overflow_x	array	visible hidden scroll auto
overflow_y	array	visible hidden scroll auto
margin	array	none xxs xs sm md lg xl
margin_bottom	array	none xxs xs sm md lg xl
margin_left	array	none xxs xs sm md lg xl
margin_right	array	none xxs xs sm md lg xl
margin_top	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
padding	array	none xxs xs sm md lg xl
padding_bottom	array	none xxs xs sm md lg xl
padding_left	array	none xxs xs sm md lg xl
padding_right	array	none xxs xs sm md lg xl
padding_top	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
classname	string
dark	boolean
group_hover	boolean
id	string
data	hashprop
aria	hashprop
html_options	hashprop
children	proc
style	hashprop

Props	Type	Values	Default
max_height	enum	auto xs sm md lg xl xxl xxxl	auto
table_data	array
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	none
enable_toggle_expansion	enum	all header none	header
loading	boolean		false
responsive	enum	none scroll	scroll
table_props	hashprop
selectable_rows	boolean		false
show_actions_bar	boolean		true
actions	array
scroll_bar_none	boolean		false
row_styling	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

gap

max_width

min_width

width

z_index

number_spacing

shadow

line_height

display

cursor

flex_direction

flex_wrap

justify_content

justify_self

align_items

align_content

align_self

flex

flex_grow

flex_shrink

order

position

hover

border_radius

text_align

overflow

truncate

left

top

right

bottom

vertical_align

height

min_height

overflow_x

overflow_y

margin

margin_bottom

margin_left

margin_right

margin_top

margin_x

margin_y

padding

padding_bottom

padding_left

padding_right

padding_top

padding_x

padding_y

classname

dark

group_hover

id

data

aria

html_options

children

style

max_height

table_data

column_definitions

column_group_border_color

enable_toggle_expansion

loading

responsive

table_props

selectable_rows

show_actions_bar

actions

scroll_bar_none

row_styling

Contribute to Playbook

Power