playbook_ui_docs 13.27.0.pre.alpha.testingcollapsible2917 → 13.27.0
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.
- checksums.yaml +4 -4
- data/app/pb_kits/playbook/pb_avatar/docs/_avatar_badge_component_overlay.html.erb +66 -46
- data/app/pb_kits/playbook/pb_avatar/docs/_avatar_badge_component_overlay.jsx +29 -8
- data/app/pb_kits/playbook/pb_avatar/docs/_avatar_circle_icon_component_overlay.html.erb +33 -13
- data/app/pb_kits/playbook/pb_avatar/docs/_avatar_circle_icon_component_overlay.jsx +67 -48
- data/app/pb_kits/playbook/pb_avatar/docs/_avatar_default.jsx +20 -0
- data/app/pb_kits/playbook/pb_avatar/docs/example.yml +2 -2
- data/app/pb_kits/playbook/pb_card/docs/_card_background.html.erb +0 -20
- data/app/pb_kits/playbook/pb_card/docs/_card_background.jsx +1 -41
- data/app/pb_kits/playbook/pb_card/docs/_card_background.md +1 -1
- data/app/pb_kits/playbook/pb_card/docs/_card_header.html.erb +1 -1
- data/app/pb_kits/playbook/pb_card/docs/_card_header.md +1 -1
- data/app/pb_kits/playbook/pb_card/docs/_card_highlight.md +1 -1
- data/app/pb_kits/playbook/pb_collapsible/docs/example.yml +0 -3
- data/app/pb_kits/playbook/pb_collapsible/docs/index.js +1 -2
- data/app/pb_kits/playbook/pb_dropdown/docs/_dropdown_default.html.erb +3 -3
- data/app/pb_kits/playbook/pb_dropdown/docs/_dropdown_default.md +1 -1
- data/app/pb_kits/playbook/pb_dropdown/docs/{_dropdown_subcomponent_structure_rails.html.erb → _dropdown_subcomponent_structure.html.erb} +3 -3
- data/app/pb_kits/playbook/pb_dropdown/docs/_dropdown_subcomponent_structure.md +6 -5
- data/app/pb_kits/playbook/pb_dropdown/docs/_dropdown_with_custom_display.md +3 -3
- data/app/pb_kits/playbook/pb_dropdown/docs/{_dropdown_with_custom_options_rails.html.erb → _dropdown_with_custom_options.html.erb} +3 -3
- data/app/pb_kits/playbook/pb_dropdown/docs/_dropdown_with_custom_options.md +1 -1
- data/app/pb_kits/playbook/pb_dropdown/docs/_dropdown_with_custom_padding.html.erb +3 -3
- data/app/pb_kits/playbook/pb_dropdown/docs/_dropdown_with_custom_padding.md +1 -1
- data/app/pb_kits/playbook/pb_dropdown/docs/{_dropdown_with_custom_trigger_rails.html.erb → _dropdown_with_custom_trigger.html.erb} +3 -3
- data/app/pb_kits/playbook/pb_dropdown/docs/_dropdown_with_custom_trigger.md +1 -1
- data/app/pb_kits/playbook/pb_dropdown/docs/_dropdown_with_label.html.erb +3 -3
- data/app/pb_kits/playbook/pb_dropdown/docs/_dropdown_with_label.md +1 -1
- data/app/pb_kits/playbook/pb_dropdown/docs/example.yml +6 -6
- data/dist/app/components/playbook/pb_docs/kit_example.html.erb +3 -3
- data/dist/menu.yml +2 -2
- data/dist/playbook-doc.js +9 -9
- metadata +9 -19
- data/app/pb_kits/playbook/pb_avatar/docs/_avatar_badge_component_overlay.md +0 -3
- data/app/pb_kits/playbook/pb_avatar/docs/_avatar_circle_icon_component_overlay.md +0 -3
- data/app/pb_kits/playbook/pb_collapsible/docs/_collapsible_custom_main.jsx +0 -73
- data/app/pb_kits/playbook/pb_collapsible/docs/_collapsible_custom_main.md +0 -5
- data/app/pb_kits/playbook/pb_collapsible/docs/_collapsible_custom_main_rails.html.erb +0 -20
- data/app/pb_kits/playbook/pb_collapsible/docs/_collapsible_custom_main_rails.md +0 -5
- data/app/pb_kits/playbook/pb_dropdown/docs/_dropdown_subcomponent_structure_rails.md +0 -6
- data/app/pb_kits/playbook/pb_dropdown/docs/_dropdown_with_custom_display_rails.md +0 -5
- data/app/pb_kits/playbook/pb_dropdown/docs/_dropdown_with_custom_options_rails.md +0 -1
- data/app/pb_kits/playbook/pb_dropdown/docs/_dropdown_with_custom_trigger_rails.md +0 -1
- /data/app/pb_kits/playbook/pb_dropdown/docs/{_dropdown_with_custom_display_rails.html.erb → _dropdown_with_custom_display.html.erb} +0 -0
metadata
CHANGED
@@ -1,15 +1,15 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: playbook_ui_docs
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 13.27.0
|
4
|
+
version: 13.27.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Power UX
|
8
8
|
- Power Devs
|
9
|
-
autorequire:
|
9
|
+
autorequire:
|
10
10
|
bindir: bin
|
11
11
|
cert_chain: []
|
12
|
-
date: 2024-05-
|
12
|
+
date: 2024-05-06 00:00:00.000000000 Z
|
13
13
|
dependencies:
|
14
14
|
- !ruby/object:Gem::Dependency
|
15
15
|
name: playbook_ui
|
@@ -61,10 +61,8 @@ files:
|
|
61
61
|
- app/pb_kits/playbook/pb_advanced_table/docs/index.js
|
62
62
|
- app/pb_kits/playbook/pb_avatar/docs/_avatar_badge_component_overlay.html.erb
|
63
63
|
- app/pb_kits/playbook/pb_avatar/docs/_avatar_badge_component_overlay.jsx
|
64
|
-
- app/pb_kits/playbook/pb_avatar/docs/_avatar_badge_component_overlay.md
|
65
64
|
- app/pb_kits/playbook/pb_avatar/docs/_avatar_circle_icon_component_overlay.html.erb
|
66
65
|
- app/pb_kits/playbook/pb_avatar/docs/_avatar_circle_icon_component_overlay.jsx
|
67
|
-
- app/pb_kits/playbook/pb_avatar/docs/_avatar_circle_icon_component_overlay.md
|
68
66
|
- app/pb_kits/playbook/pb_avatar/docs/_avatar_default.html.erb
|
69
67
|
- app/pb_kits/playbook/pb_avatar/docs/_avatar_default.jsx
|
70
68
|
- app/pb_kits/playbook/pb_avatar/docs/_avatar_default_swift.md
|
@@ -352,10 +350,6 @@ files:
|
|
352
350
|
- app/pb_kits/playbook/pb_collapsible/docs/_collapsible_color.jsx
|
353
351
|
- app/pb_kits/playbook/pb_collapsible/docs/_collapsible_color.md
|
354
352
|
- app/pb_kits/playbook/pb_collapsible/docs/_collapsible_colors_swift.md
|
355
|
-
- app/pb_kits/playbook/pb_collapsible/docs/_collapsible_custom_main.jsx
|
356
|
-
- app/pb_kits/playbook/pb_collapsible/docs/_collapsible_custom_main.md
|
357
|
-
- app/pb_kits/playbook/pb_collapsible/docs/_collapsible_custom_main_rails.html.erb
|
358
|
-
- app/pb_kits/playbook/pb_collapsible/docs/_collapsible_custom_main_rails.md
|
359
353
|
- app/pb_kits/playbook/pb_collapsible/docs/_collapsible_default.html.erb
|
360
354
|
- app/pb_kits/playbook/pb_collapsible/docs/_collapsible_default.jsx
|
361
355
|
- app/pb_kits/playbook/pb_collapsible/docs/_collapsible_default_swift.md
|
@@ -611,29 +605,25 @@ files:
|
|
611
605
|
- app/pb_kits/playbook/pb_dropdown/docs/_dropdown_default.html.erb
|
612
606
|
- app/pb_kits/playbook/pb_dropdown/docs/_dropdown_default.jsx
|
613
607
|
- app/pb_kits/playbook/pb_dropdown/docs/_dropdown_default.md
|
608
|
+
- app/pb_kits/playbook/pb_dropdown/docs/_dropdown_subcomponent_structure.html.erb
|
614
609
|
- app/pb_kits/playbook/pb_dropdown/docs/_dropdown_subcomponent_structure.jsx
|
615
610
|
- app/pb_kits/playbook/pb_dropdown/docs/_dropdown_subcomponent_structure.md
|
616
|
-
- app/pb_kits/playbook/pb_dropdown/docs/_dropdown_subcomponent_structure_rails.html.erb
|
617
|
-
- app/pb_kits/playbook/pb_dropdown/docs/_dropdown_subcomponent_structure_rails.md
|
618
611
|
- app/pb_kits/playbook/pb_dropdown/docs/_dropdown_with_autocomplete.jsx
|
619
612
|
- app/pb_kits/playbook/pb_dropdown/docs/_dropdown_with_autocomplete.md
|
620
613
|
- app/pb_kits/playbook/pb_dropdown/docs/_dropdown_with_autocomplete_and_custom_display.jsx
|
621
614
|
- app/pb_kits/playbook/pb_dropdown/docs/_dropdown_with_autocomplete_and_custom_display.md
|
615
|
+
- app/pb_kits/playbook/pb_dropdown/docs/_dropdown_with_custom_display.html.erb
|
622
616
|
- app/pb_kits/playbook/pb_dropdown/docs/_dropdown_with_custom_display.jsx
|
623
617
|
- app/pb_kits/playbook/pb_dropdown/docs/_dropdown_with_custom_display.md
|
624
|
-
- app/pb_kits/playbook/pb_dropdown/docs/
|
625
|
-
- app/pb_kits/playbook/pb_dropdown/docs/_dropdown_with_custom_display_rails.md
|
618
|
+
- app/pb_kits/playbook/pb_dropdown/docs/_dropdown_with_custom_options.html.erb
|
626
619
|
- app/pb_kits/playbook/pb_dropdown/docs/_dropdown_with_custom_options.jsx
|
627
620
|
- app/pb_kits/playbook/pb_dropdown/docs/_dropdown_with_custom_options.md
|
628
|
-
- app/pb_kits/playbook/pb_dropdown/docs/_dropdown_with_custom_options_rails.html.erb
|
629
|
-
- app/pb_kits/playbook/pb_dropdown/docs/_dropdown_with_custom_options_rails.md
|
630
621
|
- app/pb_kits/playbook/pb_dropdown/docs/_dropdown_with_custom_padding.html.erb
|
631
622
|
- app/pb_kits/playbook/pb_dropdown/docs/_dropdown_with_custom_padding.jsx
|
632
623
|
- app/pb_kits/playbook/pb_dropdown/docs/_dropdown_with_custom_padding.md
|
624
|
+
- app/pb_kits/playbook/pb_dropdown/docs/_dropdown_with_custom_trigger.html.erb
|
633
625
|
- app/pb_kits/playbook/pb_dropdown/docs/_dropdown_with_custom_trigger.jsx
|
634
626
|
- app/pb_kits/playbook/pb_dropdown/docs/_dropdown_with_custom_trigger.md
|
635
|
-
- app/pb_kits/playbook/pb_dropdown/docs/_dropdown_with_custom_trigger_rails.html.erb
|
636
|
-
- app/pb_kits/playbook/pb_dropdown/docs/_dropdown_with_custom_trigger_rails.md
|
637
627
|
- app/pb_kits/playbook/pb_dropdown/docs/_dropdown_with_external_control.jsx
|
638
628
|
- app/pb_kits/playbook/pb_dropdown/docs/_dropdown_with_hook.jsx
|
639
629
|
- app/pb_kits/playbook/pb_dropdown/docs/_dropdown_with_label.html.erb
|
@@ -1859,7 +1849,7 @@ homepage: https://playbook.powerapp.cloud/
|
|
1859
1849
|
licenses:
|
1860
1850
|
- ISC
|
1861
1851
|
metadata: {}
|
1862
|
-
post_install_message:
|
1852
|
+
post_install_message:
|
1863
1853
|
rdoc_options: []
|
1864
1854
|
require_paths:
|
1865
1855
|
- lib
|
@@ -1875,7 +1865,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
1875
1865
|
version: '0'
|
1876
1866
|
requirements: []
|
1877
1867
|
rubygems_version: 3.5.3
|
1878
|
-
signing_key:
|
1868
|
+
signing_key:
|
1879
1869
|
specification_version: 4
|
1880
1870
|
summary: Playbook Design System Docs
|
1881
1871
|
test_files: []
|
@@ -1,3 +0,0 @@
|
|
1
|
-
NOTE: All `componentOverlay` implementations require a `placement` prop, that accepts any of the following values: `top-right`, `top-left`, `bottom-right`, `bottom-left`, `top-center`, `bottom-center`, `left-center`, and `right-center`.
|
2
|
-
|
3
|
-
When passing the `badge` component as an overlay, you must also specify its text content,and you may optionally control the color by passing an [approved value](https://playbook.powerapp.cloud/kits/badge#colors) as a `variant`.
|
@@ -1,3 +0,0 @@
|
|
1
|
-
NOTE: All `componentOverlay` implementations require a `placement` prop, that accepts any of the following values: `top-right`, `top-left`, `bottom-right`, `bottom-left`, `top-center`, `bottom-center`, `left-center`, and `right-center`.
|
2
|
-
|
3
|
-
When passing the `iconCircle` component as an overlay, you must also specify an `icon`, and you may optionally control the color by passing an [approved value](https://playbook.powerapp.cloud/kits/icon_circle/rails#color) as a `variant`.
|
@@ -1,73 +0,0 @@
|
|
1
|
-
import React from 'react'
|
2
|
-
import { Collapsible, useCollapsible, Background, Flex, Title, List, ListItem } from '../..'
|
3
|
-
|
4
|
-
const CollapsibleCustomMain = () => {
|
5
|
-
const [isCollapsed, setIsCollapsed] = useCollapsible(true)
|
6
|
-
|
7
|
-
return (
|
8
|
-
<>
|
9
|
-
<Collapsible
|
10
|
-
collapsed={isCollapsed}
|
11
|
-
>
|
12
|
-
<Background
|
13
|
-
backgroundColor="white"
|
14
|
-
cursor="pointer"
|
15
|
-
htmlOptions={{onClick:() => setIsCollapsed(!isCollapsed)}}
|
16
|
-
position="sticky"
|
17
|
-
top="0"
|
18
|
-
>
|
19
|
-
<Flex
|
20
|
-
align="center"
|
21
|
-
gap="sm"
|
22
|
-
justify="between"
|
23
|
-
>
|
24
|
-
<Title
|
25
|
-
size={4}
|
26
|
-
text="Custom Main Section"
|
27
|
-
/>
|
28
|
-
<Collapsible.Icon collapsed={isCollapsed}/>
|
29
|
-
</Flex>
|
30
|
-
</Background>
|
31
|
-
<Collapsible.Content padding="none">
|
32
|
-
<div>
|
33
|
-
<List>
|
34
|
-
<ListItem
|
35
|
-
align="stretch"
|
36
|
-
flexDirection="column"
|
37
|
-
>
|
38
|
-
Checklist item
|
39
|
-
</ListItem>
|
40
|
-
<ListItem
|
41
|
-
align="stretch"
|
42
|
-
flexDirection="column"
|
43
|
-
>
|
44
|
-
Checklist item
|
45
|
-
</ListItem>
|
46
|
-
<ListItem
|
47
|
-
align="stretch"
|
48
|
-
flexDirection="column"
|
49
|
-
>
|
50
|
-
Checklist item
|
51
|
-
</ListItem>
|
52
|
-
<ListItem
|
53
|
-
align="stretch"
|
54
|
-
flexDirection="column"
|
55
|
-
>
|
56
|
-
Checklist item
|
57
|
-
</ListItem>
|
58
|
-
<ListItem
|
59
|
-
align="stretch"
|
60
|
-
flexDirection="column"
|
61
|
-
>
|
62
|
-
Checklist item
|
63
|
-
</ListItem>
|
64
|
-
</List>
|
65
|
-
</div>
|
66
|
-
</Collapsible.Content>
|
67
|
-
</Collapsible>
|
68
|
-
|
69
|
-
</>
|
70
|
-
)
|
71
|
-
}
|
72
|
-
|
73
|
-
export default CollapsibleCustomMain
|
@@ -1,5 +0,0 @@
|
|
1
|
-
A custom Main section can also be used in place of the provided `Collapsible.Main`. This gives devs full control over that subcomponent. For example, here we are using global props to make that custom Main 'sticky' on scroll.
|
2
|
-
|
3
|
-
If a custom component is used in place of the default, devs must handle collapsible toggling themselves via the useCollapsible hook as seen in this example.
|
4
|
-
|
5
|
-
The default Collapsible icon can also be used as part of the custom Main as shown, you will need to pass the Collapsible state to the `collapsed` prop on the optional `Collapsible.Icon`.
|
@@ -1,20 +0,0 @@
|
|
1
|
-
<%= pb_rails("collapsible", props: { name: "default-example" }) do %>
|
2
|
-
<%= pb_rails("background", props: { background_color: "white", position: "sticky", top: "0", cursor:"pointer", data: {"collapsible-main": "true"} }) do %>
|
3
|
-
<%= pb_rails("flex", props: {align:"center", gap:"sm", justify:"between"}) do %>
|
4
|
-
<%= pb_rails("title", props: { text: "Custom Main Section", tag: "h4", size: 4 }) %>
|
5
|
-
<%= pb_rails("collapsible/collapsible_icon") %>
|
6
|
-
<% end %>
|
7
|
-
<% end %>
|
8
|
-
<%= pb_rails("flex", props: { align: "center", justify: "between" }) do %>
|
9
|
-
<% end %>
|
10
|
-
<%= pb_rails("collapsible/collapsible_content", props: { padding: "none" }) do %>
|
11
|
-
<%= pb_rails("list", props: {ordered: false, dark: false, borderless: false}) do %>
|
12
|
-
<%= pb_rails("list/item") do %> Checklist Item <% end %>
|
13
|
-
<%= pb_rails("list/item") do %> Checklist Item <% end %>
|
14
|
-
<%= pb_rails("list/item") do %> Checklist Item <% end %>
|
15
|
-
<%= pb_rails("list/item") do %> Checklist Item <% end %>
|
16
|
-
<%= pb_rails("list/item") do %> Checklist Item <% end %>
|
17
|
-
<% end %>
|
18
|
-
<% end %>
|
19
|
-
<% end %>
|
20
|
-
|
@@ -1,5 +0,0 @@
|
|
1
|
-
A custom Main section can also be used in place of the provided `collapsible/collapsible_main`. This gives devs full control over that subcomponent. For example, here we are using global props to make that custom Main 'sticky' on scroll.
|
2
|
-
|
3
|
-
If a custom component is used in place of the default, devs must add `data: {"collapsible-main": "true"}` to the custom Main for toggling of the collapsible to work correctly.
|
4
|
-
|
5
|
-
The default Collapsible icon can also be used as part of the custom Main as shown with the optional `collapsible/collapsible_icon`. This optional subcomponent accepts all icon related props `color`, `icon` and `size`.
|
@@ -1,6 +0,0 @@
|
|
1
|
-
The dropdown is built using all of the following required subcomponents:
|
2
|
-
|
3
|
-
`dropdown/dropdown_trigger` is the UI component that users interact with to toggle the dropdown.
|
4
|
-
`dropdown/dropdown_container` is the floating container that wraps the list of dropdown options.
|
5
|
-
`dropdown/dropdown_option` renders options that are passed to the container.
|
6
|
-
Each of these subcomponents can be altered using global props and/or their respective props. See doc examples below for more information on each.
|
@@ -1,5 +0,0 @@
|
|
1
|
-
Optionally utilize `custom_display` on the `dropdown/dropdown_trigger` subcomponent to customize its content after an option is selected. The component passed to custom_display will be rendered to the left of the default text-based display. In this example the Avatar kit is being used.
|
2
|
-
|
3
|
-
The `placeholder` prop can also be used to customize the placeholder text for the default `dropdown/dropdown_trigger`.
|
4
|
-
|
5
|
-
The dropdown follows the typical rails pattern of utilizing hidden inputs for form submission. The hidden input value is the selected options' id.
|
@@ -1 +0,0 @@
|
|
1
|
-
`dropdown/dropdown_option` subcomponent accepts any child components to customize the options' contents and display. By default, options are Body kit text that is set by the `label` value from the `option` object.
|
@@ -1 +0,0 @@
|
|
1
|
-
Optionally replace the default trigger's select element by passing child components directly to the `dropdown/dropdown_trigger`.
|