playbook_ui_docs 15.4.0 → 15.5.0.pre.alpha.draggablefix12557

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 (137) hide show
  1. checksums.yaml +4 -4
  2. data/app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_column_styling.jsx +2 -1
  3. data/app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_column_styling_column_headers.jsx +1 -1
  4. data/app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_fullscreen.jsx +3 -1
  5. data/app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_infinite_scroll.jsx +1 -1
  6. data/app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_inline_editing.jsx +3 -1
  7. data/app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_row_styling.jsx +2 -1
  8. data/app/pb_kits/playbook/pb_copy_button/docs/_copy_button_button_variant.html.erb +9 -0
  9. data/app/pb_kits/playbook/pb_copy_button/docs/_copy_button_button_variant.jsx +24 -0
  10. data/app/pb_kits/playbook/pb_copy_button/docs/_copy_button_button_variant_rails.md +1 -0
  11. data/app/pb_kits/playbook/pb_copy_button/docs/_copy_button_button_variant_react.md +1 -0
  12. data/app/pb_kits/playbook/pb_copy_button/docs/_copy_button_default.html.erb +2 -2
  13. data/app/pb_kits/playbook/pb_copy_button/docs/_copy_button_default.jsx +1 -2
  14. data/app/pb_kits/playbook/pb_copy_button/docs/_copy_button_from.html.erb +2 -2
  15. data/app/pb_kits/playbook/pb_copy_button/docs/_copy_button_from.jsx +2 -0
  16. data/app/pb_kits/playbook/pb_copy_button/docs/example.yml +2 -0
  17. data/app/pb_kits/playbook/pb_copy_button/docs/index.js +1 -0
  18. data/app/pb_kits/playbook/pb_currency/docs/_currency_abbreviated.md +1 -0
  19. data/app/pb_kits/playbook/pb_currency/docs/_currency_matching_decimals_rails.md +1 -0
  20. data/app/pb_kits/playbook/pb_currency/docs/_currency_matching_decimals_react.md +1 -0
  21. data/app/pb_kits/playbook/pb_currency/docs/_currency_negative.html.erb +10 -0
  22. data/app/pb_kits/playbook/pb_currency/docs/_currency_negative.jsx +10 -0
  23. data/app/pb_kits/playbook/pb_currency/docs/_currency_negative.md +1 -0
  24. data/app/pb_kits/playbook/pb_currency/docs/_currency_no_symbol_rails.md +1 -0
  25. data/app/pb_kits/playbook/pb_currency/docs/_currency_no_symbol_react.md +1 -0
  26. data/app/pb_kits/playbook/pb_currency/docs/_currency_variants.html.erb +7 -0
  27. data/app/pb_kits/playbook/pb_currency/docs/_currency_variants.jsx +7 -0
  28. data/app/pb_kits/playbook/pb_currency/docs/_description.md +2 -2
  29. data/app/pb_kits/playbook/pb_date_range_inline/docs/_date_range_inline_show_current_year.html.erb +4 -0
  30. data/app/pb_kits/playbook/pb_date_range_inline/docs/_date_range_inline_show_current_year.jsx +43 -0
  31. data/app/pb_kits/playbook/pb_date_range_inline/docs/_date_range_inline_show_current_year.md +1 -0
  32. data/app/pb_kits/playbook/pb_date_range_inline/docs/_description.md +1 -1
  33. data/app/pb_kits/playbook/pb_date_range_inline/docs/example.yml +3 -2
  34. data/app/pb_kits/playbook/pb_date_range_inline/docs/index.js +1 -0
  35. data/app/pb_kits/playbook/pb_date_stacked/docs/_date_stacked_current_year.html.erb +12 -0
  36. data/app/pb_kits/playbook/pb_date_stacked/docs/{_date_stacked_not_current_year.jsx → _date_stacked_current_year.jsx} +6 -5
  37. data/app/pb_kits/playbook/pb_date_stacked/docs/_date_stacked_current_year.md +1 -0
  38. data/app/pb_kits/playbook/pb_date_stacked/docs/_date_stacked_default.html.erb +1 -1
  39. data/app/pb_kits/playbook/pb_date_stacked/docs/_date_stacked_default.jsx +1 -1
  40. data/app/pb_kits/playbook/pb_date_stacked/docs/_description.md +1 -1
  41. data/app/pb_kits/playbook/pb_date_stacked/docs/example.yml +2 -2
  42. data/app/pb_kits/playbook/pb_date_stacked/docs/index.js +1 -1
  43. data/app/pb_kits/playbook/pb_date_time/docs/_date_time_show_current_year.html.erb +4 -0
  44. data/app/pb_kits/playbook/pb_date_time/docs/_date_time_show_current_year.jsx +14 -0
  45. data/app/pb_kits/playbook/pb_date_time/docs/_date_time_show_current_year_rails.md +1 -0
  46. data/app/pb_kits/playbook/pb_date_time/docs/_date_time_show_current_year_react.md +1 -0
  47. data/app/pb_kits/playbook/pb_date_time/docs/example.yml +3 -1
  48. data/app/pb_kits/playbook/pb_date_time/docs/index.js +1 -0
  49. data/app/pb_kits/playbook/pb_date_time_stacked/docs/_date_time_stacked_show_current_year.html.erb +4 -0
  50. data/app/pb_kits/playbook/pb_date_time_stacked/docs/_date_time_stacked_show_current_year.jsx +22 -0
  51. data/app/pb_kits/playbook/pb_date_time_stacked/docs/_date_time_stacked_show_current_year.md +1 -0
  52. data/app/pb_kits/playbook/pb_date_time_stacked/docs/example.yml +3 -1
  53. data/app/pb_kits/playbook/pb_date_time_stacked/docs/index.js +1 -0
  54. data/app/pb_kits/playbook/pb_dialog/docs/_dialog_compound_components.html.erb +2 -2
  55. data/app/pb_kits/playbook/pb_draggable/docs/_draggable_multiple_containers_dropzone.jsx +179 -0
  56. data/app/pb_kits/playbook/pb_draggable/docs/example.yml +1 -0
  57. data/app/pb_kits/playbook/pb_draggable/docs/index.js +2 -1
  58. data/app/pb_kits/playbook/pb_empty_state/docs/_empty_state_alignment.jsx +2 -1
  59. data/app/pb_kits/playbook/pb_empty_state/docs/_empty_state_default.jsx +2 -1
  60. data/app/pb_kits/playbook/pb_empty_state/docs/_empty_state_orientation.jsx +2 -1
  61. data/app/pb_kits/playbook/pb_empty_state/docs/_empty_state_size.jsx +2 -1
  62. data/app/pb_kits/playbook/pb_flex/docs/_flex_item_example.jsx +1 -0
  63. data/app/pb_kits/playbook/pb_form_pill/docs/_form_pill_wrapped.jsx +4 -1
  64. data/app/pb_kits/playbook/pb_loading_inline/docs/_loading_inline_variant.jsx +1 -1
  65. data/app/pb_kits/playbook/pb_nav/docs/_horizontal_nav_disabled.html.erb +21 -0
  66. data/app/pb_kits/playbook/pb_nav/docs/_horizontal_nav_disabled.jsx +113 -0
  67. data/app/pb_kits/playbook/pb_nav/docs/_horizontal_nav_disabled.md +1 -0
  68. data/app/pb_kits/playbook/pb_nav/docs/_vertical_nav_disabled.html.erb +30 -0
  69. data/app/pb_kits/playbook/pb_nav/docs/_vertical_nav_disabled.jsx +117 -0
  70. data/app/pb_kits/playbook/pb_nav/docs/_vertical_nav_disabled.md +1 -0
  71. data/app/pb_kits/playbook/pb_nav/docs/example.yml +4 -0
  72. data/app/pb_kits/playbook/pb_nav/docs/index.js +3 -1
  73. data/app/pb_kits/playbook/pb_pb_bar_graph/docs/_description.md +3 -1
  74. data/app/pb_kits/playbook/pb_pb_bar_graph/docs/_pb_bar_graph_colors.jsx +1 -1
  75. data/app/pb_kits/playbook/pb_pb_bar_graph/docs/_pb_bar_graph_default.jsx +1 -1
  76. data/app/pb_kits/playbook/pb_pb_bar_graph/docs/_pb_bar_graph_default.md +1 -0
  77. data/app/pb_kits/playbook/pb_pb_bar_graph/docs/_pb_bar_graph_height.jsx +1 -1
  78. data/app/pb_kits/playbook/pb_pb_bar_graph/docs/_pb_bar_graph_horizontal.jsx +1 -1
  79. data/app/pb_kits/playbook/pb_pb_bar_graph/docs/_pb_bar_graph_legend.jsx +1 -1
  80. data/app/pb_kits/playbook/pb_pb_bar_graph/docs/_pb_bar_graph_legend_non_clickable.jsx +1 -2
  81. data/app/pb_kits/playbook/pb_pb_bar_graph/docs/_pb_bar_graph_legend_position.html.erb +1 -1
  82. data/app/pb_kits/playbook/pb_pb_bar_graph/docs/_pb_bar_graph_legend_position.jsx +1 -1
  83. data/app/pb_kits/playbook/pb_pb_bar_graph/docs/_pb_bar_graph_legend_position.md +11 -0
  84. data/app/pb_kits/playbook/pb_pb_bar_graph/docs/_pb_bar_graph_negative_numbers.jsx +1 -1
  85. data/app/pb_kits/playbook/pb_pb_bar_graph/docs/_pb_bar_graph_secondary_y_axis.jsx +1 -1
  86. data/app/pb_kits/playbook/pb_pb_bar_graph/docs/_pb_bar_graph_spline.jsx +1 -2
  87. data/app/pb_kits/playbook/pb_pb_bar_graph/docs/_pb_bar_graph_stacked.jsx +1 -2
  88. data/app/pb_kits/playbook/pb_pb_circle_chart/docs/_description.md +3 -1
  89. data/app/pb_kits/playbook/pb_pb_circle_chart/docs/_pb_circle_chart_block_content.jsx +2 -1
  90. data/app/pb_kits/playbook/pb_pb_circle_chart/docs/_pb_circle_chart_color_overrides.jsx +2 -1
  91. data/app/pb_kits/playbook/pb_pb_circle_chart/docs/_pb_circle_chart_custom_tooltip.jsx +1 -1
  92. data/app/pb_kits/playbook/pb_pb_circle_chart/docs/_pb_circle_chart_custom_tooltip.md +2 -1
  93. data/app/pb_kits/playbook/pb_pb_circle_chart/docs/_pb_circle_chart_data_legend_position.jsx +2 -1
  94. data/app/pb_kits/playbook/pb_pb_circle_chart/docs/_pb_circle_chart_data_with_labels.jsx +1 -1
  95. data/app/pb_kits/playbook/pb_pb_circle_chart/docs/_pb_circle_chart_data_with_legend.jsx +1 -1
  96. data/app/pb_kits/playbook/pb_pb_circle_chart/docs/_pb_circle_chart_default.jsx +1 -1
  97. data/app/pb_kits/playbook/pb_pb_circle_chart/docs/_pb_circle_chart_default.md +1 -0
  98. data/app/pb_kits/playbook/pb_pb_circle_chart/docs/_pb_circle_chart_inner_sizes.jsx +1 -1
  99. data/app/pb_kits/playbook/pb_pb_circle_chart/docs/_pb_circle_chart_live_data.jsx +2 -1
  100. data/app/pb_kits/playbook/pb_pb_circle_chart/docs/_pb_circle_chart_rounded.jsx +1 -1
  101. data/app/pb_kits/playbook/pb_pb_circle_chart/docs/_pb_circle_chart_with_title.jsx +1 -1
  102. data/app/pb_kits/playbook/pb_pb_gauge_chart/docs/_description.md +3 -1
  103. data/app/pb_kits/playbook/pb_pb_gauge_chart/docs/_pb_gauge_chart_color.jsx +1 -1
  104. data/app/pb_kits/playbook/pb_pb_gauge_chart/docs/_pb_gauge_chart_color.md +2 -2
  105. data/app/pb_kits/playbook/pb_pb_gauge_chart/docs/_pb_gauge_chart_complex.jsx +2 -1
  106. data/app/pb_kits/playbook/pb_pb_gauge_chart/docs/_pb_gauge_chart_default.md +1 -0
  107. data/app/pb_kits/playbook/pb_pb_gauge_chart/docs/_pb_gauge_chart_full_circle.jsx +2 -1
  108. data/app/pb_kits/playbook/pb_pb_gauge_chart/docs/_pb_gauge_chart_height.jsx +2 -1
  109. data/app/pb_kits/playbook/pb_pb_gauge_chart/docs/_pb_gauge_chart_min_max.jsx +2 -1
  110. data/app/pb_kits/playbook/pb_pb_gauge_chart/docs/_pb_gauge_chart_units.jsx +2 -1
  111. data/app/pb_kits/playbook/pb_pb_line_graph/docs/_description.md +3 -1
  112. data/app/pb_kits/playbook/pb_pb_line_graph/docs/_pb_line_graph_colors.jsx +1 -1
  113. data/app/pb_kits/playbook/pb_pb_line_graph/docs/_pb_line_graph_default.md +1 -0
  114. data/app/pb_kits/playbook/pb_pb_line_graph/docs/_pb_line_graph_legend_position.html.erb +1 -1
  115. data/app/pb_kits/playbook/pb_popover/docs/_popover_append_to.jsx +4 -1
  116. data/app/pb_kits/playbook/pb_progress_step/docs/_description.md +1 -5
  117. data/app/pb_kits/playbook/pb_progress_step/docs/_progress_step_color.html.erb +14 -0
  118. data/app/pb_kits/playbook/pb_progress_step/docs/_progress_step_color.jsx +29 -0
  119. data/app/pb_kits/playbook/pb_progress_step/docs/_progress_step_color.md +3 -0
  120. data/app/pb_kits/playbook/pb_progress_step/docs/_progress_step_custom_icon.jsx +31 -0
  121. data/app/pb_kits/playbook/pb_progress_step/docs/_progress_step_custom_icon.md +1 -0
  122. data/app/pb_kits/playbook/pb_progress_step/docs/_progress_step_default.html.erb +4 -1
  123. data/app/pb_kits/playbook/pb_progress_step/docs/_progress_step_default.jsx +14 -3
  124. data/app/pb_kits/playbook/pb_progress_step/docs/_progress_step_default.md +3 -0
  125. data/app/pb_kits/playbook/pb_progress_step/docs/_progress_step_tracker.md +3 -0
  126. data/app/pb_kits/playbook/pb_progress_step/docs/_progress_step_vertical.html.erb +1 -7
  127. data/app/pb_kits/playbook/pb_progress_step/docs/_progress_step_vertical.md +1 -0
  128. data/app/pb_kits/playbook/pb_progress_step/docs/example.yml +3 -0
  129. data/app/pb_kits/playbook/pb_progress_step/docs/index.js +2 -0
  130. data/app/pb_kits/playbook/pb_radio/docs/_radio_react_hook.jsx +3 -1
  131. data/app/pb_kits/playbook/pb_select/docs/_select_react_hook.jsx +3 -1
  132. data/app/pb_kits/playbook/pb_tooltip/docs/_tooltip_sizing.jsx +4 -1
  133. data/app/pb_kits/playbook/pb_typeahead/docs/_typeahead_react_hook.jsx +2 -1
  134. data/app/pb_kits/playbook/pb_user/docs/_user_font_options.jsx +1 -1
  135. metadata +45 -5
  136. data/app/pb_kits/playbook/pb_date_stacked/docs/_date_stacked_not_current_year.html.erb +0 -5
  137. data/dist/playbook-doc.js +0 -19
@@ -0,0 +1,11 @@
1
+ Highcharts provides many options for customizing the legend display. This example showcases the following:
2
+
3
+ `align` can be used to align the legend left, right or center (defaults to center)
4
+
5
+ `verticalAlign` can be used to place the legend above the graph. Options are top, middle, bottom with default set to bottom
6
+
7
+ `layout` determines the position of the legend items. Options are horizontal, vertical or proximate with default set to horizontal `layout: proximate` will place the legend items as close as possible to the graphs they're representing. It will also determine whether to place the legend above/below or on the side of the plot area, if the legend is in a corner.
8
+
9
+ `x` offsets the legend relative to its horizontal alignment. Negative x moves it to the left, positive x moves it to the right (defaults to 0)
10
+
11
+ `y` offsets the legend relative to its vertical alignment. Negative y moves it up, positive y moves it down (defaults to 0)
@@ -1,5 +1,5 @@
1
1
  import React from 'react'
2
- import { PbBarGraph } from 'playbook-ui'
2
+ import PbBarGraph from '../_pb_bar_graph'
3
3
 
4
4
 
5
5
  const chartData = [{
@@ -1,5 +1,5 @@
1
1
  import React from 'react'
2
- import { PbBarGraph } from 'playbook-ui'
2
+ import PbBarGraph from '../_pb_bar_graph'
3
3
 
4
4
  import colors from '../../tokens/exports/_colors.module.scss'
5
5
  import typography from '../../tokens/exports/_typography.module.scss'
@@ -1,6 +1,5 @@
1
1
  import React from 'react'
2
- import { PbBarGraph } from 'playbook-ui'
3
-
2
+ import PbBarGraph from '../_pb_bar_graph'
4
3
 
5
4
  const chartData = [{
6
5
  name: 'Number of Installations',
@@ -1,6 +1,5 @@
1
1
  import React from 'react'
2
- import { PbBarGraph } from 'playbook-ui'
3
-
2
+ import PbBarGraph from '../_pb_bar_graph'
4
3
 
5
4
  const chartData = [{
6
5
  name: 'Installation',
@@ -1,3 +1,5 @@
1
- This kit is a wrapper around the Highcharts library. It applies styling and default settings but does NOT ship Highcharts. In order to use this kit, 'highcharts' and 'highcharts-react-official' must be installed in your repo. Once done, any prop or functionality provided by Highcharts can be used with this kit without requiring specific props from Playbook. The doc examples below showcase a few common usecases but are not a comprehensive list of all the functionalities possible.
1
+ **In order to use this kit, 'highcharts' and 'highcharts-react-official' must be installed in your repo.**
2
+
3
+ This kit is a wrapper around the Highcharts library. It applies styling and default settings but does NOT ship Highcharts. Once 'highcharts' and 'highcharts-react-official are installed into your repo, any prop or functionality provided by Highcharts can be used with this kit without requiring specific props from Playbook. The doc examples below showcase a few common usecases but are not a comprehensive list of all the functionalities possible.
2
4
 
3
5
  See the [highcharts API docs](https://api.highcharts.com/highcharts/) for a comprehensive look at what is possible.
@@ -1,5 +1,6 @@
1
1
  import React from "react";
2
- import { PbCircleChart, Title } from "playbook-ui";
2
+ import PbCircleChart from "../_pb_circle_chart";
3
+ import Title from "../../pb_title/_title";
3
4
 
4
5
  const data= [
5
6
  {
@@ -1,5 +1,6 @@
1
1
  import React from "react";
2
- import { PbCircleChart, colors } from "playbook-ui";
2
+ import PbCircleChart from "../_pb_circle_chart";
3
+ import colors from '../../tokens/exports/_colors.module.scss';
3
4
 
4
5
  const data= [
5
6
  {
@@ -1,5 +1,5 @@
1
1
  import React from "react";
2
- import { PbCircleChart } from "playbook-ui";
2
+ import PbCircleChart from "../_pb_circle_chart";
3
3
 
4
4
  const data = [
5
5
  {
@@ -1,4 +1,5 @@
1
- Custom tooltip formatting is configured through the tooltip object in the options passed to the kit:
1
+ Tooltip options from Highcharts:
2
+
2
3
  `headerFormat` **Type**: String | when set to null will disable the header.
3
4
  `pointFormat` **Type**: String | defines the HTML template for each data point and supports custom HTML when `useHTML` is enabled.
4
5
  `useHTML` **Type**: boolean (default false) | enables HTML rendering in tooltips.
@@ -1,5 +1,6 @@
1
1
  import React from "react";
2
- import { PbCircleChart, Title } from "playbook-ui";
2
+ import PbCircleChart from "../_pb_circle_chart";
3
+ import Title from "../../pb_title/_title";
3
4
 
4
5
  const dataFirst = [
5
6
  {
@@ -1,5 +1,5 @@
1
1
  import React from "react";
2
- import { PbCircleChart } from "playbook-ui";
2
+ import PbCircleChart from "../_pb_circle_chart";
3
3
 
4
4
  const data = [
5
5
  {
@@ -1,5 +1,5 @@
1
1
  import React from "react";
2
- import { PbCircleChart } from "playbook-ui";
2
+ import PbCircleChart from "../_pb_circle_chart";
3
3
 
4
4
  const data = [{
5
5
  name: 'Bugs',
@@ -1,5 +1,5 @@
1
1
  import React from "react";
2
- import { PbCircleChart } from "playbook-ui";
2
+ import PbCircleChart from "../_pb_circle_chart";
3
3
 
4
4
  const chartOptions = {
5
5
  series: [
@@ -0,0 +1 @@
1
+ In order to use this kit, 'highcharts' and 'highcharts-react-official' must be installed in your repo.
@@ -1,5 +1,5 @@
1
1
  import React from "react";
2
- import { PbCircleChart } from "playbook-ui";
2
+ import PbCircleChart from "../_pb_circle_chart";
3
3
 
4
4
  const dataFirst = [
5
5
  {
@@ -1,5 +1,6 @@
1
1
  import React, { useState } from "react";
2
- import { PbCircleChart, Button } from "playbook-ui";
2
+ import PbCircleChart from "../_pb_circle_chart";
3
+ import Button from "../../pb_button/_button";
3
4
 
4
5
  const chartData = [
5
6
  {
@@ -1,5 +1,5 @@
1
1
  import React from "react";
2
- import { PbCircleChart } from "playbook-ui";
2
+ import PbCircleChart from "../_pb_circle_chart";
3
3
 
4
4
  const data= [
5
5
  {
@@ -1,5 +1,5 @@
1
1
  import React from "react";
2
- import { PbCircleChart } from "playbook-ui";
2
+ import PbCircleChart from "../_pb_circle_chart";
3
3
 
4
4
  const data= [
5
5
  {
@@ -1,3 +1,5 @@
1
- This kit is a wrapper around the Highcharts library. It applies styling and default settings but does NOT ship Highcharts. In order to use this kit, 'highcharts' and 'highcharts-react-official' must be installed in your repo. Once done, any prop or functionality provided by Highcharts can be used with this kit without requiring specific props from Playbook. The doc examples below showcase a few common usecases but are not a comprehensive list of all the functionalities possible.
1
+ **In order to use this kit, 'highcharts' and 'highcharts-react-official' must be installed in your repo.**
2
+
3
+ This kit is a wrapper around the Highcharts library. It applies styling and default settings but does NOT ship Highcharts. Once 'highcharts' and 'highcharts-react-official are installed into your repo, any prop or functionality provided by Highcharts can be used with this kit without requiring specific props from Playbook. The doc examples below showcase a few common usecases but are not a comprehensive list of all the functionalities possible.
2
4
 
3
5
  See the [highcharts API docs](https://api.highcharts.com/highcharts/) for a comprehensive look at what is possible.
@@ -1,6 +1,6 @@
1
1
  import React from 'react'
2
2
  import PbGaugeChart from '../../pb_pb_gauge_chart/_pb_gauge_chart'
3
- import { colors } from 'playbook-ui'
3
+ import colors from '../../tokens/exports/_colors.module.scss'
4
4
 
5
5
  const data = [{ name: "Name", y: 67 }]
6
6
 
@@ -1,5 +1,5 @@
1
1
  Highcharts allows for any custom colors to be used. Custom data colors allow for color customization to match the needs of business requirements.
2
2
 
3
- For React, pass the prop `plotOptions.solidgauge.borderColor` with a Playbook token like `colors.` + `data_1 | data_2 | data_3 | data_4 | data_5 | data_6 | data_7 | data_8`. HEX colors are also available `eg: #CA0095`
3
+ For React, pass the option `plotOptions.solidgauge.borderColor` with a Playbook token like `colors.` + `data_1 | data_2 | data_3 | data_4 | data_5 | data_6 | data_7 | data_8`. HEX colors are also available `eg: #CA0095`
4
4
 
5
- For Rails, the prop `plotOptions.solidgauge.borderColor` can only be used with HEX values as shown.
5
+ For Rails, the option `plotOptions.solidgauge.borderColor` can only be used with HEX values as shown.
@@ -7,7 +7,8 @@ import Caption from '../../pb_caption/_caption'
7
7
  import Body from '../../pb_body/_body'
8
8
  import SectionSeparator from '../../pb_section_separator/_section_separator'
9
9
  import Title from '../../pb_title/_title'
10
- import { colors, typography } from 'playbook-ui'
10
+ import colors from '../../tokens/exports/_colors.module.scss'
11
+ import typography from '../../tokens/exports/_typography.module.scss'
11
12
 
12
13
  const data = [{ name: "Name", y: 10 }];
13
14
 
@@ -0,0 +1 @@
1
+ In order to use this kit, 'highcharts' and 'highcharts-react-official' must be installed in your repo.
@@ -1,6 +1,7 @@
1
1
  import React from 'react'
2
2
  import PbGaugeChart from '../../pb_pb_gauge_chart/_pb_gauge_chart'
3
- import { colors, typography } from 'playbook-ui'
3
+ import colors from '../../tokens/exports/_colors.module.scss'
4
+ import typography from '../../tokens/exports/_typography.module.scss'
4
5
 
5
6
  const data = [{ name: "Capacity", y: 75 }]
6
7
 
@@ -1,6 +1,7 @@
1
1
  import React from 'react'
2
2
  import PbGaugeChart from '../../pb_pb_gauge_chart/_pb_gauge_chart'
3
- import { colors, typography } from 'playbook-ui'
3
+ import colors from '../../tokens/exports/_colors.module.scss'
4
+ import typography from '../../tokens/exports/_typography.module.scss'
4
5
 
5
6
  const chartOptions = {
6
7
  title: {
@@ -1,6 +1,7 @@
1
1
  import React from 'react'
2
2
  import PbGaugeChart from '../../pb_pb_gauge_chart/_pb_gauge_chart'
3
- import { colors, typography } from 'playbook-ui'
3
+ import colors from '../../tokens/exports/_colors.module.scss'
4
+ import typography from '../../tokens/exports/_typography.module.scss'
4
5
 
5
6
  const data = [{ name: "Rating", y: 4.5 }]
6
7
 
@@ -1,6 +1,7 @@
1
1
  import React from 'react'
2
2
  import PbGaugeChart from '../../pb_pb_gauge_chart/_pb_gauge_chart'
3
- import { colors, typography } from 'playbook-ui'
3
+ import colors from '../../tokens/exports/_colors.module.scss'
4
+ import typography from '../../tokens/exports/_typography.module.scss'
4
5
 
5
6
 
6
7
  const data1 = [
@@ -1,3 +1,5 @@
1
- This kit is a wrapper around the Highcharts library. It applies styling and default settings but does NOT ship Highcharts. In order to use this kit, 'highcharts' and 'highcharts-react-official' must be installed in your repo. Once done, any prop or functionality provided by Highcharts can be used with this kit without requiring specific props from Playbook. The doc examples below showcase a few common usecases but are not a comprehensive list of all the functionalities possible.
1
+ **In order to use this kit, 'highcharts' and 'highcharts-react-official' must be installed in your repo.**
2
+
3
+ This kit is a wrapper around the Highcharts library. It applies styling and default settings but does NOT ship Highcharts. Once 'highcharts' and 'highcharts-react-official are installed into your repo, any prop or functionality provided by Highcharts can be used with this kit without requiring specific props from Playbook. The doc examples below showcase a few common usecases but are not a comprehensive list of all the functionalities possible.
2
4
 
3
5
  See the [highcharts API docs](https://api.highcharts.com/highcharts/) for a comprehensive look at what is possible.
@@ -1,6 +1,6 @@
1
1
  import React from 'react'
2
2
  import PbLineGraph from '../../pb_pb_line_graph/_pb_line_graph'
3
- import { colors } from 'playbook-ui'
3
+ import colors from '../../tokens/exports/_colors.module.scss'
4
4
 
5
5
  const data = [{
6
6
  name: 'Installation',
@@ -0,0 +1 @@
1
+ In order to use this kit, 'highcharts' and 'highcharts-react-official' must be installed in your repo.
@@ -37,7 +37,7 @@
37
37
  },
38
38
  } %>
39
39
 
40
- <%= pb_rails("title", props: {size: 4, text: "align | vertical_align", padding_top: "sm", padding_bottom: "sm"})%>
40
+ <%= pb_rails("title", props: {size: 4, text: "align | verticalAlign", padding_top: "sm", padding_bottom: "sm"})%>
41
41
  <%= pb_rails("pb_line_graph", props: {options: chartOptionsFirst}) %>
42
42
 
43
43
  <% chartOptionsSecond = {
@@ -1,5 +1,8 @@
1
1
  import React, { useState } from "react";
2
- import { PbReactPopover, CircleIconButton, Body, Flex } from "playbook-ui";
2
+ import PbReactPopover from "../_popover";
3
+ import Body from "../../pb_body/_body";
4
+ import Flex from "../../pb_flex/_flex";
5
+ import CircleIconButton from "../../pb_circle_icon_button/_circle_icon_button";
3
6
 
4
7
  const PopoverAppendTo = (props) => {
5
8
  const [showParentPopover, setShowParentPopover] = useState(false);
@@ -1,5 +1 @@
1
- Progress step kit is used to show the progress of a process. There are three types of steps in this kit: completed, active, and inactive. Completed steps are indicated by a solid, blue circle (with or without an icon). The current, or active, step is indicated by an outlined blue circle. The inactive, or future, step is indicated by a solid gray circle.
2
-
3
- **Tracker**
4
- You must set the icon prop to true for this kit.
5
- This variant takes children just like the default progress step. It is best to use the caption kit for children in this variant.
1
+ Progress Step kit is used to show the progress of a process. There are three types of steps in this kit: completed, active, and inactive. Completed steps are indicated by a solid, blue circle (with or without an icon). The current, or active, step is indicated by an outlined blue circle. The inactive, or future, step is indicated by a solid gray circle.
@@ -0,0 +1,14 @@
1
+ <br><br>
2
+ <%= pb_rails("progress_step",props:{ variant:"tracker", icon:true, color: "info"}) do %>
3
+ <%= pb_rails("progress_step/progress_step_item", props: {status: "complete"}) do %>
4
+ <%= pb_rails("caption", props:{text: "Ordered"})%>
5
+ <% end %>
6
+ <%= pb_rails("progress_step/progress_step_item", props: {status: "active"}) do %>
7
+ <%= pb_rails("caption", props:{text: "Shipped"})%>
8
+ <% end %>
9
+ <%= pb_rails("progress_step/progress_step_item", props: {status: "inactive"}) do %>
10
+ <%= pb_rails("caption", props:{text: "Delivered"})%>
11
+ <% end %>
12
+ <% end %>
13
+
14
+ <br>
@@ -0,0 +1,29 @@
1
+ import React from 'react'
2
+
3
+ import ProgressStep from '../_progress_step.tsx'
4
+ import ProgressStepItem from '../_progress_step_item.tsx'
5
+ import Caption from '../../pb_caption/_caption'
6
+
7
+ const ProgressStepColor = (props) => (
8
+ <div>
9
+ <br />
10
+ <ProgressStep
11
+ color="info"
12
+ icon
13
+ variant="tracker"
14
+ {...props}
15
+ >
16
+ <ProgressStepItem status="complete">
17
+ <Caption>{'Ordered'}</Caption>
18
+ </ProgressStepItem>
19
+ <ProgressStepItem status="active">
20
+ <Caption>{'Shipped'}</Caption>
21
+ </ProgressStepItem>
22
+ <ProgressStepItem status="inactive">
23
+ <Caption>{'Delivered'}</Caption>
24
+ </ProgressStepItem>
25
+ </ProgressStep>
26
+ </div>
27
+ )
28
+
29
+ export default ProgressStepColor
@@ -0,0 +1,3 @@
1
+ The `color` prop can also be used to set color for the tracker variant. Options for color are `primary` and `info` with default being set to `primary`.
2
+
3
+ **NOTE**: The `color` prop is only available with the `tracker` variant.
@@ -0,0 +1,31 @@
1
+ import React from 'react'
2
+
3
+ import ProgressStep from '../_progress_step.tsx'
4
+ import ProgressStepItem from '../_progress_step_item.tsx'
5
+ import Caption from '../../pb_caption/_caption'
6
+
7
+ const ProgressStepCustomIcon = (props) => (
8
+ <div>
9
+ <br />
10
+ <ProgressStep
11
+ icon
12
+ variant="tracker"
13
+ {...props}
14
+ >
15
+ <ProgressStepItem status="complete">
16
+ <Caption>{'Ordered'}</Caption>
17
+ </ProgressStepItem>
18
+ <ProgressStepItem
19
+ icon="exclamation-triangle"
20
+ status="active"
21
+ >
22
+ <Caption>{'Shipped'}</Caption>
23
+ </ProgressStepItem>
24
+ <ProgressStepItem status="inactive">
25
+ <Caption>{'Delivered'}</Caption>
26
+ </ProgressStepItem>
27
+ </ProgressStep>
28
+ </div>
29
+ )
30
+
31
+ export default ProgressStepCustomIcon
@@ -0,0 +1 @@
1
+ Custom icons can also be set for individual steps. Simply use the `icon` prop for the relevant `ProgressStepItem`/`progress_step_item` as shown here.
@@ -39,7 +39,10 @@
39
39
  <%= pb_rails("progress_step/progress_step_item", props: {status: "complete"}) do %>
40
40
  step 2
41
41
  <% end %>
42
- <%= pb_rails("progress_step/progress_step_item", props: {status: "complete"}) do %>
42
+ <%= pb_rails("progress_step/progress_step_item", props: {status: "active"}) do %>
43
43
  step 3
44
+ <% end %>
45
+ <%= pb_rails("progress_step/progress_step_item", props: {status: "inactive"}) do %>
46
+ step 4
44
47
  <% end %>
45
48
  <% end %>
@@ -6,7 +6,6 @@ import ProgressStepItem from '../_progress_step_item.tsx'
6
6
  const ProgressStepDefault = (props) => (
7
7
  <div>
8
8
  <ProgressStep
9
- icon
10
9
  {...props}
11
10
  >
12
11
  <ProgressStepItem status="complete" />
@@ -19,12 +18,24 @@ const ProgressStepDefault = (props) => (
19
18
 
20
19
  <ProgressStep {...props}>
21
20
  <ProgressStepItem status="complete">{'Step 1'}</ProgressStepItem>
22
- <ProgressStepItem status="active">{'Step 2'}</ProgressStepItem>
23
- <ProgressStepItem status="inactive">{'Step 3'}</ProgressStepItem>
21
+ <ProgressStepItem status="complete">{'Step 2'}</ProgressStepItem>
22
+ <ProgressStepItem status="active">{'Step 3'}</ProgressStepItem>
23
+ <ProgressStepItem status="inactive">{'Step 4'}</ProgressStepItem>
24
+ <ProgressStepItem status="inactive">{'Step 5'}</ProgressStepItem>
24
25
  </ProgressStep>
25
26
 
26
27
  <br />
27
28
  <br />
29
+
30
+ <ProgressStep
31
+ icon
32
+ {...props}
33
+ >
34
+ <ProgressStepItem status="complete">{'Step 1'}</ProgressStepItem>
35
+ <ProgressStepItem status="complete">{'Step 2'}</ProgressStepItem>
36
+ <ProgressStepItem status="active">{'Step 3'}</ProgressStepItem>
37
+ <ProgressStepItem status="inactive">{'Step 4'}</ProgressStepItem>
38
+ </ProgressStep>
28
39
  </div>
29
40
  )
30
41
 
@@ -0,0 +1,3 @@
1
+ The default Progress Step kit sets orientation to horizontal and can be used with completed, active, and inactive steps as shown here.
2
+
3
+ `icon` is a boolean prop that can also be set to true to render icons within the steps indicator. `icon` is false by default.
@@ -0,0 +1,3 @@
1
+ The `variant` prop can be set to `tracker` to achieve this UI. Tracker is only available with the horizontal orientation and it is also recommended that you set the `icon` prop to true for this variant.
2
+
3
+ This variant takes children just like the default progress step, however, it is best to use the caption kit for children in this variant.
@@ -25,13 +25,7 @@
25
25
  Child
26
26
  <% end %>
27
27
  <%= pb_rails("progress_step/progress_step_item", props: {status: "active"}) do %>
28
- <%= pb_rails("card", props: {highlight: {position: "side", color:"windows"}}) do %>
29
- Card content
30
- <% end %>
31
- <br>
32
- <%= pb_rails("card", props: {highlight: {position: "side", color:"windows"}}) do %>
33
- Card content
34
- <% end %>
28
+ Child
35
29
  <% end %>
36
30
  <%= pb_rails("progress_step/progress_step_item", props: {status: "inactive"}) do %>
37
31
  Child
@@ -0,0 +1 @@
1
+ `orientation` can also be set to `vertical` as shown here. By default, this is set to `horizontal`.
@@ -3,6 +3,7 @@ examples:
3
3
  - progress_step_default: Default
4
4
  - progress_step_vertical: Vertical
5
5
  - progress_step_tracker: Tracker
6
+ - progress_step_color: Color
6
7
  - progress_step_custom_icon: Custom Icon
7
8
  - progress_step_tooltip: Tooltip
8
9
 
@@ -10,4 +11,6 @@ examples:
10
11
  - progress_step_default: Default
11
12
  - progress_step_vertical: Vertical
12
13
  - progress_step_tracker: Tracker
14
+ - progress_step_color: Color
15
+ - progress_step_custom_icon: Custom Icon
13
16
  - progress_step_tracker_click_events: Using State
@@ -2,3 +2,5 @@ export { default as ProgressStepDefault } from './_progress_step_default.jsx'
2
2
  export { default as ProgressStepVertical } from './_progress_step_vertical.jsx'
3
3
  export { default as ProgressStepTracker } from './_progress_step_tracker.jsx'
4
4
  export { default as ProgressStepTrackerClickEvents } from './_progress_step_tracker_click_events.jsx'
5
+ export { default as ProgressStepColor } from './_progress_step_color.jsx'
6
+ export { default as ProgressStepCustomIcon } from './_progress_step_custom_icon.jsx'
@@ -1,6 +1,8 @@
1
1
  import React from "react"
2
2
  import { useForm } from "react-hook-form"
3
- import { Radio, Flex, Body } from "playbook-ui"
3
+ import Radio from "../_radio"
4
+ import Body from "../../pb_body/_body"
5
+ import Flex from "../../pb_flex/_flex"
4
6
 
5
7
  const RadioReactHook = () => {
6
8
  const { register, watch } = useForm({
@@ -1,6 +1,8 @@
1
1
  import React, { useState } from "react"
2
2
  import { useForm } from "react-hook-form"
3
- import { Button, Body, Select } from "playbook-ui"
3
+ import Select from "../_select"
4
+ import Body from "../../pb_body/_body"
5
+ import Button from "../../pb_button/_button"
4
6
 
5
7
  const SelectReactHook = (props) => {
6
8
  const { register, handleSubmit, formState: { errors } } = useForm({
@@ -1,5 +1,8 @@
1
1
  import React from 'react'
2
- import { Button, Tooltip, Flex, FlexItem } from 'playbook-ui';
2
+ import Tooltip from '../_tooltip'
3
+ import Button from '../../pb_button/_button'
4
+ import Flex from '../../pb_flex/_flex'
5
+ import FlexItem from '../../pb_flex/_flex_item'
3
6
 
4
7
  const TooltipSizing = (props) => {
5
8
 
@@ -1,6 +1,7 @@
1
1
  import React from 'react'
2
2
 
3
- import { Typeahead, Title } from 'playbook-ui'
3
+ import Typeahead from '../_typeahead'
4
+ import Title from '../../pb_title/_title'
4
5
  import { useForm } from 'react-hook-form'
5
6
 
6
7
  const languages = [
@@ -1,5 +1,5 @@
1
1
  import React from 'react'
2
- import { User } from 'playbook-ui'
2
+ import User from '../../pb_user/_user'
3
3
 
4
4
  const UserFontOptions = (props) => {
5
5
  return (