playbook_ui_docs 14.23.0.pre.rc.1 → 14.23.0.pre.rc.2

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 (27) hide show
  1. checksums.yaml +4 -4
  2. data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_colors.jsx +33 -15
  3. data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_default.jsx +33 -15
  4. data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_height.jsx +52 -22
  5. data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_height.md +3 -0
  6. data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_horizontal.jsx +12 -16
  7. data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_legend.jsx +31 -15
  8. data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_legend_non_clickable.jsx +39 -16
  9. data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_legend_position.jsx +86 -38
  10. data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_negative_numbers.jsx +32 -15
  11. data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_secondary_y_axis.jsx +72 -22
  12. data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_secondary_y_axis.md +1 -1
  13. data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_spline.jsx +31 -15
  14. data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_stacked.jsx +37 -16
  15. data/app/pb_kits/playbook/pb_bar_graph/docs/_description.md +1 -3
  16. data/app/pb_kits/playbook/pb_bar_graph/docs/example.yml +1 -3
  17. data/app/pb_kits/playbook/pb_bar_graph/docs/index.js +0 -2
  18. data/app/pb_kits/playbook/pb_tooltip/docs/_tooltip_click_open.html.erb +14 -0
  19. data/app/pb_kits/playbook/pb_tooltip/docs/_tooltip_click_open_rails.md +1 -0
  20. data/app/pb_kits/playbook/pb_tooltip/docs/example.yml +1 -0
  21. data/dist/playbook-doc.js +1 -1
  22. metadata +6 -7
  23. data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_custom.jsx +0 -72
  24. data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_custom.md +0 -6
  25. data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_pb_styles.jsx +0 -64
  26. data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_pb_styles.md +0 -1
  27. /data/app/pb_kits/playbook/pb_tooltip/docs/{_tooltip_click_open.md → _tooltip_click_open_react.md} +0 -0
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 021e5e1df1ae0129b51726039133b99b9da3cd8fca36230538ddb569fc5363d5
4
- data.tar.gz: 49f3ab1ab8a8eeb50b9b71505709d2be1ce851d3a49e66efda826f80f61172b8
3
+ metadata.gz: 190428db0e7442d7e696e0d449a2d347fa86dcdab8d6be86dbfab8693b50b856
4
+ data.tar.gz: dc907972424b05d67da04273e4fed3d03bdecdb6da34cc6cc6c6bea0c9d85a76
5
5
  SHA512:
6
- metadata.gz: 6949c77ff0d0f386abf6ba458ad48638b59c259f48f168006dbb875a07becec8ffe35055e662f952e533584413844f5805f4d1c1ee72d2449f38e204e4226b40
7
- data.tar.gz: 1c9d032a727dcea1706a906f0187aaa4d5496f56af7033924d135cfa98dd7ae644df55e6cb80ad74a022b61b121528a76523f64af20341fd3b48b85ff2502088
6
+ metadata.gz: 279d78a480b1460fa9f6ddc11ebf7cff297549f8a94aad0b911d9f3d0012f5486248b73bf515c5aed8d6b194d06c6fd818eff63cf7e589f1802bdcaf6694f1c9
7
+ data.tar.gz: 517667dd5a348b793e94a968be189f14a1999106f8cc74efdce213d0b42e468ab3a5d1196a7e0c97a4f47be8e7850558ec4d1ecf83ee909aa8d88deecff3c0d8
@@ -1,6 +1,10 @@
1
1
  import React from 'react'
2
+ import colors from '../../tokens/exports/_colors.module.scss'
3
+ import barGraphTheme from '../barGraphTheme';
4
+ import Highcharts from "highcharts";
5
+ import HighchartsReact from "highcharts-react-official";
6
+
2
7
 
3
- import BarGraph from '../_bar_graph'
4
8
 
5
9
  const chartData = [{
6
10
  name: 'Installation',
@@ -19,19 +23,33 @@ const chartData = [{
19
23
  data: [1111, 677, 3245, 500, 200],
20
24
  }]
21
25
 
22
- const BarGraphColors = (props) => (
23
- <div>
24
- <BarGraph
25
- axisTitle="Number of Employees"
26
- chartData={chartData}
27
- colors={['data-4', 'data-5', 'data-6', 'data-7', 'data-8']}
28
- id="bar-colors"
29
- title="Bar Graph with Custom Data Colors"
30
- xAxisCategories={['Jan', 'Feb', 'Mar', 'Apr', 'May']}
31
- yAxisMin={0}
32
- {...props}
33
- />
34
- </div>
35
- )
26
+ const chartOptions = {
27
+ series: chartData,
28
+ title: {
29
+ text: "Bar Graph with Custom Data Colors",
30
+ },
31
+ xAxis: {
32
+ categories: ["Jan", "Feb", "Mar", "Apr", "May"],
33
+ },
34
+ yAxis: {
35
+ title: {
36
+ text: "Number of Employees",
37
+ },
38
+ },
39
+ colors: [colors.data_4, colors.data_5, colors.data_6, colors.data_7, colors.data_8],
40
+ }
41
+
42
+ const BarGraphColors = () => {
43
+ const options = Highcharts.merge({}, barGraphTheme, chartOptions)
44
+
45
+ return (
46
+ <div>
47
+ <HighchartsReact
48
+ highcharts={Highcharts}
49
+ options={options}
50
+ />
51
+ </div>
52
+ )
53
+ }
36
54
 
37
55
  export default BarGraphColors
@@ -1,6 +1,8 @@
1
1
  import React from 'react'
2
+ import barGraphTheme from '../barGraphTheme';
3
+ import Highcharts from "highcharts";
4
+ import HighchartsReact from "highcharts-react-official";
2
5
 
3
- import BarGraph from '../_bar_graph'
4
6
 
5
7
  const chartData = [{
6
8
  name: 'Installation',
@@ -19,19 +21,35 @@ const chartData = [{
19
21
  data: [1111, 677, 3245, 500, 200],
20
22
  }]
21
23
 
22
- const BarGraphDefault = (props) => (
23
- <div>
24
- <BarGraph
25
- axisTitle="Number of Employees"
26
- chartData={chartData}
27
- id="bar-default"
28
- subTitle="Source: thesolarfoundation.com"
29
- title="Solar Employment Growth by Sector, 2010-2016"
30
- xAxisCategories={['Jan', 'Feb', 'Mar', 'Apr', 'May']}
31
- yAxisMin={0}
32
- {...props}
33
- />
34
- </div>
35
- )
24
+ const chartOptions = {
25
+ series: chartData,
26
+ title: {
27
+ text: 'Solar Employment Growth by Sector, 2010-2016',
28
+ },
29
+ subtitle: {
30
+ text: 'Source: thesolarfoundation.com',
31
+ },
32
+ xAxis: {
33
+ categories: ['Jan', 'Feb', 'Mar', 'Apr', 'May'],
34
+ },
35
+ yAxis: {
36
+ title: {
37
+ text: 'Number of Employees',
38
+ },
39
+ },
40
+ }
41
+
42
+ const BarGraphDefault = () => {
43
+ const options = Highcharts.merge({}, barGraphTheme, chartOptions)
44
+
45
+ return (
46
+ <div>
47
+ <HighchartsReact
48
+ highcharts={Highcharts}
49
+ options={options}
50
+ />
51
+ </div>
52
+ )
53
+ }
36
54
 
37
55
  export default BarGraphDefault
@@ -1,39 +1,69 @@
1
1
  import React from 'react'
2
+ import barGraphTheme from '../barGraphTheme';
3
+ import Highcharts from "highcharts";
4
+ import HighchartsReact from "highcharts-react-official";
2
5
 
3
- import BarGraph from '../_bar_graph'
4
6
 
5
7
  const chartData = [{
6
8
  name: 'Number of Installations',
7
9
  data: [1475, 200, 3000, 654, 656],
8
10
  }]
9
11
 
10
- const BarGraphDefault = (props) => (
12
+ const pixelHeightChartOptions = {
13
+ chart: {
14
+ height: "300"
15
+ },
16
+ series: chartData,
17
+ title: {
18
+ text: "Fixed Height (300px)",
19
+ },
20
+ xAxis: {
21
+ categories: ["Jan", "Feb", "Mar", "Apr", "May"],
22
+ },
23
+ yAxis: {
24
+ title: {
25
+ text: "Number of Employees",
26
+ },
27
+ },
28
+ };
29
+
30
+ const percentageHeightChartOptions = {
31
+ chart: {
32
+ height: "50%"
33
+ },
34
+ series: chartData,
35
+ title: {
36
+ text: "Percentage Height (50%)",
37
+ },
38
+ xAxis: {
39
+ categories: ["Jan", "Feb", "Mar", "Apr", "May"],
40
+ },
41
+ yAxis: {
42
+ title: {
43
+ text: "Number of Employees",
44
+ },
45
+ },
46
+ };
47
+
48
+ const pixelOptions = Highcharts.merge({}, barGraphTheme, pixelHeightChartOptions)
49
+
50
+ const percentageOptions = Highcharts.merge({}, barGraphTheme, percentageHeightChartOptions)
51
+
52
+ const BarGraphHeight = () => (
11
53
  <div>
12
- <BarGraph
13
- axisTitle="Number of Employees"
14
- chartData={chartData}
15
- height="300"
16
- id="bar-fixed-height"
17
- title="Fixed Height (300px)"
18
- xAxisCategories={['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']}
19
- yAxisMin={0}
20
- {...props}
21
- />
54
+ <HighchartsReact
55
+ highcharts={Highcharts}
56
+ options={pixelOptions}
57
+ />
22
58
 
23
59
  <br />
24
60
  <br />
25
61
 
26
- <BarGraph
27
- axisTitle="Number of Employees"
28
- chartData={chartData}
29
- height="50%"
30
- id="bar-percentage-height"
31
- title="Percentage Height (50%)"
32
- xAxisCategories={['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']}
33
- yAxisMin={0}
34
- {...props}
62
+ <HighchartsReact
63
+ highcharts={Highcharts}
64
+ options={percentageOptions}
35
65
  />
36
66
  </div>
37
67
  )
38
68
 
39
- export default BarGraphDefault
69
+ export default BarGraphHeight
@@ -0,0 +1,3 @@
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,9 +1,10 @@
1
1
  import React from 'react'
2
+ import barGraphTheme from '../barGraphTheme';
3
+ import Highcharts from "highcharts";
4
+ import HighchartsReact from "highcharts-react-official";
2
5
 
3
- import BarGraph from '../_bar_graph'
4
6
 
5
-
6
- const barGraphOptions = {
7
+ const chartOptions = {
7
8
  chart: {
8
9
  type: 'bar'
9
10
  },
@@ -22,13 +23,8 @@ const barGraphOptions = {
22
23
  lineWidth: 0
23
24
  },
24
25
  yAxis: {
25
- min: 0,
26
26
  title: {
27
- text: 'Population (millions)',
28
- align: 'high'
29
- },
30
- labels: {
31
- overflow: 'justify'
27
+ text: '',
32
28
  },
33
29
  },
34
30
  tooltip: {
@@ -51,16 +47,16 @@ const barGraphOptions = {
51
47
  }, {
52
48
  name: 'Year 2018',
53
49
  data: [1276, 1007, 4561, 746]
54
- }]
50
+ }],
55
51
  }
56
52
 
57
- const BarGraphHorizontal = (props) => (
53
+ const options = Highcharts.merge({}, barGraphTheme, chartOptions)
54
+
55
+ const BarGraphHorizontal = () => (
58
56
  <div>
59
- <BarGraph
60
- customOptions={barGraphOptions}
61
- id="bar-horizontal"
62
- yAxisMin={0}
63
- {...props}
57
+ <HighchartsReact
58
+ highcharts={Highcharts}
59
+ options={options}
64
60
  />
65
61
  </div>
66
62
  )
@@ -1,24 +1,40 @@
1
1
  import React from 'react'
2
- import BarGraph from "../../pb_bar_graph/_bar_graph"
2
+ import barGraphTheme from '../barGraphTheme';
3
+ import Highcharts from "highcharts";
4
+ import HighchartsReact from "highcharts-react-official";
5
+
3
6
 
4
7
  const chartData = [{
5
8
  name: 'Number of Installations',
6
9
  data: [1475, 200, 3000, 654, 656],
7
10
  }]
8
11
 
9
- const BarGraphLegend = (props) => (
10
- <div>
11
- <BarGraph
12
- axisTitle="Number of Employees"
13
- chartData={chartData}
14
- id="bar-test-2"
15
- legend
16
- title="Bar Graph with Legend"
17
- xAxisCategories={['Jan', 'Feb', 'Mar', 'Apr', 'May']}
18
- yAxisMin={0}
19
- {...props}
20
- />
21
- </div>
22
- )
12
+ const chartOptions = {
13
+ series: chartData,
14
+ title: {
15
+ text: 'Bar Graph with Legend',
16
+ },
17
+ xAxis: {
18
+ categories: ['Jan', 'Feb', 'Mar', 'Apr', 'May'],
19
+ },
20
+ yAxis: {
21
+ title: {
22
+ text: 'Number of Employees',
23
+ },
24
+ },
25
+ legend: { enabled: true },
26
+ }
23
27
 
28
+ const BarGraphLegend = () => {
29
+ const options = Highcharts.merge({}, barGraphTheme, chartOptions)
30
+
31
+ return (
32
+ <div>
33
+ <HighchartsReact
34
+ highcharts={Highcharts}
35
+ options={options}
36
+ />
37
+ </div>
38
+ )
39
+ }
24
40
  export default BarGraphLegend
@@ -1,25 +1,48 @@
1
1
  import React from 'react'
2
- import BarGraph from "../../pb_bar_graph/_bar_graph"
2
+ import barGraphTheme from '../barGraphTheme';
3
+ import Highcharts from "highcharts";
4
+ import HighchartsReact from "highcharts-react-official";
5
+
3
6
 
4
7
  const chartData = [{
5
8
  name: 'Number of Installations',
6
9
  data: [1475, 200, 3000, 654, 656],
7
10
  }]
8
11
 
9
- const BarGraphLegendNonClickable = (props) => (
10
- <div>
11
- <BarGraph
12
- axisTitle="Number of Employees"
13
- chartData={chartData}
14
- id="bar-test-3"
15
- legend
16
- title="Bar Graph with Legend Non Clickable"
17
- toggleLegendClick={false}
18
- xAxisCategories={['Jan', 'Feb', 'Mar', 'Apr', 'May']}
19
- yAxisMin={0}
20
- {...props}
21
- />
22
- </div>
23
- )
12
+ const chartOptions = {
13
+ title: {
14
+ text: 'Bar Graph with Legend Non Clickable',
15
+ },
16
+ xAxis: {
17
+ categories: ['Jan', 'Feb', 'Mar', 'Apr', 'May'],
18
+ },
19
+ yAxis: {
20
+ title: {
21
+ text: 'Number of Employees',
22
+ },
23
+ },
24
+ legend: {
25
+ enabled: true,
26
+ events: {
27
+ itemClick: function () {
28
+ return false;
29
+ }
30
+ }
31
+ },
32
+ series: chartData
33
+ }
34
+
35
+ const BarGraphLegendNonClickable = () => {
36
+ const options = Highcharts.merge({}, barGraphTheme, chartOptions)
37
+
38
+ return (
39
+ <div>
40
+ <HighchartsReact
41
+ highcharts={Highcharts}
42
+ options={options}
43
+ />
44
+ </div>
45
+ )
46
+ }
24
47
 
25
48
  export default BarGraphLegendNonClickable
@@ -1,8 +1,11 @@
1
1
  import React from 'react'
2
+ import barGraphTheme from '../barGraphTheme';
3
+ import Highcharts from "highcharts";
4
+ import HighchartsReact from "highcharts-react-official";
2
5
 
3
- import BarGraph from "../../pb_bar_graph/_bar_graph"
4
6
  import Title from "../../pb_title/_title"
5
7
 
8
+
6
9
  const chartData = [{
7
10
  name: 'Installation',
8
11
  data: [1475],
@@ -20,7 +23,76 @@ const chartData = [{
20
23
  data: [1111],
21
24
  }]
22
25
 
23
- const BarGraphLegendPosition = (props) => (
26
+ const alignChartOptions = {
27
+ series: chartData,
28
+ title: {
29
+ text: 'Alignment of Legend',
30
+ },
31
+ subtitle: {
32
+ text: 'Source: thesolarfoundation.com',
33
+ },
34
+ xAxis: {
35
+ categories: ['Jan'],
36
+ },
37
+ yAxis: {
38
+ title: {
39
+ text: 'Number of Employees',
40
+ },
41
+ },
42
+ legend: {
43
+ enabled: true,
44
+ verticalAlign: 'top',
45
+ align: 'right',
46
+ },
47
+ }
48
+
49
+ const layoutChartOptions = {
50
+ series: chartData,
51
+ title: {
52
+ text: 'Layout of Legend',
53
+ },
54
+ xAxis: {
55
+ categories: ['Jan'],
56
+ },
57
+ yAxis: {
58
+ title: {
59
+ text: 'Number of Employees',
60
+ },
61
+ },
62
+ legend: {
63
+ enabled: true,
64
+ layout: 'vertical',
65
+ },
66
+ }
67
+
68
+ const offsetChartOptions = {
69
+ series: chartData,
70
+ title: {
71
+ text: 'Offset of Legend',
72
+ },
73
+ xAxis: {
74
+ categories: ['Jan'],
75
+ },
76
+ yAxis: {
77
+ title: {
78
+ text: 'Number of Employees',
79
+ },
80
+ },
81
+ legend: {
82
+ enabled: true,
83
+ layout: 'vertical',
84
+ x: 100,
85
+ y: 10,
86
+ },
87
+ }
88
+
89
+ const BarGraphLegendPosition = () => {
90
+ const alignOptions = Highcharts.merge({}, barGraphTheme, alignChartOptions)
91
+ const layoutOptions = Highcharts.merge({}, barGraphTheme, layoutChartOptions)
92
+ const offsetOptions = Highcharts.merge({}, barGraphTheme, offsetChartOptions)
93
+
94
+
95
+ return (
24
96
  <div>
25
97
  <Title
26
98
  paddingBottom="sm"
@@ -29,19 +101,11 @@ const BarGraphLegendPosition = (props) => (
29
101
  tag="h4"
30
102
  text="align | verticalAlign"
31
103
  />
32
- <BarGraph
33
- align='right'
34
- axisTitle="Number of Employees"
35
- chartData={chartData}
36
- id="legend-position-bar"
37
- legend
38
- paddingBottom="sm"
39
- title="Alignment of Legend"
40
- verticalAlign="top"
41
- xAxisCategories={['Jan']}
42
- yAxisMin={0}
43
- {...props}
104
+ <HighchartsReact
105
+ highcharts={Highcharts}
106
+ options={alignOptions}
44
107
  />
108
+
45
109
  <Title
46
110
  paddingBottom="sm"
47
111
  paddingTop="sm"
@@ -49,19 +113,11 @@ const BarGraphLegendPosition = (props) => (
49
113
  tag="h4"
50
114
  text="layout"
51
115
  />
52
- <BarGraph
53
- axisTitle="Number of Employees"
54
- chartData={chartData}
55
- id="legend-position-bar-1"
56
- layout="vertical"
57
- legend
58
- paddingBottom="sm"
59
- paddingTop="sm"
60
- title="Layout of Legend"
61
- xAxisCategories={['Jan']}
62
- yAxisMin={0}
63
- {...props}
116
+ <HighchartsReact
117
+ highcharts={Highcharts}
118
+ options={layoutOptions}
64
119
  />
120
+
65
121
  <Title
66
122
  paddingBottom="sm"
67
123
  paddingTop="sm"
@@ -69,20 +125,12 @@ const BarGraphLegendPosition = (props) => (
69
125
  tag="h4"
70
126
  text="x | y"
71
127
  />
72
- <BarGraph
73
- axisTitle="Number of Employees"
74
- chartData={chartData}
75
- id="legend-position-bar-2"
76
- layout="vertical"
77
- legend
78
- title="Offset of Legend"
79
- x={100}
80
- xAxisCategories={['Jan']}
81
- y={10}
82
- yAxisMin={0}
83
- {...props}
128
+ <HighchartsReact
129
+ highcharts={Highcharts}
130
+ options={offsetOptions}
84
131
  />
85
132
  </div>
86
133
  )
134
+ }
87
135
 
88
136
  export default BarGraphLegendPosition
@@ -1,6 +1,8 @@
1
1
  import React from 'react'
2
+ import barGraphTheme from '../barGraphTheme';
3
+ import Highcharts from "highcharts";
4
+ import HighchartsReact from "highcharts-react-official";
2
5
 
3
- import BarGraph from '../_bar_graph'
4
6
 
5
7
  const chartData = [{
6
8
  name: 'Installation',
@@ -10,26 +12,41 @@ const chartData = [{
10
12
  name: 'Manufacturing',
11
13
  data: [1475, 200, 1000, 654, -656],
12
14
  threshold: 0
13
- },
15
+ },
14
16
  {
15
17
  name: 'Sales & Distribution',
16
18
  data: [1270, 100, -1200, 554, 756],
17
19
  threshold: 0
18
20
  }]
19
21
 
22
+ const chartOptions = {
23
+ series: chartData,
24
+ title: {
25
+ text: "Bar Graph with Negative Numbers",
26
+ },
27
+ xAxis: {
28
+ categories: ["Jan", "Feb", "Mar", "Apr", "May"],
29
+ },
30
+ yAxis: {
31
+ title: {
32
+ text: "Number of Employees",
33
+ },
34
+ },
35
+ legend: { enabled: true },
36
+ };
20
37
 
21
- const BarGraphStacked = (props) => (
22
- <div>
23
- <BarGraph
24
- axisTitle="Number of Employees"
25
- chartData={chartData}
26
- id="bar-default"
27
- legend
28
- title="Bar Graph with Negative Numbers"
29
- xAxisCategories={['Jan', 'Feb', 'Mar', 'Apr', 'May']}
30
- {...props}
31
- />
32
- </div>
33
- )
38
+
39
+ const BarGraphStacked = () => {
40
+ const options = Highcharts.merge({}, barGraphTheme, chartOptions)
41
+
42
+ return(
43
+ <div>
44
+ <HighchartsReact
45
+ highcharts={Highcharts}
46
+ options={options}
47
+ />
48
+ </div>
49
+ )
50
+ }
34
51
 
35
52
  export default BarGraphStacked