playbook_ui_docs 13.27.0 → 13.28.0.pre.alpha.PBNTR296dropdownwithform2941

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5a0ca4ba49f9761948d5396d862f7a7dca62755280c4a327d8be07578131efa
-  data.tar.gz: d47839a1a9c0f199291420ecf5d116ce04f79e1154a3f02b69519a667b4496ed
+  metadata.gz: f02e743e2bbecb16ca04bf79ae10a2586b38f6e04a132f65a230c423cb4a2910
+  data.tar.gz: 8e2257efd28225f8dcaf388aa3f2927e29f8e965db06178658647dd0e7f5293d
 SHA512:
-  metadata.gz: 3a8e4c4a70ee7b4c2cf06da4a1215219109050161b27fbee7fbeadfbcb86d23ecd95b3282f2ba3483832553f826343c45116cea1aae33d56a86a055ded39b195
-  data.tar.gz: 139f88815ff1cbda2ff72a5a4915c3b955f47f32fc4f25e9b52286ea4f764a874eeef219d5906c99bbf338cb1b24cb40de4f85ddfd5c98952fa5513edfbae907
+  metadata.gz: 9fe0f38c9e9fd984301178933047053b5a74bd5f28f47416a442f5e19322b3b60cf0b6b7a4cb6be84dfa1050ad9ee75546cb5985a9be58ee6f5cab0fa5bc030a
+  data.tar.gz: 959a070dd6af81b899d5b026fe17b91f8d2058f620c4aa09791bdb6942cd425e4171a6067ee80c82388080a45a8e745a6bb8b0a466c63b27dfa9e1d34c25f8ae

data/app/pb_kits/playbook/pb_avatar/docs/_avatar_badge_component_overlay.html.erb

@@ -1,71 +1,51 @@
-<%= pb_rails("avatar", props: {
-    component_overlay: {
-        component: "badge",
-        text: "12",
-        placement: "top-left"
-    },
-    name: "Terry Johnson",
-    size: "xxs",
-    image_url: "https://randomuser.me/api/portraits/men/44.jpg",
-    margin_bottom: "sm"
-  }) %>
 
-  <%= pb_rails("avatar", props: {
-    component_overlay: {
-        component: "badge",
-        text: "12",
-        placement: "top-right"
-    },
-    name: "Terry Johnson",
-    size: "xs",
-    image_url: "https://randomuser.me/api/portraits/men/44.jpg",
-    margin_bottom: "sm"
-  }) %>
+ <%= pb_rails("avatar", props: {
+      component_overlay: {
+          component: "badge",
+          text: "12",
+          placement: "bottom-right"
+      },
+      name: "Terry Johnson",
+      size: "sm",
+      image_url: "https://randomuser.me/api/portraits/men/44.jpg",
+      margin_bottom: "sm"
+    }) %>
 
-  <%= pb_rails("avatar", props: {
-    component_overlay: {
-        component: "badge",
-        text: "12",
-        placement: "bottom-right"
-    },
-    name: "Terry Johnson",
-    size: "sm",
-    image_url: "https://randomuser.me/api/portraits/men/44.jpg",
-    margin_bottom: "sm"
-  }) %>
+    <%= pb_rails("avatar", props: {
+      component_overlay: {
+          component: "badge",
+          text: "12",
+          placement: "top-left"
+      },
+      name: "Terry Johnson",
+      size: "md",
+      image_url: "https://randomuser.me/api/portraits/men/44.jpg",
+      margin_bottom: "sm"
+    }) %>
 
-  <%= pb_rails("avatar", props: {
-    component_overlay: {
-        component: "badge",
-        text: "12",
-        placement: "bottom-left"
-    },
-    name: "Terry Johnson",
-    size: "md",
-    image_url: "https://randomuser.me/api/portraits/men/44.jpg",
-    margin_bottom: "sm"
-  }) %>
+    <%= pb_rails("avatar", props: {
+      component_overlay: {
+          component: "badge",
+          text: "On Roadtrip",
+          placement: "top-center",
+          variant: "info"
+      },
+      name: "Terry Johnson",
+      size: "lg",
+      image_url: "https://randomuser.me/api/portraits/men/44.jpg",
+      margin_bottom: "sm"
+    }) %>
 
-  <%= pb_rails("avatar", props: {
-    component_overlay: {
-        component: "badge",
-        text: "12",
-        placement: "top-left"
-    },
-    name: "Terry Johnson",
-    size: "lg",
-    image_url: "https://randomuser.me/api/portraits/men/44.jpg",
-    margin_bottom: "sm"
-  }) %>
+    <%= pb_rails("avatar", props: {
+      component_overlay: {
+          component: "badge",
+          text: "Out of Office",
+          placement: "bottom-center",
+          variant: "error"
+      },
+      name: "Terry Johnson",
+      size: "xl",
+      image_url: "https://randomuser.me/api/portraits/men/44.jpg",
+      margin_bottom: "sm"
+    }) %>
 
-  <%= pb_rails("avatar", props: {
-    component_overlay: {
-        component: "badge",
-        text: "12",
-        placement: "top-right"
-    },
-    name: "Terry Johnson",
-    size: "xl",
-    image_url: "https://randomuser.me/api/portraits/men/44.jpg",
-    margin_bottom: "sm"
-  }) %>

data/app/pb_kits/playbook/pb_avatar/docs/_avatar_badge_component_overlay.jsx

@@ -4,28 +4,6 @@ import { Avatar } from '../..'
 const AvatarBadgeComponentOverlay = () => {
     return (
         <div>
-            <Avatar
-                componentOverlay={{
-                    component: "badge",
-                    placement: "top-left",
-                    text: "12"
-                }}
-                imageUrl="https://randomuser.me/api/portraits/men/44.jpg"
-                marginBottom="sm"
-                size="xxs"
-            />
-
-            <Avatar
-                componentOverlay={{
-                    component: "badge",
-                    placement: "top-right",
-                    text: "12"
-                }}
-                imageUrl="https://randomuser.me/api/portraits/men/44.jpg"
-                marginBottom="sm"
-                size="xs"
-            />
-
             <Avatar
                 componentOverlay={{
                     component: "badge",
@@ -40,7 +18,7 @@ const AvatarBadgeComponentOverlay = () => {
             <Avatar
                 componentOverlay={{
                     component: "badge",
-                    placement: "bottom-left",
+                    placement: "top-left",
                     text: "12"
                 }}
                 imageUrl="https://randomuser.me/api/portraits/men/44.jpg"
@@ -51,8 +29,9 @@ const AvatarBadgeComponentOverlay = () => {
             <Avatar
                 componentOverlay={{
                     component: "badge",
-                    placement: "top-left",
-                    text: "12"
+                    placement: "top-center",
+                    text: "On Roadtip",
+                    variant: "info"
                 }}
                 imageUrl="https://randomuser.me/api/portraits/men/44.jpg"
                 marginBottom="sm"
@@ -62,14 +41,14 @@ const AvatarBadgeComponentOverlay = () => {
             <Avatar
                 componentOverlay={{
                     component: "badge",
-                    placement: "top-right",
-                    text: "12"
+                    placement: "bottom-center",
+                    text: "Out of Office",
+                    variant: "error"
                 }}
                 imageUrl="https://randomuser.me/api/portraits/men/44.jpg"
                 marginBottom="sm"
                 size="xl"
-            />    
-
+            /> 
         </div>
     )
 }

data/app/pb_kits/playbook/pb_avatar/docs/_avatar_badge_component_overlay.md

@@ -0,0 +1,3 @@
+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`.
+
+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`.

data/app/pb_kits/playbook/pb_avatar/docs/_avatar_circle_icon_component_overlay.html.erb

@@ -1,32 +1,9 @@
-<%= pb_rails("avatar", props: {
-    component_overlay: {
-        component: "icon_circle",
-        icon: "plus",
-        placement: "top-left"
-    },
-    name: "Terry Johnson",
-    size: "xxs",
-    image_url: "https://randomuser.me/api/portraits/men/44.jpg",
-    margin_bottom: "sm"
-  }) %>
-
-  <%= pb_rails("avatar", props: {
-    component_overlay: {
-        component: "icon_circle",
-        icon: "plus",
-        placement: "top-right"
-    },
-    name: "Terry Johnson",
-    size: "xs",
-    image_url: "https://randomuser.me/api/portraits/men/44.jpg",
-    margin_bottom: "sm"
-  }) %>
-
   <%= pb_rails("avatar", props: {
     component_overlay: {
         component: "icon_circle",
-        icon: "plus",
-        placement: "bottom-right"
+        icon: "shield",
+        placement: "bottom-right",
+        variant: "royal"
     },
     name: "Terry Johnson",
     size: "sm",
@@ -37,8 +14,9 @@
   <%= pb_rails("avatar", props: {
     component_overlay: {
         component: "icon_circle",
-        icon: "plus",
-        placement: "bottom-left"
+        icon: "check",
+        placement: "top-right",
+        variant: "green"
     },
     name: "Terry Johnson",
     size: "md",
@@ -49,8 +27,9 @@
   <%= pb_rails("avatar", props: {
     component_overlay: {
         component: "icon_circle",
-        icon: "plus",
-        placement: "top-left"
+        icon: "lock",
+        placement: "top-left",
+        variant: "red"
     },
     name: "Terry Johnson",
     size: "lg",
@@ -61,11 +40,12 @@
   <%= pb_rails("avatar", props: {
     component_overlay: {
         component: "icon_circle",
-        icon: "plus",
-        placement: "top-right"
+        icon: "star",
+        placement: "left-center",
+        variant: "yellow"
     },
     name: "Terry Johnson",
     size: "xl",
     image_url: "https://randomuser.me/api/portraits/men/44.jpg",
     margin_bottom: "sm"
-  }) %>
+  }) %>

data/app/pb_kits/playbook/pb_avatar/docs/_avatar_circle_icon_component_overlay.jsx

@@ -4,73 +4,54 @@ import { Avatar } from '../..'
 const AvatarCircleIconComponentOverlay = () => {
     return (
         <div>
-            <Avatar
-                componentOverlay={{
-                    component: "iconCircle",
-                    icon: "plus",
-                    placement: "top-left"
-                }}
-                imageUrl="https://randomuser.me/api/portraits/men/44.jpg"
-                marginBottom="sm"
-                size="xxs"
-            />
-
-            <Avatar
-                componentOverlay={{
-                    component: "iconCircle",
-                    icon: "plus",
-                    placement: "top-right"
-                }}
-                imageUrl="https://randomuser.me/api/portraits/men/44.jpg"
-                marginBottom="sm"
-                size="xs"
-            />
-
-            <Avatar
-                componentOverlay={{
-                    component: "iconCircle",
-                    icon: "plus",
-                    placement: "bottom-right",
-                }}
-                imageUrl="https://randomuser.me/api/portraits/men/44.jpg"
-                marginBottom="sm"
-                size="sm"
-            />
-
-            <Avatar
-                componentOverlay={{
-                    component: "iconCircle",
-                    icon: "plus",
-                    placement: "bottom-left"
-                }}
-                imageUrl="https://randomuser.me/api/portraits/men/44.jpg"
-                marginBottom="sm"
-                size="md"
-            />
-
-            <Avatar
-                componentOverlay={{
-                    component: "iconCircle",
-                    icon: "plus",
-                    placement: "top-left"
-                }}
-                imageUrl="https://randomuser.me/api/portraits/men/44.jpg"
-                marginBottom="sm"
-                size="lg"
-            />
-
-            <Avatar
-                componentOverlay={{
-                    component: "iconCircle",
-                    icon: "plus",
-                    placement: "top-right"
-                }}
-                imageUrl="https://randomuser.me/api/portraits/men/44.jpg"
-                marginBottom="sm"
-                size="xl"
-            />
-
-        </div>
+        <Avatar
+            componentOverlay={{
+                component: "iconCircle",
+                placement: "bottom-right",
+                icon: "shield",
+                variant: "royal"
+            }}
+            imageUrl="https://randomuser.me/api/portraits/men/44.jpg"
+            marginBottom="sm"
+            size="sm"
+        />
+
+        <Avatar
+            componentOverlay={{
+                component: "iconCircle",
+                placement: "bottom-right",
+                icon: "check",
+                variant: "green"
+            }}
+            imageUrl="https://randomuser.me/api/portraits/men/44.jpg"
+            marginBottom="sm"
+            size="md"
+        />
+
+        <Avatar
+            componentOverlay={{
+                component: "iconCircle",
+                placement: "top-left",
+                icon: "lock",
+                variant: "red"
+            }}
+            imageUrl="https://randomuser.me/api/portraits/men/44.jpg"
+            marginBottom="sm"
+            size="lg"
+        />
+
+        <Avatar
+            componentOverlay={{
+                component: "iconCircle",
+                placement: "left-center",
+                icon: "star",
+                variant: "yellow"
+            }}
+            imageUrl="https://randomuser.me/api/portraits/men/44.jpg"
+            marginBottom="sm"
+            size="xl"
+        /> 
+    </div>
     )
 }
 

data/app/pb_kits/playbook/pb_avatar/docs/_avatar_circle_icon_component_overlay.md

@@ -0,0 +1,3 @@
+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`.
+
+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`.

data/app/pb_kits/playbook/pb_avatar/docs/_avatar_default.jsx

@@ -57,26 +57,6 @@ const AvatarDefault = (props) => {
           status="offline"
           {...props}
       />
-      <br/>
-      <Avatar
-          imageAlt="Terry Johnson Standing"
-          imageUrl="https://randomuser.me/api/portraits/men/44.jpg"
-          name="Terry Johnson"
-          overlay={{component:"badge", text: "6", variant: "notification", placement:"top-right"}}
-          size="lg"
-          status="offline"
-          {...props}
-      />
-      <br/>
-      <Avatar
-          imageAlt="Terry Johnson Standing"
-          imageUrl="https://randomuser.me/api/portraits/men/44.jpg"
-          name="Terry Johnson"
-          overlay={{component:"icon", icon:"plus", variant:"royal", placement:"bottom-left"}}
-          size="xl"
-          status="offline"
-          {...props}
-      />
     </div>
   )
 }

data/app/pb_kits/playbook/pb_avatar/docs/example.yml

@@ -4,14 +4,14 @@ examples:
     - avatar_monogram: Monogram
     - avatar_no_image: "Bad Image Link"
     - avatar_status: Status
-    - avatar_circle_icon_component_overlay: Circle Icon Component Overlay
+    - avatar_circle_icon_component_overlay: Icon Circle Component Overlay
     - avatar_badge_component_overlay: Badge Component Overlay
   react:
     - avatar_default: Default
     - avatar_monogram: Monogram
     - avatar_no_image: "Bad Image Link"
     - avatar_status: Status
-    - avatar_circle_icon_component_overlay: Circle Icon Component Overlay
+    - avatar_circle_icon_component_overlay: Icon Circle Component Overlay
     - avatar_badge_component_overlay: Badge Component Overlay
   swift:
     - avatar_default_swift: Default

data/app/pb_kits/playbook/pb_card/docs/_card_background.html.erb

@@ -42,3 +42,23 @@
     dark: true
   }) %>
 <% end %>
+
+<%= pb_rails("title", props: { text: "Subtle Status Colors", tag: "h4", size: 4, margin_bottom: "sm" }) %>
+
+<%= pb_rails("card", props: { background: "success_subtle", margin_bottom: "sm" })  do %>
+  <%= pb_rails("body", props: {
+    text: "Success Subtle"
+  }) %>
+<% end %>
+
+<%= pb_rails("card", props: { background: "warning_subtle", margin_bottom: "sm" })  do %>
+  <%= pb_rails("body", props: {
+    text: "Warning Subtle"
+  }) %>
+<% end %>
+
+<%= pb_rails("card", props: { background: "info_subtle", margin_bottom: "sm" })  do %>
+  <%= pb_rails("body", props: {
+    text: "Info Subtle"
+  }) %>
+<% end %>

data/app/pb_kits/playbook/pb_card/docs/_card_background.jsx

@@ -90,7 +90,47 @@ const CardBackground = (props) => {
         />
       </Card>
 
-      
+
+      <Title
+          {...props}
+          marginBottom="sm"
+          size={4}
+          tag="h4"
+          text="Subtle Status Colors"
+      />
+
+      <Card
+          background="success_subtle"
+          marginBottom="sm"
+          {...props}
+      >
+        <Body
+            text="Success Subtle"
+            {...props}  
+        />
+      </Card>
+
+      <Card
+          background="warning_subtle"
+          marginBottom="sm"
+          {...props}
+      >
+        <Body
+            text="Warning Subtle"
+            {...props}
+        />
+      </Card>
+
+      <Card
+          background="info_subtle"
+          marginBottom="sm"
+          {...props}
+      >
+        <Body
+            text="Info Subtle"
+            {...props}
+        />
+      </Card>
     </div>
   )
 }

data/app/pb_kits/playbook/pb_card/docs/_card_background.md

@@ -1 +1 @@
-Add a background color by passing the color name to background. List of all colors can be viewed <a href="https://playbook.powerapp.cloud/visual_guidelines" target="_blank">here</a> under Product Colors.
+Add a background color by passing the color name to background. List of all colors can be viewed <a href="https://playbook.powerapp.cloud/visual_guidelines" target="_blank">here</a> under Product Colors and Status: Subtle Variations.

data/app/pb_kits/playbook/pb_card/docs/_card_header.html.erb

@@ -67,4 +67,4 @@
   <%= pb_rails("card/card_body", props: { padding: "md",  }) do %>
     Body
   <% end %>
-<% end %>
+<% end %>

data/app/pb_kits/playbook/pb_card/docs/_card_header.md

@@ -1 +1 @@
-Card headers pass category, product, and background colors only. List of all category, product, and background colors can be viewed <a href="https://playbook.powerapp.cloud/utilities" target="_blank">here</a>.
+Card headers pass category, product, and background colors only. List of all category, product, and background colors can be viewed <a href="https://playbook.powerapp.cloud/visual_guidelines/colors" target="_blank">here</a>.

data/app/pb_kits/playbook/pb_card/docs/_card_highlight.md

@@ -1 +1 @@
-Card highlight can pass status, product, and category colors. List of all colors can be viewed <a href="https://playbook.powerapp.cloud/utilities" target="_blank">here</a>.
+Card highlight can pass status, product, and category colors. List of all colors can be viewed <a href="https://playbook.powerapp.cloud/visual_guidelines/colors" target="_blank">here</a>.

data/app/pb_kits/playbook/pb_collapsible/docs/_collapsible_custom_main.jsx

@@ -0,0 +1,72 @@
+import React from 'react'
+import { Collapsible, useCollapsible, Background, Flex, Title, List, ListItem } from '../..'
+
+const CollapsibleCustomMain = () => {
+  const [isCollapsed, setIsCollapsed] = useCollapsible(true)
+
+  return (
+  <>
+    <Collapsible
+        collapsed={isCollapsed}
+    >
+          <Background 
+              backgroundColor="white" 
+              cursor="pointer"
+              htmlOptions={{onClick:() => setIsCollapsed(!isCollapsed)}}
+              position="sticky" 
+              top="0" 
+          >
+              <Flex 
+                  align="center" 
+                  gap="sm"
+                  justify="between" 
+              >
+                <Title 
+                    size={4} 
+                    text="Custom Main Section" 
+                />
+              </Flex>
+          </Background>
+      <Collapsible.Content padding="none">
+          <div>
+          <List>
+              <ListItem 
+                  align="stretch"
+                  flexDirection="column" 
+              >
+                Checklist item
+              </ListItem>
+              <ListItem 
+                  align="stretch"
+                  flexDirection="column" 
+              >
+                Checklist item
+              </ListItem>
+              <ListItem 
+                  align="stretch"
+                  flexDirection="column" 
+              >
+                Checklist item
+              </ListItem>
+              <ListItem 
+                  align="stretch"
+                  flexDirection="column" 
+              >
+                Checklist item
+              </ListItem>
+              <ListItem 
+                  align="stretch"
+                  flexDirection="column" 
+              >
+                Checklist item
+              </ListItem>
+            </List>
+          </div>
+      </Collapsible.Content>
+    </Collapsible>
+   
+  </>
+  )
+}
+
+export default CollapsibleCustomMain

data/app/pb_kits/playbook/pb_collapsible/docs/_collapsible_custom_main.md

@@ -0,0 +1,3 @@
+Optionally replace your `Collapsible.Main` with any component to customize your Main section's contents and/or style. This gives you full control over that subcomponent. For example, here we are using global props to make that custom Main 'sticky' on scroll.
+
+__NOTE__: Custom main sections requires the `useCollapsible` hook to ensure the collapsible's toggle action works correctly.

data/app/pb_kits/playbook/pb_collapsible/docs/_collapsible_custom_main_rails.html.erb

@@ -0,0 +1,19 @@
+<%= pb_rails("collapsible", props: { name: "default-example" }) do %>
+    <%= pb_rails("background", props: { background_color: "white", position: "sticky", top: "0", cursor:"pointer", data: {"collapsible-main": "true"} }) do %>
+      <%= pb_rails("flex", props: {align:"center", gap:"sm", justify:"between"}) do %>
+        <%= pb_rails("title", props: { text: "Custom Main Section", tag: "h4", size: 4 }) %>
+     <% end %>
+      <% end %>
+     <%= pb_rails("flex", props: { align: "center", justify: "between" }) do %>
+    <% end %>
+      <%= pb_rails("collapsible/collapsible_content", props: { padding: "none"  }) do %>
+        <%= pb_rails("list", props: {ordered: false, dark: false, borderless: false}) do %>
+            <%= pb_rails("list/item") do %> Checklist Item <% end %>
+            <%= pb_rails("list/item") do %> Checklist Item <% end %>
+            <%= pb_rails("list/item") do %> Checklist Item <% end %>
+            <%= pb_rails("list/item") do %> Checklist Item <% end %>
+            <%= pb_rails("list/item") do %> Checklist Item <% end %>
+            <% end %>
+      <% end %>
+    <% end %>
+    

data/app/pb_kits/playbook/pb_collapsible/docs/_collapsible_custom_main_rails.md

@@ -0,0 +1,3 @@
+Optionally replace your `collapsible/collapsible_main` with any component to customize your Main section's contents and/or style. This gives you full control over that subcomponent. For example, here we are using global props to make that custom Main 'sticky' on scroll.
+
+__NOTE__: Custom main sections require `data: {"collapsible-main": "true"}` to ensure the collapsible's toggle action works correctly.