playbook_ui_docs 13.11.0 → 13.11.1.pre.alpha.play900startratingasinput1530

Sign up to get free protection for your applications and to get access to all the features.
Files changed (54) hide show
  1. checksums.yaml +4 -4
  2. data/app/pb_kits/playbook/pb_collapsible/docs/_collapsible_external_controls.html.erb +22 -0
  3. data/app/pb_kits/playbook/pb_collapsible/docs/_collapsible_external_controls.md +3 -0
  4. data/app/pb_kits/playbook/pb_collapsible/docs/_collapsible_external_controls_multiple.html.erb +40 -0
  5. data/app/pb_kits/playbook/pb_collapsible/docs/_collapsible_external_controls_multiple.md +1 -0
  6. data/app/pb_kits/playbook/pb_collapsible/docs/example.yml +2 -0
  7. data/app/pb_kits/playbook/pb_icon/docs/_icon_border_swift.md +7 -0
  8. data/app/pb_kits/playbook/pb_icon/docs/_icon_default_swift.md +7 -0
  9. data/app/pb_kits/playbook/pb_icon/docs/_icon_flip_swift.md +11 -0
  10. data/app/pb_kits/playbook/pb_icon/docs/_icon_props_swift.md +8 -0
  11. data/app/pb_kits/playbook/pb_icon/docs/_icon_rotate_swift.md +11 -0
  12. data/app/pb_kits/playbook/pb_icon/docs/_icon_sizes_swift.md +46 -0
  13. data/app/pb_kits/playbook/pb_icon/docs/example.yml +8 -0
  14. data/app/pb_kits/playbook/pb_image/docs/_image_props_swift.md +7 -0
  15. data/app/pb_kits/playbook/pb_image/docs/_rounded_image_swift.md +47 -0
  16. data/app/pb_kits/playbook/pb_image/docs/_size_image_swift.md +47 -0
  17. data/app/pb_kits/playbook/pb_image/docs/_size_none_image_swift.md +15 -0
  18. data/app/pb_kits/playbook/pb_image/docs/example.yml +5 -0
  19. data/app/pb_kits/playbook/pb_label_value/docs/_label_value_default_swift.md +11 -0
  20. data/app/pb_kits/playbook/pb_label_value/docs/_label_value_details_examples_swift.md +72 -0
  21. data/app/pb_kits/playbook/pb_label_value/docs/_label_value_details_swift.md +41 -0
  22. data/app/pb_kits/playbook/pb_label_value/docs/_label_value_props_swift.md +11 -0
  23. data/app/pb_kits/playbook/pb_label_value/docs/example.yml +6 -0
  24. data/app/pb_kits/playbook/pb_message/docs/_message_default_swift.md +57 -0
  25. data/app/pb_kits/playbook/pb_message/docs/_message_props_swift.md +12 -0
  26. data/app/pb_kits/playbook/pb_message/docs/example.yml +4 -0
  27. data/app/pb_kits/playbook/pb_star_rating/docs/_star_rating_color_options.html.erb +7 -0
  28. data/app/pb_kits/playbook/pb_star_rating/docs/_star_rating_color_options.jsx +40 -0
  29. data/app/pb_kits/playbook/pb_star_rating/docs/_star_rating_default.html.erb +11 -1
  30. data/app/pb_kits/playbook/pb_star_rating/docs/_star_rating_default.jsx +17 -2
  31. data/app/pb_kits/playbook/pb_star_rating/docs/_star_rating_hide.html.erb +6 -1
  32. data/app/pb_kits/playbook/pb_star_rating/docs/_star_rating_hide.jsx +22 -5
  33. data/app/pb_kits/playbook/pb_star_rating/docs/_star_rating_number_config.html.erb +12 -0
  34. data/app/pb_kits/playbook/pb_star_rating/docs/_star_rating_number_config.jsx +57 -0
  35. data/app/pb_kits/playbook/pb_star_rating/docs/_star_rating_size_options.html.erb +23 -0
  36. data/app/pb_kits/playbook/pb_star_rating/docs/_star_rating_size_options.jsx +59 -0
  37. data/app/pb_kits/playbook/pb_star_rating/docs/example.yml +10 -5
  38. data/app/pb_kits/playbook/pb_star_rating/docs/index.js +6 -0
  39. data/app/pb_kits/playbook/pb_table/docs/_table_header.html.erb +4 -4
  40. data/app/pb_kits/playbook/pb_tooltip/docs/_tooltip_default.html.erb +1 -1
  41. data/app/pb_kits/playbook/pb_tooltip/docs/_tooltip_default_react.jsx +0 -2
  42. data/app/pb_kits/playbook/pb_tooltip/docs/_tooltip_delay.jsx +0 -1
  43. data/app/pb_kits/playbook/pb_tooltip/docs/_tooltip_interaction.jsx +0 -1
  44. data/app/pb_kits/playbook/pb_tooltip/docs/_tooltip_margin.jsx +0 -1
  45. data/app/pb_kits/playbook/pb_tooltip/docs/_tooltip_selectors.html.erb +1 -1
  46. data/app/pb_kits/playbook/pb_tooltip/docs/_tooltip_show_tooltip.html.erb +39 -0
  47. data/app/pb_kits/playbook/pb_tooltip/docs/_tooltip_show_tooltip.md +5 -0
  48. data/app/pb_kits/playbook/pb_tooltip/docs/_tooltip_show_tooltip_react.jsx +45 -0
  49. data/app/pb_kits/playbook/pb_tooltip/docs/_tooltip_show_tooltip_react.md +3 -0
  50. data/app/pb_kits/playbook/pb_tooltip/docs/example.yml +3 -0
  51. data/app/pb_kits/playbook/pb_tooltip/docs/index.js +1 -0
  52. data/dist/playbook-doc.js +8 -8
  53. metadata +37 -8
  54. data/app/pb_kits/playbook/pb_dawg/docs/example.yml +0 -9
@@ -4,12 +4,12 @@ import StarRating from '../_star_rating'
4
4
 
5
5
  const StarRatingDefault = (props) => (
6
6
  <>
7
- <StarRating />
7
+ <StarRating {...props} />
8
8
 
9
9
  <br />
10
10
 
11
11
  <StarRating
12
- rating={3}
12
+ rating={0.9}
13
13
  {...props}
14
14
  />
15
15
 
@@ -20,6 +20,21 @@ const StarRatingDefault = (props) => (
20
20
  {...props}
21
21
  />
22
22
 
23
+ <br />
24
+
25
+ <StarRating
26
+ rating={3}
27
+ {...props}
28
+ />
29
+
30
+ <br />
31
+
32
+ <StarRating
33
+ rating={4.2}
34
+ {...props}
35
+ />
36
+
37
+
23
38
  <br />
24
39
 
25
40
  <StarRating
@@ -1 +1,6 @@
1
- <%= pb_rails("star_rating", props: { rating: 3.5, hide_rating: true }) %>
1
+ <%= pb_rails("star_rating", props: { rating: 3 }) %>
2
+ </br>
3
+ <%= pb_rails("star_rating", props: { rating: 3, layout_option: "number" }) %>
4
+ </br>
5
+ <%= pb_rails("star_rating", props: { rating: 3, layout_option: "onestar" }) %>
6
+ </br>
@@ -3,13 +3,30 @@ import React from 'react'
3
3
  import StarRating from '../_star_rating'
4
4
 
5
5
  const StarRatingHide = (props) => (
6
+ <>
6
7
 
7
- <StarRating
8
- hideRating
9
- rating={3.5}
10
- {...props}
11
- />
8
+ <StarRating
9
+ rating={3}
10
+ {...props}
11
+ />
12
12
 
13
+ <br />
14
+
15
+ <StarRating
16
+ layoutOption={"number"}
17
+ rating={3}
18
+ {...props}
19
+ />
20
+
21
+ <br />
22
+
23
+ <StarRating
24
+ layoutOption={"onestar"}
25
+ rating={3}
26
+ {...props}
27
+ />
28
+
29
+ </>
13
30
  )
14
31
 
15
32
  export default StarRatingHide
@@ -0,0 +1,12 @@
1
+ <%= pb_rails("star_rating", props: { rating: 3, denominator: 3 }) %>
2
+ </br>
3
+ <%= pb_rails("star_rating", props: { rating: 3, denominator: 4 }) %>
4
+ </br>
5
+ <%= pb_rails("star_rating", props: { rating: 3 }) %>
6
+ </br>
7
+ <%= pb_rails("star_rating", props: { rating: 3, denominator: 6 }) %>
8
+ </br>
9
+ <%= pb_rails("star_rating", props: { rating: 3, denominator: 7 }) %>
10
+ </br>
11
+ <%= pb_rails("star_rating", props: { rating: 3, denominator: 8 }) %>
12
+ </br>
@@ -0,0 +1,57 @@
1
+ import React from 'react'
2
+
3
+ import StarRating from '../_star_rating'
4
+
5
+ const StarRatingNumberConfig = (props) => (
6
+ <>
7
+
8
+ <StarRating
9
+ denominator={3}
10
+ rating={3}
11
+ {...props}
12
+ />
13
+
14
+ <br />
15
+
16
+ <StarRating
17
+ denominator={4}
18
+ rating={3}
19
+ {...props}
20
+ />
21
+
22
+ <br />
23
+
24
+ <StarRating
25
+ denominator={5}
26
+ rating={3}
27
+ {...props}
28
+ />
29
+
30
+ <br />
31
+
32
+ <StarRating
33
+ denominator={6}
34
+ rating={3}
35
+ {...props}
36
+ />
37
+
38
+ <br />
39
+
40
+ <StarRating
41
+ denominator={7}
42
+ rating={3}
43
+ {...props}
44
+ />
45
+
46
+ <br />
47
+
48
+ <StarRating
49
+ denominator={8}
50
+ rating={3}
51
+ {...props}
52
+ />
53
+
54
+ </>
55
+ )
56
+
57
+ export default StarRatingNumberConfig
@@ -0,0 +1,23 @@
1
+ <%= pb_rails("star_rating", props: { rating: 3, size: "xs" }) %>
2
+
3
+ <br>
4
+
5
+ <%= pb_rails("star_rating", props: { rating: 3, size: "sm" }) %>
6
+
7
+ <br>
8
+
9
+ <%= pb_rails("star_rating", props: { rating: 3, size: "md" }) %>
10
+
11
+ <br>
12
+
13
+ <%= pb_rails("star_rating", props: { rating: 3, size: "lg" }) %>
14
+
15
+ <br>
16
+
17
+ <%= pb_rails("star_rating", props: { rating: 3, size: "lg", layout_option: "number" }) %>
18
+
19
+ <br>
20
+
21
+ <%= pb_rails("star_rating", props: { rating: 3, size: "lg", layout_option: "onestar" }) %>
22
+
23
+ <br>
@@ -0,0 +1,59 @@
1
+ import React from 'react'
2
+
3
+ import StarRating from '../_star_rating'
4
+
5
+ const StarRatingSizeOptions = (props) => (
6
+ <>
7
+
8
+ <StarRating
9
+ rating={3}
10
+ size="xs"
11
+ {...props}
12
+ />
13
+
14
+ <br />
15
+
16
+ <StarRating
17
+ rating={3}
18
+ size="sm"
19
+ {...props}
20
+ />
21
+
22
+ <br />
23
+
24
+ <StarRating
25
+ rating={3}
26
+ size="md"
27
+ {...props}
28
+ />
29
+
30
+ <br />
31
+
32
+ <StarRating
33
+ rating={3}
34
+ size="lg"
35
+ {...props}
36
+ />
37
+
38
+ <br />
39
+
40
+ <StarRating
41
+ layoutOption="number"
42
+ rating={3}
43
+ size="lg"
44
+ {...props}
45
+ />
46
+
47
+ <br />
48
+
49
+ <StarRating
50
+ layoutOption="onestar"
51
+ rating={3}
52
+ size="lg"
53
+ {...props}
54
+ />
55
+
56
+ </>
57
+ )
58
+
59
+ export default StarRatingSizeOptions
@@ -1,9 +1,14 @@
1
1
  examples:
2
-
3
2
  rails:
4
- - star_rating_default: Default
5
- - star_rating_hide: Hide Rating Value
3
+ - star_rating_default: Default
4
+ - star_rating_color_options: Color Options
5
+ - star_rating_hide: Layout Options
6
+ - star_rating_number_config: Number Config
7
+ - star_rating_size_options: Size Options
6
8
 
7
9
  react:
8
- - star_rating_default: Default
9
- - star_rating_hide: Hide Rating Value
10
+ - star_rating_default: Default
11
+ - star_rating_color_options: Color Options
12
+ - star_rating_hide: Layout Options
13
+ - star_rating_number_config: Number Config
14
+ - star_rating_size_options: Size Options
@@ -1,3 +1,9 @@
1
1
  export { default as StarRatingDefault } from './_star_rating_default.jsx'
2
2
 
3
+ export { default as StarRatingColorOptions } from './_star_rating_color_options.jsx'
4
+
3
5
  export { default as StarRatingHide } from './_star_rating_hide.jsx'
6
+
7
+ export { default as StarRatingNumberConfig } from './_star_rating_number_config.jsx'
8
+
9
+ export { default as StarRatingSizeOptions } from './_star_rating_size_options.jsx'
@@ -39,10 +39,10 @@
39
39
  text: "Full Name",
40
40
  colspan: 2,
41
41
  sort_menu: [
42
- { item: "First Name Descending", link: "?sort=firstname_desc#table-header", active: params["sort"] == "firstname_desc", direction: "desc" },
43
- { item: "First Name Ascending", link: "?sort=firstname_asc#table-header", active: params["sort"] == "firstname_asc", direction: "asc" },
44
- { item: "Last Name Descending", link: "?sort=lastname_desc#table-header", active: params["sort"] == "lastname_desc", direction: "desc" },
45
- { item: "Last Name Ascending", link: "?sort=lastname_asc#table-header", active: params["sort"] == "lastname_asc", direction: "asc" }
42
+ { item: "First Name", link: "?sort=firstname_desc#table-header", active: params["sort"] == "firstname_desc", direction: "desc" },
43
+ { item: "First Name", link: "?sort=firstname_asc#table-header", active: params["sort"] == "firstname_asc", direction: "asc" },
44
+ { item: "Last Name", link: "?sort=lastname_desc#table-header", active: params["sort"] == "lastname_desc", direction: "desc" },
45
+ { item: "Last Name", link: "?sort=lastname_asc#table-header", active: params["sort"] == "lastname_asc", direction: "asc" }
46
46
  ],
47
47
  }) %>
48
48
  <%= pb_rails("table/table_header", props: {
@@ -1,4 +1,4 @@
1
- <%= pb_rails("flex", props: { gap: "md", justify: "center", wrap: true }) do %>
1
+ <%= pb_rails("flex", props: { gap: "md", wrap: true }) do %>
2
2
  <%= pb_rails("flex/flex_item") do %>
3
3
  <span id='regular-tooltip-1'>Hover here (Top)</span>
4
4
 
@@ -9,12 +9,10 @@ const TooltipDefaultReact = (props) => {
9
9
  <Flex
10
10
  flexDirection='row'
11
11
  gap='md'
12
- justifyContent='center'
13
12
  wrap
14
13
  >
15
14
  <FlexItem>
16
15
  <Tooltip
17
- className={"customClassNameHere"}
18
16
  placement='top'
19
17
  text="Whoa. I'm a Tooltip"
20
18
  zIndex={10}
@@ -9,7 +9,6 @@ const TooltipDelay = (props) => {
9
9
  <Flex
10
10
  flexDirection='row'
11
11
  gap='md'
12
- justifyContent='center'
13
12
  wrap
14
13
  >
15
14
  <FlexItem>
@@ -9,7 +9,6 @@ const TooltipInteraction = (props) => {
9
9
  <Flex
10
10
  flexDirection='row'
11
11
  gap='md'
12
- justifyContent='center'
13
12
  wrap
14
13
  >
15
14
  <FlexItem>
@@ -7,7 +7,6 @@ const TooltipMargin = (props) => {
7
7
  return (
8
8
  <Flex
9
9
  flexDirection='row'
10
- justifyContent='center'
11
10
  wrap
12
11
  >
13
12
  <Tooltip
@@ -1,4 +1,4 @@
1
- <%= pb_rails("flex", props: { horizontal: "center", orientation: "column" }) do %>
1
+ <%= pb_rails("flex", props: { orientation: "column" }) do %>
2
2
  <%= pb_rails("flex/flex_item", props: {margin_top: "md"}) do %>
3
3
  <%= pb_rails("button", props: {classname: "tooltip-example-trigger", text: "Example 1"}) %>
4
4
  <% end %>
@@ -0,0 +1,39 @@
1
+
2
+ <%= pb_rails("flex", props: { orientation: "column", gap: "md" }) do %>
3
+ <%= pb_rails("button", props: {text: "Toggle state", id: "toggle-tooltip-button"}) %>
4
+ <%= pb_rails("body") do %>
5
+ Tooltip is: <code id="show-tooltip-state">enabled</code>
6
+ <% end %>
7
+ <%= pb_rails("flex/flex_item") do %>
8
+ <span id="truncated-tooltip-1">Hover me</span>
9
+ <%= pb_rails("tooltip", props: {
10
+ trigger_element_selector: "#truncated-tooltip-1",
11
+ tooltip_id: "truncated-1",
12
+ position: "right",
13
+ }) do %>
14
+ Tooltip is enabled
15
+ <% end %>
16
+ <% end %>
17
+ <% end %>
18
+
19
+
20
+ <script>
21
+ const toggleTooltipButton = document.getElementById("toggle-tooltip-button");
22
+ const showTooltipStateText = document.getElementById("show-tooltip-state");
23
+
24
+ function hideTooltipIfNotTruncated(tooltipId) {
25
+ const tooltipElement = document.querySelector(
26
+ `[data-pb-tooltip-tooltip-id="${tooltipId}"]`
27
+ );
28
+
29
+ tooltipElement.dataset.pbTooltipShowTooltip =
30
+ tooltipElement.dataset.pbTooltipShowTooltip == "false" ? "true" : "false";
31
+
32
+ showTooltipStateText.innerText =
33
+ tooltipElement.dataset.pbTooltipShowTooltip == "false" ? "disabled" : "enabled";
34
+ }
35
+
36
+ toggleTooltipButton.addEventListener("click", () => {
37
+ hideTooltipIfNotTruncated("truncated-1");
38
+ });
39
+ </script>
@@ -0,0 +1,5 @@
1
+ You can build your own logic to control whether to show or hide the tooltip.
2
+
3
+ Click on the `Toggle state` button to change the state of the component and hover over the 'hover me' text to see it in action.
4
+
5
+ Each Tooltip has a `dataset` with the `pbTooltipShowTooltip` property set to true by default. To update it, access the `pbTooltipShowTooltip` in the dataset of your tooltip element: `yourTooltip.dataset.pbTooltipShowTooltip = 'false'`
@@ -0,0 +1,45 @@
1
+ // @flow
2
+
3
+ import React, { useState } from 'react'
4
+ import { Button, Body, Flex, FlexItem, Tooltip } from '../..'
5
+
6
+ const TooltipShowTooltipReact = (props) => {
7
+ const [showTooltip, setShowTooltip] = useState(true);
8
+
9
+ return (
10
+ <Flex
11
+ flexDirection='column'
12
+ gap='md'
13
+ wrap
14
+ >
15
+ <FlexItem>
16
+ <Button
17
+ onClick={()=> setShowTooltip(!showTooltip)}
18
+ text="Toggle state"
19
+ />
20
+ </FlexItem>
21
+ <FlexItem>
22
+ <Body >
23
+ <p>
24
+ {'Tooltip is: '}
25
+ <code>{showTooltip ? "enabled" : "disabled"}</code>
26
+ </p>
27
+ </Body>
28
+ </FlexItem>
29
+ <FlexItem>
30
+ <Tooltip
31
+ placement='right'
32
+ showTooltip={showTooltip}
33
+ text='Tooltip is enabled'
34
+ zIndex={10}
35
+ {...props}
36
+ >
37
+ {'Hover me.'}
38
+ </Tooltip>
39
+ </FlexItem>
40
+
41
+ </Flex>
42
+ )
43
+ }
44
+
45
+ export default TooltipShowTooltipReact
@@ -0,0 +1,3 @@
1
+ You can build your own logic to control whether to show the tooltip using the `showTooltip` prop. Its default value is `true`.
2
+
3
+ Click on the `Toggle state` button to change the state of the component and hover over the 'hover me' text to see it in action.
@@ -4,6 +4,7 @@ examples:
4
4
  - tooltip_default: Default
5
5
  - tooltip_selectors: Using Common Selectors
6
6
  - tooltip_with_icon_circle: Icon Circle Tooltip
7
+ - tooltip_show_tooltip: Show Tooltip
7
8
 
8
9
  react:
9
10
  - tooltip_default_react: Default
@@ -11,3 +12,5 @@ examples:
11
12
  - tooltip_margin: Margin
12
13
  - tooltip_icon: Tooltip with Icon
13
14
  - tooltip_delay: Delay
15
+ - tooltip_show_tooltip_react: Show Tooltip
16
+
@@ -3,3 +3,4 @@ export { default as TooltipInteraction } from './_tooltip_interaction'
3
3
  export { default as TooltipMargin } from './_tooltip_margin'
4
4
  export { default as TooltipIcon } from './_tooltip_icon'
5
5
  export { default as TooltipDelay } from './_tooltip_delay'
6
+ export { default as TooltipShowTooltipReact } from './_tooltip_show_tooltip_react'