playbook_ui_docs 14.22.0.pre.alpha.PLAY22958843 → 14.22.0.pre.alpha.customheaderat8564

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.
Files changed (61) hide show
  1. checksums.yaml +4 -4
  2. data/app/pb_kits/playbook/pb_advanced_table/docs/example.yml +8 -10
  3. data/app/pb_kits/playbook/pb_advanced_table/docs/index.js +1 -2
  4. data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_colors.jsx +15 -33
  5. data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_custom.jsx +72 -0
  6. data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_custom.md +6 -0
  7. data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_default.jsx +15 -33
  8. data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_height.jsx +22 -52
  9. data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_horizontal.jsx +16 -12
  10. data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_legend.jsx +15 -31
  11. data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_legend_non_clickable.jsx +16 -39
  12. data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_legend_position.jsx +38 -86
  13. data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_negative_numbers.jsx +15 -32
  14. data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_pb_styles.jsx +64 -0
  15. data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_pb_styles.md +1 -0
  16. data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_secondary_y_axis.jsx +22 -72
  17. data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_secondary_y_axis.md +1 -1
  18. data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_spline.jsx +15 -31
  19. data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_stacked.jsx +16 -37
  20. data/app/pb_kits/playbook/pb_bar_graph/docs/_description.md +3 -1
  21. data/app/pb_kits/playbook/pb_bar_graph/docs/example.yml +3 -1
  22. data/app/pb_kits/playbook/pb_bar_graph/docs/index.js +2 -0
  23. data/app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_block.jsx +26 -71
  24. data/app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_colors.jsx +16 -29
  25. data/app/pb_kits/playbook/pb_circle_chart/docs/{_circle_chart_colors_rails.md → _circle_chart_colors.md} +1 -1
  26. data/app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_custom_tooltip.jsx +16 -28
  27. data/app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_custom_tooltip.md +2 -4
  28. data/app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_default.jsx +15 -23
  29. data/app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_inner_sizes.jsx +51 -81
  30. data/app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_legend_position.jsx +75 -103
  31. data/app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_legend_position.md +6 -3
  32. data/app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_live_data.jsx +13 -19
  33. data/app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_pb_styles.jsx +38 -0
  34. data/app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_pb_styles.md +1 -0
  35. data/app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_rounded.jsx +17 -30
  36. data/app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_with_labels.jsx +20 -34
  37. data/app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_with_legend_kit.jsx +20 -29
  38. data/app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_with_title.jsx +20 -28
  39. data/app/pb_kits/playbook/pb_circle_chart/docs/example.yml +1 -0
  40. data/app/pb_kits/playbook/pb_circle_chart/docs/index.js +1 -0
  41. data/app/pb_kits/playbook/pb_table/docs/_table_sticky_columns.jsx +8 -8
  42. data/app/pb_kits/playbook/pb_table/docs/_table_sticky_columns_react.md +1 -1
  43. data/app/pb_kits/playbook/pb_table/docs/_table_sticky_left_columns.jsx +12 -12
  44. data/app/pb_kits/playbook/pb_table/docs/_table_sticky_left_columns_react.md +3 -3
  45. data/app/pb_kits/playbook/pb_table/docs/_table_sticky_right_columns.jsx +12 -12
  46. data/app/pb_kits/playbook/pb_table/docs/_table_sticky_right_columns_react.md +3 -3
  47. data/app/pb_kits/playbook/pb_tooltip/docs/example.yml +0 -1
  48. data/app/pb_kits/playbook/pb_typeahead/docs/example.yml +0 -1
  49. data/dist/playbook-doc.js +2 -2
  50. metadata +11 -14
  51. data/app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_custom_sort.jsx +0 -65
  52. data/app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_custom_sort.md +0 -5
  53. data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_height.md +0 -3
  54. data/app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_colors_react.md +0 -2
  55. data/app/pb_kits/playbook/pb_circle_chart/docs/_description.md +0 -1
  56. data/app/pb_kits/playbook/pb_tooltip/docs/_tooltip_click_open.html.erb +0 -14
  57. data/app/pb_kits/playbook/pb_tooltip/docs/_tooltip_click_open_rails.md +0 -1
  58. data/app/pb_kits/playbook/pb_typeahead/docs/_typeahead_preserve_input.html.erb +0 -18
  59. data/app/pb_kits/playbook/pb_typeahead/docs/_typeahead_preserve_input_rails.md +0 -1
  60. /data/app/pb_kits/playbook/pb_tooltip/docs/{_tooltip_click_open_react.md → _tooltip_click_open.md} +0 -0
  61. /data/app/pb_kits/playbook/pb_typeahead/docs/{_typeahead_preserve_input_react.md → _typeahead_preserve_input.md} +0 -0
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: 14.22.0.pre.alpha.PLAY22958843
4
+ version: 14.22.0.pre.alpha.customheaderat8564
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-07-07 00:00:00.000000000 Z
12
+ date: 2025-06-23 00:00:00.000000000 Z
13
13
  dependencies:
14
14
  - !ruby/object:Gem::Dependency
15
15
  name: playbook_ui
@@ -74,8 +74,6 @@ files:
74
74
  - app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_custom_cell.md
75
75
  - app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_custom_cell_rails.html.erb
76
76
  - app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_custom_cell_rails.md
77
- - app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_custom_sort.jsx
78
- - app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_custom_sort.md
79
77
  - app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_default.jsx
80
78
  - app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_default.md
81
79
  - app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_expand_by_depth.jsx
@@ -230,13 +228,14 @@ files:
230
228
  - app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_colors.html.erb
231
229
  - app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_colors.jsx
232
230
  - app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_colors.md
231
+ - app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_custom.jsx
232
+ - app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_custom.md
233
233
  - app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_custom_rails.html.erb
234
234
  - app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_custom_rails.md
235
235
  - app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_default.html.erb
236
236
  - app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_default.jsx
237
237
  - app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_height.html.erb
238
238
  - app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_height.jsx
239
- - app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_height.md
240
239
  - app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_horizontal.html.erb
241
240
  - app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_horizontal.jsx
242
241
  - app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_legend.html.erb
@@ -248,6 +247,8 @@ files:
248
247
  - app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_legend_position.md
249
248
  - app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_negative_numbers.html.erb
250
249
  - app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_negative_numbers.jsx
250
+ - app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_pb_styles.jsx
251
+ - app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_pb_styles.md
251
252
  - app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_secondary_y_axis.html.erb
252
253
  - app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_secondary_y_axis.jsx
253
254
  - app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_secondary_y_axis.md
@@ -418,8 +419,7 @@ files:
418
419
  - app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_block.jsx
419
420
  - app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_colors.html.erb
420
421
  - app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_colors.jsx
421
- - app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_colors_rails.md
422
- - app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_colors_react.md
422
+ - app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_colors.md
423
423
  - app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_custom_tooltip.html.erb
424
424
  - app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_custom_tooltip.jsx
425
425
  - app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_custom_tooltip.md
@@ -431,6 +431,8 @@ files:
431
431
  - app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_legend_position.jsx
432
432
  - app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_legend_position.md
433
433
  - app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_live_data.jsx
434
+ - app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_pb_styles.jsx
435
+ - app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_pb_styles.md
434
436
  - app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_rounded.html.erb
435
437
  - app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_rounded.jsx
436
438
  - app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_with_labels.html.erb
@@ -439,7 +441,6 @@ files:
439
441
  - app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_with_legend_kit.jsx
440
442
  - app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_with_title.html.erb
441
443
  - app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_with_title.jsx
442
- - app/pb_kits/playbook/pb_circle_chart/docs/_description.md
443
444
  - app/pb_kits/playbook/pb_circle_chart/docs/example.yml
444
445
  - app/pb_kits/playbook/pb_circle_chart/docs/index.js
445
446
  - app/pb_kits/playbook/pb_circle_icon_button/docs/_circle_icon_button_click.jsx
@@ -2282,10 +2283,8 @@ files:
2282
2283
  - app/pb_kits/playbook/pb_toggle/docs/_toggle_props_swift.md
2283
2284
  - app/pb_kits/playbook/pb_toggle/docs/example.yml
2284
2285
  - app/pb_kits/playbook/pb_toggle/docs/index.js
2285
- - app/pb_kits/playbook/pb_tooltip/docs/_tooltip_click_open.html.erb
2286
2286
  - app/pb_kits/playbook/pb_tooltip/docs/_tooltip_click_open.jsx
2287
- - app/pb_kits/playbook/pb_tooltip/docs/_tooltip_click_open_rails.md
2288
- - app/pb_kits/playbook/pb_tooltip/docs/_tooltip_click_open_react.md
2287
+ - app/pb_kits/playbook/pb_tooltip/docs/_tooltip_click_open.md
2289
2288
  - app/pb_kits/playbook/pb_tooltip/docs/_tooltip_default.html.erb
2290
2289
  - app/pb_kits/playbook/pb_tooltip/docs/_tooltip_default_react.jsx
2291
2290
  - app/pb_kits/playbook/pb_tooltip/docs/_tooltip_default_react.md
@@ -2335,10 +2334,8 @@ files:
2335
2334
  - app/pb_kits/playbook/pb_typeahead/docs/_typeahead_margin_bottom.jsx
2336
2335
  - app/pb_kits/playbook/pb_typeahead/docs/_typeahead_multi_kit.html.erb
2337
2336
  - app/pb_kits/playbook/pb_typeahead/docs/_typeahead_multi_kit.jsx
2338
- - app/pb_kits/playbook/pb_typeahead/docs/_typeahead_preserve_input.html.erb
2339
2337
  - app/pb_kits/playbook/pb_typeahead/docs/_typeahead_preserve_input.jsx
2340
- - app/pb_kits/playbook/pb_typeahead/docs/_typeahead_preserve_input_rails.md
2341
- - app/pb_kits/playbook/pb_typeahead/docs/_typeahead_preserve_input_react.md
2338
+ - app/pb_kits/playbook/pb_typeahead/docs/_typeahead_preserve_input.md
2342
2339
  - app/pb_kits/playbook/pb_typeahead/docs/_typeahead_react_hook.jsx
2343
2340
  - app/pb_kits/playbook/pb_typeahead/docs/_typeahead_react_hook.md
2344
2341
  - app/pb_kits/playbook/pb_typeahead/docs/_typeahead_truncated_text.html.erb
@@ -1,65 +0,0 @@
1
- import React from "react"
2
- import AdvancedTable from '../../pb_advanced_table/_advanced_table'
3
- import MOCK_DATA from "./advanced_table_mock_data.json"
4
-
5
- const AdvancedTableCustomSort = (props) => {
6
- const columnDefinitions = [
7
- {
8
- accessor: "year",
9
- label: "Year",
10
- id: "year",
11
- cellAccessors: ["quarter", "month", "day"],
12
- },
13
- {
14
- accessor: "newEnrollments",
15
- id: "newEnrollments",
16
- label: "New Enrollments",
17
- },
18
- {
19
- accessor: "scheduledMeetings",
20
- id: "scheduledMeetings",
21
- label: "Scheduled Meetings",
22
- },
23
- {
24
- accessor: "attendanceRate",
25
- id: "attendanceRate",
26
- label: "Attendance Rate",
27
- },
28
- {
29
- accessor: "completedClasses",
30
- id: "completedClasses",
31
- label: "Completed Classes",
32
- },
33
- {
34
- accessor: "classCompletionRate",
35
- id: "classCompletionRate",
36
- label: "Class Completion Rate",
37
- },
38
- {
39
- accessor: "graduatedStudents",
40
- id: "graduatedStudents",
41
- label: "Graduated Students",
42
- },
43
- ]
44
-
45
- //Render the subRow header rows
46
- const subRowHeaders = ["Quarter", "Month", "Day"]
47
-
48
- return (
49
- <div>
50
- <AdvancedTable
51
- columnDefinitions={columnDefinitions}
52
- customSort
53
- enableToggleExpansion="all"
54
- onCustomSortClick={(subrows)=>{console.log("Custom sort clicked", subrows)}}
55
- tableData={MOCK_DATA}
56
- {...props}
57
- >
58
- <AdvancedTable.Header enableSorting />
59
- <AdvancedTable.Body subRowHeaders={subRowHeaders} />
60
- </AdvancedTable>
61
- </div>
62
- )
63
- }
64
-
65
- export default AdvancedTableCustomSort
@@ -1,5 +0,0 @@
1
- The optional `customSort` prop can be used to add a sort button within a subrow header. The button will only appear if that subrowheader has more than one subrow nested within it. This button comes with a callback function called `onCustomSortClick`.
2
-
3
- The `onCustomSortClick` provides as an argument an array of all the subrows nested within that level of the table.
4
-
5
- __NOTE__: `customSort` must be used in conjunction with the `subRowHeaders` prop. The `customSort` DOES NOT handle the sort logic, this must be handled on the frontend using the callback provided.
@@ -1,3 +0,0 @@
1
- By default, Highcharts have a height of 400px, but this can be customized. You can override the default by specifying either a percentage or a fixed pixel value.
2
-
3
- Using a percentage maintains a consistent aspect ratio across different responsive sizes. For example, setting the height to 50% makes the chart’s height half of its width.
@@ -1,2 +0,0 @@
1
- Custom data colors allow for color customization to match the needs of business requirements.
2
- Import the colors from Playbook's tokens, then set custom colors in the plotOptions.pie.colors array using the desired color variables. Hex colors are also available `eg: #CA0095`.
@@ -1 +0,0 @@
1
- **Important Note for the React Kit**: In order to leverage this kit, you must install `highcharts` and `highcharts-react-official` into your project as shown below. To then apply Playbook styles to your Highchart, import circleChartTheme.ts from playbook-ui and merge it with your Highchart options. Then, pass the merged value to the options prop. Playbook’s styling will be applied automatically. See the examples in the documentation below.
@@ -1,14 +0,0 @@
1
- <%= pb_rails("button", props: {
2
- text: "Click to Open",
3
- id: "click-tooltip-trigger-1",
4
- variant: "primary"
5
- }) %>
6
-
7
- <%= pb_rails("tooltip", props: {
8
- trigger_element_selector: "#click-tooltip-trigger-1",
9
- tooltip_id: "click-tooltip-1",
10
- position: "top",
11
- use_click_to_open: true
12
- }) do %>
13
- Tooltip opened by click! Click trigger again to close.
14
- <% end %>
@@ -1 +0,0 @@
1
- Set the prop `use_click_to_open` as `true` so that the tooltip will only appear when an item is clicked rather than hovered over.
@@ -1,18 +0,0 @@
1
- <%
2
- options = [
3
- { label: 'Orange', value: '#FFA500' },
4
- { label: 'Red', value: '#FF0000' },
5
- { label: 'Green', value: '#00FF00' },
6
- { label: 'Blue', value: '#0000FF' },
7
- ]
8
- %>
9
-
10
- <%= pb_rails("typeahead", props: {
11
- id: "typeahead-preserve-search-input",
12
- is_multi: false,
13
- label: "Colors",
14
- options: options,
15
- placeholder: "Select...",
16
- preserve_search_input: true,
17
- })
18
- %>
@@ -1 +0,0 @@
1
- By default, text is not preserved in the typeahead kit when you click off of the input field. You can utilize the `preserve_search_input` prop in order to prevent text from being cleared when the field loses focus