playbook_ui_docs 15.6.0.pre.alpha.play261013050 → 15.6.0.pre.alpha.play263913015

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 1429a20e3269b6dfc72f937549b5dd567146dfa0ea624369ad1b06c87e761dc9
4
- data.tar.gz: 78fd1522fb2d408c992a5d9bca3213379302059fc91a8adefa69b8dac62fd26e
3
+ metadata.gz: 7ebde2741678c3de10cd2c9984d863a18489881ed4fca072af9c3efa175433eb
4
+ data.tar.gz: d89a64e2ba3c58fd88367f67619a0de0e1fd45ae80ceb03b8fc47e1ccd0e093d
5
5
  SHA512:
6
- metadata.gz: 846a6d3bf6536e911cd4b0d1f6b619b9e331396d333af15a9e2c9b987e9c5c526fbc8a976e46c8f2786bc92d606135655e171999774bcac6bd4c77985bf9dcd3
7
- data.tar.gz: 44be50ab6f4c563eebba01fedb8f1d3fe4034d907d0981f6bcb90d975bed8750ba6a40834651cf947ccb39b5fe4c9f6ae31108fd054fe0c25023c49f633a258f
6
+ metadata.gz: 51fbb94c8014a7e4c0f740b5d6b81b77a8105a56248e026e94d9cd1d769c617f5b17cc35a36e552dc3f9b116073b0114073655c19f068c512c5c31f2a7a3462b
7
+ data.tar.gz: 5ecbfbe339c2393d2bd40834adb757cc2c7c0483f99695b37b086f90044235dc85aca24e64e0bf924c5375a27d46d3cd57866616915ffaed7f2f0d1b4b53461d
@@ -8,26 +8,16 @@
8
8
  accessor: "newEnrollments",
9
9
  label: "New Enrollments",
10
10
  column_styling: {
11
- cell_background_color: "error_subtle",
12
- header_background_color: "error_subtle"
11
+ cell_background_color: ->(row) { row[:newEnrollments].to_i > 20 ? "success_secondary" : "warning_secondary" }
13
12
  }
14
13
  },
15
14
  {
16
15
  accessor: "scheduledMeetings",
17
16
  label: "Scheduled Meetings",
18
- column_styling: {
19
- cell_background_color: "info_subtle",
20
- }
21
17
  },
22
18
  {
23
19
  accessor: "attendanceRate",
24
20
  label: "Attendance Rate",
25
- column_styling: {
26
- cell_background_color: "info",
27
- header_background_color: "info",
28
- header_font_color: "white",
29
- font_color: "white"
30
- }
31
21
  },
32
22
  {
33
23
  accessor: "completedClasses",
@@ -36,6 +26,10 @@
36
26
  {
37
27
  accessor: "classCompletionRate",
38
28
  label: "Class Completion Rate",
29
+ column_styling: {
30
+ cell_background_color: "category_1",
31
+ font_color: "white"
32
+ }
39
33
  },
40
34
  {
41
35
  accessor: "graduatedStudents",
@@ -1,7 +1 @@
1
- `column_styling` can also be used to control the background color on all cells in a given column. Use the following key/values pairs to achieve this:
2
-
3
- 1) `cell_background_color`: use this to control the background color of all cells in the given column
4
- 2) `font_color`: use this to control font color for all cells in the given column if needed, for example if using a darker background color
5
- 3) `header_background_color`: use this to control the background color of the column header
6
- 4) `header_font_color`: use this to control font color for the header in the given column if needed, for example if using a darker background color.
7
-
1
+ `column_styling` can also be used to control the background color on all cells in a given column via the use of the `cell_background_color` key/value pair. Use `cell_background_color` to achieve custom background colors for individual cells as seen here. Use `font_color` to achieve better contrast between cell content and background for darker backgrounds.
@@ -26,8 +26,7 @@ examples:
26
26
  - advanced_table_column_styling_rails: Column Styling
27
27
  - advanced_table_column_styling_column_headers_rails: Column Styling with Multiple Headers
28
28
  - advanced_table_padding_control_rails: Padding Control using Column Styling
29
- - advanced_table_background_control_rails: Column Styling Background Color
30
- - advanced_table_background_colors_rails: Column Styling Individual Cell Background Color
29
+ - advanced_table_background_control_rails: Background Control using Column Styling
31
30
  - advanced_table_column_border_color_rails: Column Group Border Color
32
31
 
33
32
 
@@ -76,8 +75,6 @@ examples:
76
75
  - advanced_table_padding_control_per_row: Padding Control using Row Styling
77
76
  - advanced_table_column_styling: Column Styling
78
77
  - advanced_table_column_styling_column_headers: Column Styling with Multiple Headers
79
- - advanced_table_column_styling_background: Column Styling Background Color
80
- - advanced_table_column_styling_background_multi: Column Styling Background Color with Multiple Headers
81
78
  - advanced_table_padding_control: Padding Control using Column Styling
82
79
  - advanced_table_column_border_color: Column Group Border Color
83
80
  - advanced_table_fullscreen: Fullscreen
@@ -45,6 +45,4 @@ export { default as AdvancedTableWithCustomHeaderMultiHeader } from './_advanced
45
45
  export { default as AdvancedTableSortPerColumn } from './_advanced_table_sort_per_column.jsx'
46
46
  export { default as AdvancedTableSortPerColumnForMultiColumn } from './_advanced_table_sort_per_column_for_multi_column.jsx'
47
47
  export { default as AdvancedTablePaddingControl } from './_advanced_table_padding_control.jsx'
48
- export { default as AdvancedTablePaddingControlPerRow } from './_advanced_table_padding_control_per_row.jsx'
49
- export { default as AdvancedTableColumnStylingBackground } from './_advanced_table_column_styling_background.jsx'
50
- export { default as AdvancedTableColumnStylingBackgroundMulti } from './_advanced_table_column_styling_background_multi.jsx'
48
+ export { default as AdvancedTablePaddingControlPerRow } from './_advanced_table_padding_control_per_row.jsx'
@@ -1 +1 @@
1
- Use the optional `showDate` prop to render the timeline kit with a visible date. By default, if the date is from the current year, the year will not be displayed; however, if the date is NOT from the current year, the kit will display the year as well.
1
+ Use the optional `showDate` prop to render the timeline kit with a visible date. If the date is from the current year, the year will not be displayed, however if date is NOT from the current year, the kit will display the year as well.
@@ -5,7 +5,6 @@ examples:
5
5
  - timeline_vertical: Vertical
6
6
  - timeline_with_date: With Date
7
7
  - timeline_with_children: With Children
8
- - timeline_show_current_year: Show Current Year
9
8
  - timeline_with_gap: With Gap
10
9
 
11
10
 
@@ -14,5 +13,4 @@ examples:
14
13
  - timeline_vertical: Vertical
15
14
  - timeline_with_date: With Date
16
15
  - timeline_with_children: With Children
17
- - timeline_show_current_year: Show Current Year
18
16
  - timeline_with_gap: With Gap
@@ -3,5 +3,4 @@ export { default as TimelineVertical } from './_timeline_vertical.jsx'
3
3
  export { default as TimelineWithDate } from './_timeline_with_date.jsx'
4
4
  export { default as TimelineWithChildren } from './_timeline_with_children.jsx'
5
5
  export { default as TimelineWithGap } from './_timeline_with_gap.jsx'
6
- export { default as TimelineShowCurrentYear } from './_timeline_show_current_year.jsx'
7
6
 
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: playbook_ui_docs
3
3
  version: !ruby/object:Gem::Version
4
- version: 15.6.0.pre.alpha.play261013050
4
+ version: 15.6.0.pre.alpha.play263913015
5
5
  platform: ruby
6
6
  authors:
7
7
  - Power UX
@@ -9,7 +9,7 @@ authors:
9
9
  autorequire:
10
10
  bindir: bin
11
11
  cert_chain: []
12
- date: 2025-12-12 00:00:00.000000000 Z
12
+ date: 2025-12-11 00:00:00.000000000 Z
13
13
  dependencies:
14
14
  - !ruby/object:Gem::Dependency
15
15
  name: playbook_ui
@@ -33,8 +33,6 @@ executables: []
33
33
  extensions: []
34
34
  extra_rdoc_files: []
35
35
  files:
36
- - app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_background_colors_rails.html.erb
37
- - app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_background_colors_rails.md
38
36
  - app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_background_control_rails.html.erb
39
37
  - app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_background_control_rails.md
40
38
  - app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_beta.html.erb
@@ -62,10 +60,6 @@ files:
62
60
  - app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_column_headers_vertical_border.jsx
63
61
  - app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_column_styling.jsx
64
62
  - app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_column_styling.md
65
- - app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_column_styling_background.jsx
66
- - app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_column_styling_background.md
67
- - app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_column_styling_background_multi.jsx
68
- - app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_column_styling_background_multi.md
69
63
  - app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_column_styling_column_headers.jsx
70
64
  - app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_column_styling_column_headers.md
71
65
  - app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_column_styling_column_headers_rails.html.erb
@@ -2425,9 +2419,6 @@ files:
2425
2419
  - app/pb_kits/playbook/pb_timeline/docs/_description.md
2426
2420
  - app/pb_kits/playbook/pb_timeline/docs/_timeline_default.html.erb
2427
2421
  - app/pb_kits/playbook/pb_timeline/docs/_timeline_default.jsx
2428
- - app/pb_kits/playbook/pb_timeline/docs/_timeline_show_current_year.html.erb
2429
- - app/pb_kits/playbook/pb_timeline/docs/_timeline_show_current_year.jsx
2430
- - app/pb_kits/playbook/pb_timeline/docs/_timeline_show_current_year.md
2431
2422
  - app/pb_kits/playbook/pb_timeline/docs/_timeline_vertical.html.erb
2432
2423
  - app/pb_kits/playbook/pb_timeline/docs/_timeline_vertical.jsx
2433
2424
  - app/pb_kits/playbook/pb_timeline/docs/_timeline_with_children.html.erb
@@ -1,43 +0,0 @@
1
- <% column_definitions = [
2
- {
3
- accessor: "year",
4
- label: "Year",
5
- cellAccessors: ["quarter", "month", "day"],
6
- },
7
- {
8
- accessor: "newEnrollments",
9
- label: "New Enrollments",
10
- column_styling: {
11
- cell_background_color: ->(row) { row[:newEnrollments].to_i > 20 ? "success_secondary" : "warning_secondary" }
12
- }
13
- },
14
- {
15
- accessor: "scheduledMeetings",
16
- label: "Scheduled Meetings",
17
- },
18
- {
19
- accessor: "attendanceRate",
20
- label: "Attendance Rate",
21
- },
22
- {
23
- accessor: "completedClasses",
24
- label: "Completed Classes",
25
- },
26
- {
27
- accessor: "classCompletionRate",
28
- label: "Class Completion Rate",
29
- column_styling: {
30
- cell_background_color: "category_1",
31
- font_color: "white"
32
- }
33
- },
34
- {
35
- accessor: "graduatedStudents",
36
- label: "Graduated Students",
37
- }
38
- ] %>
39
-
40
- <%= pb_rails("advanced_table", props: { id: "background-control", table_data: @table_data, column_definitions: column_definitions }) do %>
41
- <%= pb_rails("advanced_table/table_header", props: { table_id: "background-control", column_definitions: column_definitions }) %>
42
- <%= pb_rails("advanced_table/table_body", props: { table_id: "background-control", table_data: @table_data, column_definitions: column_definitions }) %>
43
- <% end %>
@@ -1 +0,0 @@
1
- `column_styling` can also be used to control the background color on individual cells in a given column as shown here.
@@ -1,54 +0,0 @@
1
- import React from "react"
2
- import AdvancedTable from '../_advanced_table'
3
- import colors from '../../tokens/exports/_colors.module.scss'
4
- import MOCK_DATA from "./advanced_table_mock_data.json"
5
-
6
-
7
- const AdvancedTableColumnStylingBackground = (props) => {
8
- const columnDefinitions = [
9
- {
10
- accessor: "year",
11
- label: "Year",
12
- cellAccessors: ["quarter", "month", "day"],
13
- },
14
- {
15
- accessor: "newEnrollments",
16
- label: "New Enrollments",
17
- columnStyling:{cellBackgroundColor: colors.error_subtle, headerBackgroundColor: colors.error_subtle},
18
- },
19
- {
20
- accessor: "scheduledMeetings",
21
- label: "Scheduled Meetings",
22
- columnStyling:{cellBackgroundColor: colors.info_subtle},
23
- },
24
- {
25
- accessor: "attendanceRate",
26
- label: "Attendance Rate",
27
- columnStyling:{cellBackgroundColor: colors.info, headerBackgroundColor: colors.info, fontColor: colors.white, headerFontColor: colors.white},
28
- },
29
- {
30
- accessor: "completedClasses",
31
- label: "Completed Classes",
32
- },
33
- {
34
- accessor: "classCompletionRate",
35
- label: "Class Completion Rate",
36
- },
37
- {
38
- accessor: "graduatedStudents",
39
- label: "Graduated Students",
40
- },
41
- ]
42
-
43
- return (
44
- <div>
45
- <AdvancedTable
46
- columnDefinitions={columnDefinitions}
47
- tableData={MOCK_DATA}
48
- {...props}
49
- />
50
- </div>
51
- )
52
- }
53
-
54
- export default AdvancedTableColumnStylingBackground
@@ -1,9 +0,0 @@
1
- The `columnStyling` prop can also be used to set background color for entire columns.As stated above, `columnStyling` is an object that has several optional key/value pairs, here are the options highlighted in this doc:
2
-
3
- 1) `cellBackgroundColor`: use this to control the background color of all cells in the given column
4
- 2) `headerBackgroundColor`: use this to control the background color of the column header
5
- 3) `fontColor`: use this to control font color for all cells in the given column if needed, for example if using a darker background color.
6
- 4) `headerFontColor`: use this to control font color for the header in the given column if needed, for example if using a darker background color.
7
-
8
-
9
-
@@ -1,80 +0,0 @@
1
- import React from "react"
2
- import AdvancedTable from '../_advanced_table'
3
- import colors from '../../tokens/exports/_colors.module.scss'
4
- import MOCK_DATA from "./advanced_table_mock_data.json"
5
-
6
-
7
- const AdvancedTableColumnStylingBackgroundMulti = (props) => {
8
- const columnDefinitions = [
9
- {
10
- accessor: "year",
11
- label: "Year",
12
- cellAccessors: ["quarter", "month", "day"],
13
- },
14
- {
15
- label: "Enrollment Data",
16
- columns: [
17
- {
18
- label: "Enrollment Stats",
19
- columns: [
20
- {
21
- accessor: "newEnrollments",
22
- label: "New Enrollments",
23
- columnStyling:{cellBackgroundColor: colors.error_subtle, headerBackgroundColor: colors.error_subtle},
24
- },
25
- {
26
- accessor: "scheduledMeetings",
27
- label: "Scheduled Meetings",
28
- },
29
- ],
30
- },
31
- ],
32
- },
33
- {
34
- label: "Performance Data",
35
- columns: [
36
- {
37
- label: "Completion Metrics",
38
- columns: [
39
- {
40
- accessor: "completedClasses",
41
- label: "Completed Classes",
42
- columnStyling:{cellBackgroundColor: colors.info, headerBackgroundColor: colors.info, fontColor: colors.white, headerFontColor: colors.white},
43
- },
44
- {
45
- accessor: "classCompletionRate",
46
- label: "Class Completion Rate",
47
- },
48
- ],
49
- },
50
- {
51
- label: "Attendance",
52
- columns: [
53
- {
54
- accessor: "attendanceRate",
55
- label: "Attendance Rate",
56
- columnStyling:{cellBackgroundColor: colors.info_subtle},
57
- },
58
- {
59
- accessor: "scheduledMeetings",
60
- label: "Scheduled Meetings",
61
- },
62
- ],
63
- },
64
- ],
65
- },
66
- ];
67
-
68
-
69
- return (
70
- <div>
71
- <AdvancedTable
72
- columnDefinitions={columnDefinitions}
73
- tableData={MOCK_DATA}
74
- {...props}
75
- />
76
- </div>
77
- )
78
- }
79
-
80
- export default AdvancedTableColumnStylingBackgroundMulti
@@ -1,3 +0,0 @@
1
- The `columnStyling` prop can also be used to set background color for entire columns for the multi header variant as well.
2
-
3
- It should be noted that `headerFontColor` and `headerBackgroundColor` in the multi header variant will only apply to the immediate header for the given column as shown here.
@@ -1,60 +0,0 @@
1
- <%= pb_rails("timeline", props: {orientation: "horizontal", show_date: true}) do %>
2
- <%= pb_rails("timeline/item", props: {icon: "user", icon_color: "royal", line_style: "solid", date: Date.today, show_current_year: true }) do %>
3
- <%= pb_rails("title_detail", props: {
4
- title: "Jackson Heights",
5
- detail: "37-27 74th Street"
6
- }) %>
7
- <% end %>
8
- <%= pb_rails("timeline/item", props: {icon: "check", icon_color: "teal", line_style: "dotted" }) do %>
9
- <%= pb_rails("title_detail", props: {
10
- title: "Greenpoint",
11
- detail: "81 Gate St Brooklyn"
12
- }) %>
13
- <% end %>
14
- <%= pb_rails("timeline/item", props: { line_style: "solid"}) do |item| %>
15
- <% item.label do %>
16
- <%= pb_rails("timeline/label", props: { date: Date.today, show_current_year: true }) %>
17
- <% end %>
18
- <% item.step do %>
19
- <%= pb_rails("timeline/step", props: { icon: 'map-marker-alt', icon_color: 'purple' }) %>
20
- <% end %>
21
- <% item.detail do %>
22
- <%= pb_rails("title_detail", props: {
23
- title: "Society Hill",
24
- detail: "72 E St Astoria"
25
- }) %>
26
- <% end %>
27
- <% end %>
28
- <% end %>
29
-
30
- <br /><br /><br />
31
-
32
- <%= pb_rails("timeline", props: {orientation: "vertical", show_date: true}) do %>
33
- <%= pb_rails("timeline/item", props: {icon: "user", icon_color: "royal", line_style: "solid", date: Date.today, show_current_year: true }) do %>
34
- <%= pb_rails("title_detail", props: {
35
- title: "Jackson Heights",
36
- detail: "37-27 74th Street"
37
- }) %>
38
- <% end %>
39
- <%= pb_rails("timeline/item", props: {icon: "check", icon_color: "teal", line_style: "dotted" }) do %>
40
- <%= pb_rails("title_detail", props: {
41
- title: "Greenpoint",
42
- detail: "81 Gate St Brooklyn"
43
- }) %>
44
- <% end %>
45
- <%= pb_rails("timeline/item", props: { line_style: "solid"}) do |item| %>
46
- <% item.label do %>
47
- <%= pb_rails("timeline/label", props: { date: Date.today, show_current_year: true }) %>
48
- <% end %>
49
- <% item.step do %>
50
- <%= pb_rails("timeline/step", props: { icon: 'map-marker-alt', icon_color: 'purple' }) %>
51
- <% end %>
52
- <% item.detail do %>
53
- <%= pb_rails("title_detail", props: {
54
- title: "Society Hill",
55
- detail: "72 E St Astoria"
56
- }) %>
57
- <% end %>
58
- <% end %>
59
- <% end %>
60
-
@@ -1,118 +0,0 @@
1
- import React from 'react'
2
-
3
- import Timeline from '../_timeline'
4
- import TitleDetail from '../../pb_title_detail/_title_detail'
5
-
6
- const TimelineShowCurrentYear = (props) => (
7
- <div>
8
- <Timeline
9
- orientation="horizontal"
10
- showDate
11
- {...props}
12
- >
13
- <Timeline.Item
14
- date={new Date()}
15
- icon="user"
16
- iconColor="royal"
17
- showCurrentYear
18
- {...props}
19
- >
20
- <TitleDetail
21
- detail="37-27 74th Street"
22
- title="Jackson Heights"
23
- {...props}
24
- />
25
- </Timeline.Item>
26
- <Timeline.Item
27
- icon="check"
28
- iconColor="teal"
29
- lineStyle="dotted"
30
- {...props}
31
- >
32
- <TitleDetail
33
- detail="81 Gate St Brooklyn"
34
- title="Greenpoint"
35
- {...props}
36
- />
37
- </Timeline.Item>
38
- <Timeline.Item
39
- lineStyle="solid"
40
- {...props}
41
- >
42
- <Timeline.Label
43
- date={new Date()}
44
- showCurrentYear
45
- />
46
- <Timeline.Step
47
- icon="map-marker-alt"
48
- iconColor="purple"
49
- />
50
- <Timeline.Detail>
51
- <TitleDetail
52
- detail="72 E St Astoria"
53
- title="Society Hill"
54
- {...props}
55
- />
56
- </Timeline.Detail>
57
- </Timeline.Item>
58
- </Timeline>
59
-
60
- <br />
61
- <br />
62
- <br />
63
-
64
- <Timeline
65
- orientation="vertical"
66
- showDate
67
- {...props}
68
- >
69
- <Timeline.Item
70
- date={new Date()}
71
- icon="user"
72
- iconColor="royal"
73
- showCurrentYear
74
- {...props}
75
- >
76
- <TitleDetail
77
- detail="37-27 74th Street"
78
- title="Jackson Heights"
79
- {...props}
80
- />
81
- </Timeline.Item>
82
- <Timeline.Item
83
- icon="check"
84
- iconColor="teal"
85
- lineStyle="dotted"
86
- {...props}
87
- >
88
- <TitleDetail
89
- detail="81 Gate St Brooklyn"
90
- title="Greenpoint"
91
- {...props}
92
- />
93
- </Timeline.Item>
94
- <Timeline.Item
95
- lineStyle="solid"
96
- {...props}
97
- >
98
- <Timeline.Label
99
- date={new Date()}
100
- showCurrentYear
101
- />
102
- <Timeline.Step
103
- icon="map-marker-alt"
104
- iconColor="purple"
105
- />
106
- <Timeline.Detail>
107
- <TitleDetail
108
- detail="72 E St Astoria"
109
- title="Society Hill"
110
- {...props}
111
- />
112
- </Timeline.Detail>
113
- </Timeline.Item>
114
- </Timeline>
115
- </div>
116
- )
117
-
118
- export default TimelineShowCurrentYear
@@ -1 +0,0 @@
1
- By default, the Timeline kit does NOT display the year if it is the current year. If you want to display the current year you can do so by setting `showCurrentYear`/`show_current_year` to true. Pass it to `Timeline.Item`/`timeline/item` when using its `date` prop, or to `Timeline.Label`/`timeline/label` if following the "With Children" pattern.