playbook_ui_docs 12.36.0 → 12.37.0.pre.alpha.PLAY951collapsiblenav31073

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34fca519f08d4f8e30e7a05705bbdfcd2d2e959e5a7afefb4a35ad12a980a0b8
-  data.tar.gz: 4cc96859dead44d39bb79b69e07a857fcd1701fb06ada07b1dd53267045242c2
+  metadata.gz: 3b824331ed5a370e96bb561a06cc20c36f2004c420fdeca6ede89d6ee4dda65e
+  data.tar.gz: 722ced6545e16a2b487aa0fc033e6ac3208cef3227dcc6a64457f18427e3f30e
 SHA512:
-  metadata.gz: b583873803438a86347ba44a611b0404a5a416fcf8265c7c7c3063211a9f88a1becd5061b1e9a5210d7219703da65ae5869578ce420e22a59144972748e6ebb3
-  data.tar.gz: '079e6a9fd20de83803a6789389029137a611e12675f2066c6f603b3187fd83c684fb0db71dabfc51a95d8358b54bf27ac9f9ac857a58960e1717b33bf1703d39'
+  metadata.gz: 54eeb7ed889f36d359c095005222c2bc2e3e02cff923fe7abf6cdb9959004b3a90d58dcb414dc68d1b730149e1449b155c1545f815b17c0701f89ed34ab9f18e
+  data.tar.gz: f55084413df2c32b511ca7ae4a56c7513e8b951bb4077efc297cba34b256f7f270e774176bc70c822b7002b933a7fe827b58062b03f6d60131b416507e121bbb

data/app/pb_kits/playbook/pb_badge/docs/_badge_colors_swift.md

@@ -0,0 +1,33 @@
+![badge-colors](https://github.com/powerhome/playbook/assets/92755007/52ce34ef-eb0d-48c0-9232-89edfff60cef)
+
+```swift
+HStack {
+  PBBadge(text: "1", rounded: true, variant: .chat)
+  PBBadge(text: "4", variant: .chat)
+  PBBadge(text: "1000", variant: .chat)
+
+  PBBadge(text: "1", rounded: true, variant: .error)
+  PBBadge(text: "4", variant: .error)
+  PBBadge(text: "1000", variant: .error)
+
+  PBBadge(text: "1", rounded: true, variant: .info)
+  PBBadge(text: "4", variant: .info)
+  PBBadge(text: "1000", variant: .info)
+
+  PBBadge(text: "1", rounded: true, variant: .neutral)
+  PBBadge(text: "4", variant: .neutral)
+  PBBadge(text: "1000", variant: .neutral)
+
+  PBBadge(text: "1", rounded: true, variant: .primary)
+  PBBadge(text: "4", variant: .primary)
+  PBBadge(text: "1000", variant: .primary)
+
+  PBBadge(text: "1", rounded: true, variant: .success)
+  PBBadge(text: "4", variant: .success)
+  PBBadge(text: "1000", variant: .success)
+
+  PBBadge(text: "1", rounded: true, variant: .warning)
+  PBBadge(text: "4", variant: .warning)
+  PBBadge(text: "1000", variant: .warning)
+ }
+```

data/app/pb_kits/playbook/pb_badge/docs/_badge_default_swift.md

@@ -0,0 +1,9 @@
+![badge-rectangle](https://github.com/powerhome/playbook/assets/92755007/04188c68-84f0-475b-9764-7b9a325f73da)
+
+```swift
+HStack {
+  PBBadge(text: "+1", variant: .primary)
+  PBBadge(text: "+4", variant: .primary)
+  PBBadge(text: "+1000", variant: .primary)
+ }
+```

data/app/pb_kits/playbook/pb_badge/docs/_badge_notification_swift.md

@@ -0,0 +1,9 @@
+![badge-chat-notification](https://github.com/powerhome/playbook/assets/92755007/f769c3bc-6a63-465d-8538-3efb5f3ec0d3)
+
+```swift
+HStack {
+  PBBadge(text: "1", rounded: true, variant: .chat)
+  PBBadge(text: "4", variant: .chat)
+  PBBadge(text: "1000", variant: .chat)
+ }
+```

data/app/pb_kits/playbook/pb_badge/docs/_badge_props_swift.md

@@ -0,0 +1,6 @@
+### Props
+| Name | Type | Description | Default | Values |
+| --- | ----------- | --------- | --------- | --------- |
+| **text** | `String` | Specifies the value of the Badge |  |  |
+| **rounded** | `Bool` | Displays the rounded variant | `false` |  |
+| **variant** | `Variant` | Changes the color of the Badge | `.primary` | `.chat` `.error` `.info` `.neutral` `.primary` `.success` `.warning` |

data/app/pb_kits/playbook/pb_badge/docs/_badge_rounded_swift.md

@@ -0,0 +1,9 @@
+![badge-rounded](https://github.com/powerhome/playbook/assets/92755007/775a906f-0108-4ee1-a277-e7b9f2715a2b)
+
+```swift
+HStack {
+  PBBadge(text: "+1", rounded: true, variant: .primary)
+  PBBadge(text: "+4", rounded: true, variant: .primary)
+  PBBadge(text: "+1000", rounded: true, variant: .primary)
+ }
+```

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

@@ -10,3 +10,10 @@ examples:
   - badge_rounded: Rounded
   - badge_colors: Colors
   - badge_notification: Notification
+
+  swift:
+  - badge_default_swift: Rectangle
+  - badge_rounded_swift: Rounded
+  - badge_colors_swift: Colors
+  - badge_notification_swift: Notification
+  - badge_props_swift: ""

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

@@ -1,13 +1,13 @@
 import React from 'react'
 import { Collapsible } from '../..'
 
-const CollapsibleColor = () => (
+const CollapsibleColor = (props) => (
   <div>
     <Collapsible
         iconColor='default'
         marginBottom="xs"
     >
-      <Collapsible.Main>
+      <Collapsible.Main {...props}>
         <div>{'Default Section'}</div>
       </Collapsible.Main>
       <Collapsible.Content>

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

@@ -1,9 +1,9 @@
 import React from 'react'
 import { Collapsible } from '../..'
 
-const CollapsibleDefault = () => (
+const CollapsibleDefault = (props) => (
   <Collapsible >
-    <Collapsible.Main>
+    <Collapsible.Main {...props}>
       <div>{'Main Section'}</div>
     </Collapsible.Main>
     <Collapsible.Content>

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

@@ -1,9 +1,14 @@
 import React from 'react'
 import { Collapsible } from '../..'
 
-const CollapsibleIcons = () => (
-  <Collapsible icon={['plus','minus']}>
-    <Collapsible.Main>
+const CollapsibleIcons = (props) => {
+
+  return (
+  <>
+  <Collapsible
+      icon={['plus','minus']}
+  >
+    <Collapsible.Main {...props}>
       <div>{'Main Section'}</div>
     </Collapsible.Main>
     <Collapsible.Content>
@@ -14,6 +19,8 @@ const CollapsibleIcons = () => (
       </div>
     </Collapsible.Content>
   </Collapsible>
-)
+  </>
+  )
+}
 
 export default CollapsibleIcons

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

@@ -1,2 +1,2 @@
 ##### Prop
-This kit uses 'chevron-up' and 'chevron-down' icons as default for the toggle icons. To customize these icons, use the `icon` prop to pass in an array of two icons, the first will render when the collapisble is closed and the second will render when the collapsible is open. In this example, we are using `icon: ['plus','minus']`
+The `icon` prop allows you to customize your icon sets by passing it an array of any comma-separated pair of icon values. The first icon value will replace the kit's default icon when collapsed (chevron-down), and the second value will replace the default icon when expanded (chevron-up). `icon` also allows you to pass it a single icon as a string, in which case the icon will not toggle with the collapsible state.

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

@@ -1,13 +1,13 @@
 import React from 'react'
 import { Collapsible } from '../..'
 
-const CollapsibleSize = () => (
+const CollapsibleSize = (props) => (
   <div>
     <Collapsible
         iconSize="xs"
         marginBottom="xs"
     >
-      <Collapsible.Main>
+      <Collapsible.Main {...props}>
         <div>{'Extra Small Section'}</div>
       </Collapsible.Main>
       <Collapsible.Content>
@@ -22,7 +22,7 @@ const CollapsibleSize = () => (
         iconSize="sm"
         marginBottom="xs"
     >
-      <Collapsible.Main>
+      <Collapsible.Main {...props}>
         <div>{'Small Section'}</div>
       </Collapsible.Main>
       <Collapsible.Content>
@@ -36,7 +36,7 @@ const CollapsibleSize = () => (
     <Collapsible
         marginBottom="xs"
     >
-      <Collapsible.Main>
+      <Collapsible.Main {...props}>
         <div>{'Default Section'}</div>
       </Collapsible.Main>
       <Collapsible.Content>
@@ -51,7 +51,7 @@ const CollapsibleSize = () => (
         iconSize="lg"
         marginBottom="xs"
     >
-      <Collapsible.Main>
+      <Collapsible.Main {...props}>
         <div>{'Large Section'}</div>
       </Collapsible.Main>
       <Collapsible.Content>

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

@@ -0,0 +1,75 @@
+import React from 'react'
+import { Collapsible, useCollapsible, Button } from '../..'
+
+const CollapsibleState = (props) => {
+  const [isCollapsed, setIsCollapsed] = useCollapsible(true)
+
+  return (
+  <>
+    <Button
+        onClick={() => setIsCollapsed(!isCollapsed)}
+        padding="none"
+        variant="link"
+    >
+      {isCollapsed ? "Expand All" : "Collapse All"}
+    </Button>
+
+    <Collapsible
+        collapsed={isCollapsed}
+        icon={["plus", "minus"]}
+        padding="none"
+    >
+      <Collapsible.Main padding="sm" 
+          {...props}
+      >
+          <div>{"Main Section"}</div>
+      </Collapsible.Main>
+      <Collapsible.Content>
+          <div>
+            {
+              "Lorem ipsum dolor sit amet, consectetur adipiscing elit. In vel erat sed purus hendrerit viverra. Duis et vestibulum metus. Sed consequat ut ante non vehicula. Etiam nunc massa, pharetra vel quam id, posuere rhoncus quam. Quisque imperdiet arcu enim, nec aliquet justo auctor eget. Curabitur in metus nec nunc rhoncus faucibus vitae ac elit."
+            }
+          </div>
+      </Collapsible.Content>
+    </Collapsible>
+    <Collapsible
+        collapsed={isCollapsed}
+        icon={["plus", "minus"]}
+        padding="none"
+    >
+      <Collapsible.Main padding="sm" 
+          {...props}
+      >
+          <div>{"Main Section"}</div>
+      </Collapsible.Main>
+      <Collapsible.Content>
+          <div>
+            {
+              "Lorem ipsum dolor sit amet, consectetur adipiscing elit. In vel erat sed purus hendrerit viverra. Duis et vestibulum metus. Sed consequat ut ante non vehicula. Etiam nunc massa, pharetra vel quam id, posuere rhoncus quam. Quisque imperdiet arcu enim, nec aliquet justo auctor eget. Curabitur in metus nec nunc rhoncus faucibus vitae ac elit."
+            }
+          </div>
+      </Collapsible.Content>
+    </Collapsible>
+    <Collapsible
+        collapsed={isCollapsed}
+        icon={["plus", "minus"]}
+        padding="none"
+    >
+        <Collapsible.Main padding="sm" 
+            {...props}
+        >
+          <div>{"Main Section"}</div>
+        </Collapsible.Main>
+        <Collapsible.Content>
+          <div>
+            {
+              "Lorem ipsum dolor sit amet, consectetur adipiscing elit. In vel erat sed purus hendrerit viverra. Duis et vestibulum metus. Sed consequat ut ante non vehicula. Etiam nunc massa, pharetra vel quam id, posuere rhoncus quam. Quisque imperdiet arcu enim, nec aliquet justo auctor eget. Curabitur in metus nec nunc rhoncus faucibus vitae ac elit."
+            }
+          </div>
+        </Collapsible.Content>
+    </Collapsible>
+  </>
+  )
+}
+
+export default CollapsibleState

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

@@ -0,0 +1,3 @@
+The `collapsed` prop allows you to toggle the collapsible with external controls (like buttons) when used in conjunction with our `useCollapsible` hook.
+ 
+NOTE: you must import and declare the `useCollapsible` hook then pass its state to the collapsed prop of any Collapsible you wish to manage with the external control. See our code example for details.

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

@@ -2,12 +2,13 @@ examples:
 
   rails:
   - collapsible_default: Default
-  - collapsible_size: Size
-  - collapsible_color: Color
-  # - collapsible_icons: Custom Icons
+  - collapsible_size: Icon Size
+  - collapsible_color: Icon Color
+  - collapsible_icons: Custom Icons
 
   react:
   - collapsible_default: Default
-  - collapsible_size: Size
-  - collapsible_color: Color
-  # - collapsible_icons: Custom Icons
+  - collapsible_size: Icon Size
+  - collapsible_color: Icon Color
+  - collapsible_icons: Custom Icons
+  - collapsible_state: useCollapsible Hook

data/app/pb_kits/playbook/pb_collapsible/docs/index.js

@@ -1,4 +1,5 @@
 export { default as CollapsibleDefault } from './_collapsible_default.jsx'
 export { default as CollapsibleSize } from './_collapsible_size.jsx'
 export { default as CollapsibleColor } from './_collapsible_color.jsx'
-export { default as CollapsibleIcons } from './_collapsible_icons.jsx'
+export { default as CollapsibleIcons } from './_collapsible_icons.jsx'
+export {default as CollapsibleState } from './_collapsible_state.jsx'

data/app/pb_kits/playbook/pb_date/docs/_date_alignment.jsx

@@ -7,7 +7,7 @@ const DateAlignment = (props) => {
       <FormattedDate
           dayOfWeek
           icon
-          value="1995-12-25"
+          value={new Date('25 Dec 1995')}
           {...props}
       />
 
@@ -17,7 +17,7 @@ const DateAlignment = (props) => {
           alignment="center"
           dayOfWeek
           icon
-          value="2020-12-25"
+          value={new Date('25 Dec 2020')}
           {...props}
       />
 

data/app/pb_kits/playbook/pb_date/docs/_date_default.jsx

@@ -1,5 +1,5 @@
 import React from 'react'
-import { Date as FormattedDate } from '../../'
+import { Date as FormattedDate, Caption, Title } from '../../'
 
 const DateDefault = (props) => {
   return (
@@ -12,9 +12,20 @@ const DateDefault = (props) => {
 
       <br />
 
+      <div style={{display: "flex", columnGap: 4}}>
+        <FormattedDate
+            size="sm"
+            value={"2012-08-03"}
+            {...props}
+        />
+        <Caption>{"(Hyphenated Date)"}</Caption>
+      </div>
+
+      <br />
+
       <FormattedDate
           size="sm"
-          value="2012-08-03"
+          value={new Date('03 Aug 2012')}
           {...props}
       />
 
@@ -23,7 +34,7 @@ const DateDefault = (props) => {
       <FormattedDate
           showDayOfWeek
           size="sm"
-          value="2017-12-03"
+          value={new Date('03 Dec 2017')}
           {...props}
       />
 
@@ -37,8 +48,21 @@ const DateDefault = (props) => {
 
       <br />
 
+      <div style={{display: "flex", columnGap: 4}}>
+        <FormattedDate
+            value={"2012-08-03"}
+            {...props}
+        />
+        <Title
+            size={4}
+            text={"(Hyphenated Date)"}
+        />
+      </div>
+
+      <br />
+
       <FormattedDate
-          value="2012-08-03"
+          value={new Date('03 Aug 2012')}
           {...props}
       />
 
@@ -46,7 +70,7 @@ const DateDefault = (props) => {
 
       <FormattedDate
           showDayOfWeek
-          value="2017-12-03"
+          value={new Date('03 Dec 2017')}
           {...props}
       />
     </>

data/app/pb_kits/playbook/pb_date/docs/_date_unstyled.jsx

@@ -21,7 +21,7 @@ const DateUnstyled = (props) => {
       <Title size={1}>
         <FormattedDate
             unstyled
-            value="1995-12-25"
+            value={new Date('25 Dec 1995')}
             {...props}
         />
       </Title>
@@ -36,7 +36,7 @@ const DateUnstyled = (props) => {
             showDayOfWeek
             showIcon
             unstyled
-            value="1995-12-25"
+            value={new Date('25 Dec 1995')}
             {...props}
         />
       </Caption>

data/app/pb_kits/playbook/pb_date/docs/_date_variants.jsx

@@ -7,7 +7,7 @@ const DateVariants = (props) => {
       <FormattedDate
           showIcon
           size="sm"
-          value="1995-12-25"
+          value={new Date('25 Dec 1995')}
           {...props}
       />
 
@@ -15,7 +15,7 @@ const DateVariants = (props) => {
       <br />
 
       <FormattedDate
-          value="1995-12-25"
+          value={new Date('25 Dec 1995')}
           {...props}
       />
 
@@ -24,7 +24,7 @@ const DateVariants = (props) => {
 
       <FormattedDate
           showIcon
-          value="1995-12-25"
+          value={new Date('25 Dec 1995')}
           {...props}
       />
 
@@ -33,7 +33,7 @@ const DateVariants = (props) => {
 
       <FormattedDate
           showDayOfWeek
-          value="1995-12-25"
+          value={new Date('25 Dec 1995')}
           {...props}
       />
 
@@ -43,7 +43,7 @@ const DateVariants = (props) => {
       <FormattedDate
           showDayOfWeek
           showIcon
-          value="1995-12-25"
+          value={new Date('25 Dec 1995')}
           {...props}
       />
     </div>

data/app/pb_kits/playbook/pb_nav/docs/_collapsible_nav.jsx

@@ -1,14 +1,16 @@
 import React from "react";
-
-import Nav from "../_nav";
-import NavItem from "../_item";
+import { Nav, NavItem } from '../..'
 
 const CollapsibleNav = (props) => {
   return (
-    <Nav variant="subtle">
+    <Nav>
       <NavItem
+          active
           collapsible 
+          collapsibleTrail
+          fontWeight="bold"
           iconLeft="city" 
+          iconRight={["plus", "minus"]}
           link="#" 
           text="Overview" 
           {...props}
@@ -30,9 +32,11 @@ const CollapsibleNav = (props) => {
         />
       </NavItem>
       <NavItem 
-          active 
           collapsible 
+          collapsibleTrail
+          // fontWeight="bold"
           iconLeft="theater-masks"
+          iconRight={["plus", "minus"]}
           link="#" 
           text="Albums" 
           {...props}
@@ -55,7 +59,10 @@ const CollapsibleNav = (props) => {
       </NavItem>
       <NavItem 
           collapsible 
+          collapsibleTrail
+          // fontWeight="bold"
           iconLeft="city" 
+          iconRight={["plus", "minus"]}
           link="#" 
           text="Similar Artists" 
           {...props}
@@ -80,4 +87,4 @@ const CollapsibleNav = (props) => {
   );
 };
 
-export default CollapsibleNav;
+export default CollapsibleNav

data/app/pb_kits/playbook/pb_nav/docs/_collapsible_nav.md

@@ -0,0 +1 @@
+The `collapsible` prop allows users to create a nested, collapsible nav. Pass `collapsible` to NavItem and nest as many more NavItems as needed as children for that NavItem to see this in action. 

data/app/pb_kits/playbook/pb_nav/docs/_collapsible_nav_custom.jsx

@@ -0,0 +1,58 @@
+import React from "react"
+import { Nav, NavItem, useCollapsible } from "../.."
+
+const CollapsibleNavCustom = (props) => {
+  const navItems = ["Overview", "Albums", "Similar Artists"]
+  // eslint-disable-next-line react-hooks/rules-of-hooks
+  const collapsibles = navItems.map(() => useCollapsible(true))
+
+  const handleMainClick = (index) => {
+    collapsibles.forEach(([, , setCollapsed], idx) => {
+      if (idx === index) {
+        setCollapsed(false)
+      } else {
+        setCollapsed(true)
+      }
+    })
+  }
+
+  return (
+    <>
+      <Nav variant='bold'>
+        {navItems.map((text, index) => {
+          const [collapsed] = collapsibles[index]
+          return (
+            <NavItem
+                collapsed={collapsed}
+                collapsible
+                collapsibleTrail
+                fontWeight="bold"
+                iconLeft="chevron-down"
+                id={`collapsible-nav-item-${index + 1}`}
+                key={index}
+                link="#"
+                onClick={() => handleMainClick(index)}
+                text={text}
+                {...props}
+            >
+              <NavItem link="#" 
+                  text="City" 
+                  {...props} 
+              />
+              <NavItem link="#" 
+                  text="People" 
+                  {...props} 
+              />
+              <NavItem link="#" 
+                  text="Business" 
+                  {...props} 
+              />
+            </NavItem>
+          );
+        })}
+      </Nav>
+    </>
+  )
+}
+
+export default CollapsibleNavCustom

data/app/pb_kits/playbook/pb_nav/docs/_collapsible_nav_custom.md

@@ -0,0 +1 @@
+The collapsible nav kit uses our Collapsible kit under the hood and as such the `useCollapsible` hook can be used to achieve custom toggling of the collapsible nav. To do this, you must import and declare the `useCollapsible` hook and pass it's state to the `collapsed` prop. See our code example below to see how this can be done. 

data/app/pb_kits/playbook/pb_nav/docs/_collapsible_nav_emphasize.html.erb

@@ -0,0 +1,23 @@
+<%= pb_rails("nav", props: { variant: "subtle" }) do %>
+    <%= pb_rails("nav/item", props: { text: "Overview", link: "#", font_weight:"bold", font_size:"small", collapsible: true, icon_left:"city" }) do %>
+        <%= pb_rails("nav", props: { variant: "subtle" }) do %>
+            <%= pb_rails("nav/item", props: { text: "City", link: "#" }) %>
+            <%= pb_rails("nav/item", props: { text: "People", link: "#" }) %>
+            <%= pb_rails("nav/item", props: { text: "Business", link: "#" }) %>
+        <% end %>
+    <% end %>
+    <%= pb_rails("nav/item", props: { text: "Albums", link: "#", font_weight:"bold", font_size:"small", collapsible: true, icon_left: "theater-masks" }) do %>
+        <%= pb_rails("nav", props: { variant: "subtle" }) do %>
+            <%= pb_rails("nav/item", props: { text: "Entertainment", link: "#" }) %>
+            <%= pb_rails("nav/item", props: { text: "Food", link: "#" }) %>
+            <%= pb_rails("nav/item", props: { text: "Style", link: "#" }) %>
+        <% end %>
+    <% end %>
+    <%= pb_rails("nav/item", props: { text: "Similar Artists", link: "#", font_weight:"bold", font_size:"small", collapsible: true, icon_left: "city" }) do %>
+        <%= pb_rails("nav", props: { variant: "subtle" }) do %>
+            <%= pb_rails("nav/item", props: { text: "City", link: "#" }) %>
+            <%= pb_rails("nav/item", props: { text: "People", link: "#" }) %>
+            <%= pb_rails("nav/item", props: { text: "Business", link: "#" }) %>
+        <% end %>
+    <% end %>
+  <% end %>