playbook_ui_docs 14.22.0.pre.alpha.PLAY22588587 → 14.22.0.pre.alpha.PLAY22958843

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/_advanced_table_with_custom_header.jsx +69 -0
  3. data/app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_with_custom_header.md +1 -0
  4. data/app/pb_kits/playbook/pb_advanced_table/docs/example.yml +8 -6
  5. data/app/pb_kits/playbook/pb_advanced_table/docs/index.js +2 -1
  6. data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_colors.jsx +33 -15
  7. data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_default.jsx +33 -15
  8. data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_height.jsx +52 -22
  9. data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_height.md +3 -0
  10. data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_horizontal.jsx +12 -16
  11. data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_legend.jsx +31 -15
  12. data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_legend_non_clickable.jsx +39 -16
  13. data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_legend_position.jsx +86 -38
  14. data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_negative_numbers.jsx +32 -15
  15. data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_secondary_y_axis.jsx +72 -22
  16. data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_secondary_y_axis.md +1 -1
  17. data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_spline.jsx +31 -15
  18. data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_stacked.jsx +37 -16
  19. data/app/pb_kits/playbook/pb_bar_graph/docs/_description.md +1 -3
  20. data/app/pb_kits/playbook/pb_bar_graph/docs/example.yml +1 -3
  21. data/app/pb_kits/playbook/pb_bar_graph/docs/index.js +0 -2
  22. data/app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_block.jsx +71 -26
  23. data/app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_colors.jsx +29 -16
  24. data/app/pb_kits/playbook/pb_circle_chart/docs/{_circle_chart_colors.md → _circle_chart_colors_rails.md} +1 -1
  25. data/app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_colors_react.md +2 -0
  26. data/app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_custom_tooltip.jsx +28 -16
  27. data/app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_custom_tooltip.md +4 -2
  28. data/app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_default.jsx +23 -15
  29. data/app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_inner_sizes.jsx +81 -51
  30. data/app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_legend_position.jsx +103 -75
  31. data/app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_legend_position.md +3 -6
  32. data/app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_live_data.jsx +19 -13
  33. data/app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_rounded.jsx +30 -17
  34. data/app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_with_labels.jsx +34 -20
  35. data/app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_with_legend_kit.jsx +29 -20
  36. data/app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_with_title.jsx +28 -20
  37. data/app/pb_kits/playbook/pb_circle_chart/docs/_description.md +1 -0
  38. data/app/pb_kits/playbook/pb_circle_chart/docs/example.yml +0 -1
  39. data/app/pb_kits/playbook/pb_circle_chart/docs/index.js +0 -1
  40. data/app/pb_kits/playbook/pb_table/docs/_table_sticky_columns.jsx +8 -8
  41. data/app/pb_kits/playbook/pb_table/docs/_table_sticky_columns_react.md +1 -1
  42. data/app/pb_kits/playbook/pb_table/docs/_table_sticky_left_columns.jsx +12 -12
  43. data/app/pb_kits/playbook/pb_table/docs/_table_sticky_left_columns_react.md +3 -3
  44. data/app/pb_kits/playbook/pb_table/docs/_table_sticky_right_columns.jsx +12 -12
  45. data/app/pb_kits/playbook/pb_table/docs/_table_sticky_right_columns_react.md +3 -3
  46. data/app/pb_kits/playbook/pb_tooltip/docs/_tooltip_click_open.html.erb +14 -0
  47. data/app/pb_kits/playbook/pb_tooltip/docs/_tooltip_click_open_rails.md +1 -0
  48. data/app/pb_kits/playbook/pb_tooltip/docs/example.yml +1 -0
  49. data/app/pb_kits/playbook/pb_typeahead/docs/_typeahead_preserve_input.html.erb +18 -0
  50. data/app/pb_kits/playbook/pb_typeahead/docs/_typeahead_preserve_input_rails.md +1 -0
  51. data/app/pb_kits/playbook/pb_typeahead/docs/example.yml +1 -0
  52. data/dist/playbook-doc.js +2 -2
  53. metadata +14 -11
  54. data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_custom.jsx +0 -72
  55. data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_custom.md +0 -6
  56. data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_pb_styles.jsx +0 -64
  57. data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_pb_styles.md +0 -1
  58. data/app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_pb_styles.jsx +0 -38
  59. data/app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_pb_styles.md +0 -1
  60. /data/app/pb_kits/playbook/pb_tooltip/docs/{_tooltip_click_open.md → _tooltip_click_open_react.md} +0 -0
  61. /data/app/pb_kits/playbook/pb_typeahead/docs/{_typeahead_preserve_input.md → _typeahead_preserve_input_react.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.PLAY22588587
4
+ version: 14.22.0.pre.alpha.PLAY22958843
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-06-23 00:00:00.000000000 Z
12
+ date: 2025-07-07 00:00:00.000000000 Z
13
13
  dependencies:
14
14
  - !ruby/object:Gem::Dependency
15
15
  name: playbook_ui
@@ -149,6 +149,8 @@ files:
149
149
  - app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_table_props_sticky_header.jsx
150
150
  - app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_table_props_sticky_header_rails.md
151
151
  - app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_table_props_sticky_header_react.md
152
+ - app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_with_custom_header.jsx
153
+ - app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_with_custom_header.md
152
154
  - app/pb_kits/playbook/pb_advanced_table/docs/_mock_data_inline_loading.js
153
155
  - app/pb_kits/playbook/pb_advanced_table/docs/advanced_table_mock_data.json
154
156
  - app/pb_kits/playbook/pb_advanced_table/docs/advanced_table_mock_data_infinite_scroll.json
@@ -228,14 +230,13 @@ files:
228
230
  - app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_colors.html.erb
229
231
  - app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_colors.jsx
230
232
  - 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
239
240
  - app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_horizontal.html.erb
240
241
  - app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_horizontal.jsx
241
242
  - app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_legend.html.erb
@@ -247,8 +248,6 @@ files:
247
248
  - app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_legend_position.md
248
249
  - app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_negative_numbers.html.erb
249
250
  - 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
252
251
  - app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_secondary_y_axis.html.erb
253
252
  - app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_secondary_y_axis.jsx
254
253
  - app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_secondary_y_axis.md
@@ -419,7 +418,8 @@ files:
419
418
  - app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_block.jsx
420
419
  - app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_colors.html.erb
421
420
  - app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_colors.jsx
422
- - app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_colors.md
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
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,8 +431,6 @@ 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
436
434
  - app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_rounded.html.erb
437
435
  - app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_rounded.jsx
438
436
  - app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_with_labels.html.erb
@@ -441,6 +439,7 @@ files:
441
439
  - app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_with_legend_kit.jsx
442
440
  - app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_with_title.html.erb
443
441
  - app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_with_title.jsx
442
+ - app/pb_kits/playbook/pb_circle_chart/docs/_description.md
444
443
  - app/pb_kits/playbook/pb_circle_chart/docs/example.yml
445
444
  - app/pb_kits/playbook/pb_circle_chart/docs/index.js
446
445
  - app/pb_kits/playbook/pb_circle_icon_button/docs/_circle_icon_button_click.jsx
@@ -2283,8 +2282,10 @@ files:
2283
2282
  - app/pb_kits/playbook/pb_toggle/docs/_toggle_props_swift.md
2284
2283
  - app/pb_kits/playbook/pb_toggle/docs/example.yml
2285
2284
  - 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.md
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
2288
2289
  - app/pb_kits/playbook/pb_tooltip/docs/_tooltip_default.html.erb
2289
2290
  - app/pb_kits/playbook/pb_tooltip/docs/_tooltip_default_react.jsx
2290
2291
  - app/pb_kits/playbook/pb_tooltip/docs/_tooltip_default_react.md
@@ -2334,8 +2335,10 @@ files:
2334
2335
  - app/pb_kits/playbook/pb_typeahead/docs/_typeahead_margin_bottom.jsx
2335
2336
  - app/pb_kits/playbook/pb_typeahead/docs/_typeahead_multi_kit.html.erb
2336
2337
  - app/pb_kits/playbook/pb_typeahead/docs/_typeahead_multi_kit.jsx
2338
+ - app/pb_kits/playbook/pb_typeahead/docs/_typeahead_preserve_input.html.erb
2337
2339
  - app/pb_kits/playbook/pb_typeahead/docs/_typeahead_preserve_input.jsx
2338
- - app/pb_kits/playbook/pb_typeahead/docs/_typeahead_preserve_input.md
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
2339
2342
  - app/pb_kits/playbook/pb_typeahead/docs/_typeahead_react_hook.jsx
2340
2343
  - app/pb_kits/playbook/pb_typeahead/docs/_typeahead_react_hook.md
2341
2344
  - app/pb_kits/playbook/pb_typeahead/docs/_typeahead_truncated_text.html.erb
@@ -1,72 +0,0 @@
1
- import React from 'react'
2
- import ReactDOMServer from 'react-dom/server'
3
- import BarGraph from '../_bar_graph'
4
- import Icon from '../../pb_icon/_icon'
5
-
6
- const chartData = [
7
- {
8
- name: 'Role',
9
- data: [0, 200, 300, 654, 656],
10
- },
11
- {
12
- name: 'Company',
13
- data: [150, 524, 320, 440, 500],
14
- },
15
- ]
16
-
17
- const renderIcon = (iconName, color) => {
18
- return ReactDOMServer.renderToStaticMarkup(
19
- <Icon
20
- color={color}
21
- icon={iconName}
22
- />)
23
- };
24
-
25
- const barGraphOptions = {
26
- yAxis: {
27
- tickInterval: 5,
28
- },
29
- xAxis: {
30
- categories: ['1', '2', '3', '4', '5'],
31
- labels: {
32
- useHTML: true,
33
- formatter: function () {
34
- switch (this.value) {
35
- case '1':
36
- return `${renderIcon('frown', 'error')}`;
37
- case '2':
38
- return `${renderIcon('frown', 'warning')}`;
39
- case '3':
40
- return `${renderIcon('frown-open', 'neutral')}`;
41
- case '4':
42
- return `${renderIcon('smile', 'category_7')}`;
43
- case '5':
44
- return `${renderIcon('smile-beam', 'success')}`;
45
- default:
46
- return ''
47
- }
48
- },
49
- style: {
50
- fontSize: '1.4em',
51
- },
52
- y: 42,
53
- },
54
- },
55
- legend: {
56
- itemMarginTop: 62,
57
- },
58
- }
59
-
60
- const BarGraphCustom = () => (
61
- <div>
62
- <BarGraph
63
- chartData={chartData}
64
- customOptions={barGraphOptions}
65
- id="happiness-dashboard"
66
- legend
67
- title="Bar Graph with Custom Overrides"
68
- />
69
- </div>
70
- )
71
-
72
- export default BarGraphCustom
@@ -1,6 +0,0 @@
1
- The `customOptions` prop provides comprehensive access to additional [Highcharts options](https://api.highcharts.com/highcharts/) that are not explicitly defined as props.
2
- It's important to note that certain options may require specific script imports to function properly.
3
-
4
- Note: If you are having trouble getting any Highcharts options to work, please match the formatting of our [staticOptions](https://github.com/powerhome/playbook/blob/master/playbook/app/pb_kits/playbook/pb_bar_graph/_bar_graph.tsx#L85-L141). For example, `yAxis` will need to be wrapped with square brackets.
5
-
6
- You may also need to override any of the [defaults](https://github.com/powerhome/playbook/blob/master/playbook/app/pb_kits/playbook/pb_bar_graph/_bar_graph.tsx#L45-L73) in order to get that options to work.
@@ -1,64 +0,0 @@
1
- import React from 'react'
2
- import Highcharts from "highcharts";
3
- import HighchartsReact from "highcharts-react-official";
4
-
5
- import "../BarGraphStyles.scss";
6
- // Your path might look more like this
7
- //import "playbook-ui/dist/pb_bar_graph/BarGraphStyles.scss";
8
-
9
- const columnChartData = [
10
- {
11
- name: "Installation",
12
- data: [1475, 200, 3000, 654, 656],
13
- },
14
- {
15
- name: "Manufacturing",
16
- data: [4434, 524, 2320, 440, 500],
17
- },
18
- {
19
- name: "Sales & Distribution",
20
- data: [3387, 743, 1344, 434, 440],
21
- },
22
- {
23
- name: "Project Development",
24
- data: [3227, 878, 999, 780, 1000],
25
- },
26
- {
27
- name: "Other",
28
- data: [1111, 677, 3245, 500, 200],
29
- },
30
- ];
31
-
32
- const columnOptions = {
33
- chart: {
34
- type: "column",
35
- },
36
- series: columnChartData,
37
- title: {
38
- text: "Solar Employment Growth by Sector, 2010-2016",
39
- },
40
- subtitle: {
41
- text: "Source: thesolarfoundation.com",
42
- },
43
- xAxis: {
44
- categories: ["Jan", "Feb", "Mar", "Apr", "May"],
45
- },
46
- yAxis: {
47
- min: 0,
48
- title: {
49
- text: "Number of Employees",
50
- },
51
- },
52
- legend: { enabled: false },
53
- credits: { enabled: false },
54
- };
55
-
56
- const BarGraphPbStyles = () => (
57
- <div>
58
- <HighchartsReact highcharts={Highcharts}
59
- options={columnOptions}
60
- />
61
- </div>
62
- )
63
-
64
- export default BarGraphPbStyles
@@ -1 +0,0 @@
1
- You don't need to use the bar graph kit to apply the styles to your Highcharts bar graph. Just import the BarGraphStyles.scss to your component and the styles will apply automatically.
@@ -1,38 +0,0 @@
1
- import React from 'react'
2
- import circleChartTheme from '../circleChartTheme'
3
- import Highcharts from "highcharts"
4
- import HighchartsReact from "highcharts-react-official"
5
-
6
- const data = [
7
- {
8
- name: 'Waiting for Calls',
9
- y: 41,
10
- },
11
- {
12
- name: 'On Call',
13
- y: 49,
14
- },
15
- {
16
- name: 'After Call',
17
- y: 10,
18
- },
19
- ]
20
-
21
- const baseOptions = {
22
- series: [{ data: data }],
23
- }
24
-
25
- const CircleChartPbStyles = () => {
26
- const options = Highcharts.merge({}, circleChartTheme, baseOptions )
27
-
28
- return (
29
- <div>
30
- <HighchartsReact
31
- highcharts={Highcharts}
32
- options={options}
33
- />
34
- </div>
35
- );
36
- };
37
-
38
- export default CircleChartPbStyles;
@@ -1 +0,0 @@
1
- You don't need to use the Circle Chart Kit to apply Playbook styles to your Highcharts circle chart. Just import circleChartTheme.ts and merge it with your chart options—Playbook’s styling will apply automatically.