playbook_ui_docs 12.34.0 → 12.35.0.pre.alpha.iconpocwebfonts1023

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8227516eec172b5cf02f90d1099fa5b6f00923d90b87b6d59f4daafd03d48969
-  data.tar.gz: 3468130c34d95d2f006963b2c3c9b839cc5181fd6ee781675279099eb655488e
+  metadata.gz: b133254c95cf68ea3698e8b308425ec3b85a1042755417363c36a519560a268f
+  data.tar.gz: 694a2bc4f639a1fde0d03032d711bd3519e3c149abfd47c46d1fa06392331338
 SHA512:
-  metadata.gz: c59ca650353c827e8be9e022f8eb2747f381afe21122e3245c3a1e75affe246ad362729679af6fed3018b4b052dcc052fed43172e6e7f83a2edacbe04946a9ce
-  data.tar.gz: add17b9c4fbbd700e6cb875e51f7332dab652a9a30c4783a02b1bbe5f4baf4d47975c200e41f78a5313eaa5c5e3cad198f0bf2cb2533f011f984f886f041827f
+  metadata.gz: 33b59ed9e717697a58e0b60cc9c2846cb39b3ec40f7506f6f804e9962ca7fc92e995f22660e23aeb943affc468072d8a703d8de3d557ee0bac80c6f9ebb0e709
+  data.tar.gz: a9cce0332ff1ae96ade627c8210e2518fe773e2d4698a637c4a2e755964019eb898b3e812bd1927df43bacecb60d085cd734cfd6f70a27b7ee3b8348ba495af6

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

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

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

@@ -0,0 +1,10 @@
+<%= pb_rails("collapsible", props: { name: "custom-icons-example" }) do %>
+    <%= pb_rails("collapsible/collapsible_main", props: { padding: "md", name: "custom-icons-main", icon: ["plus", "minus"]}) do %>
+      <%= pb_rails("body", props: { text: "Main Section"}) %>
+    <% end %>
+    <%= pb_rails("collapsible/collapsible_content", props: { padding: "md" }) do %>
+      Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec iaculis, risus a fringilla luctus, sapien eros sodales ex, quis molestie est nulla non turpis. Vestibulum aliquet at ipsum eget posuere. Morbi sed laoreet erat. Sed commodo posuere lectus, at porta nulla ornare a. Suspendisse quam est, sollicitudin ut enim sit amet, commodo placerat enim. Donec laoreet metus ac mauris pellentesque mattis. Pellentesque luctus vel mauris non aliquam. Mauris hendrerit mattis porttitor. Curabitur vehicula justo non ex consectetur commodo. Quisque posuere aliquet quam. Maecenas malesuada magna mauris, ac tempor metus euismod at.
+      <br><br>
+      Cras ornare fermentum magna mollis efficitur. Sed vitae nulla vel purus ultrices mollis. Maecenas id nulla id libero faucibus feugiat quis sit amet turpis. In commodo pellentesque risus at fringilla. Integer non interdum leo, non commodo ante. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut mi augue, dignissim at orci vel, egestas aliquam mi. Proin finibus aliquet tempor. Integer cursus, ex quis gravida rhoncus, nisi elit viverra ipsum, non efficitur est ex ac tortor. Praesent vitae odio massa.
+    <% end %>
+  <% end %>

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

@@ -0,0 +1,19 @@
+import React from 'react'
+import { Collapsible } from '../..'
+
+const CollapsibleIcons = () => (
+  <Collapsible icon={['plus','minus']}>
+    <Collapsible.Main>
+      <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. Nulla facilisi. Vestibulum quis pretium nulla. Nulla ut accumsan velit. Duis varius urna sed sem tempor, sit amet fermentum nibh auctor. Praesent lorem arcu, egestas non ante quis, placerat pellentesque lectus.Vestibulum lacinia ipsum quis venenatis tristique. Vivamus suscipit, libero eu fringilla egestas, orci urna commodo arcu, vel gravida turpis ipsum molestie nibh. Donec cursus eu ante sagittis ultrices. Phasellus id sagittis risus. Mauris dapibus neque faucibus, tempor ligula vel, cursus ante. Donec faucibus gravida porta. Nullam egestas est quis aliquam feugiat. Sed eget metus diam. Cras eget placerat libero.'
+        }
+      </div>
+    </Collapsible.Content>
+  </Collapsible>
+)
+
+export default CollapsibleIcons

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

@@ -0,0 +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']`

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

@@ -1,4 +1,4 @@
 ##### Prop
-This kit uses `icon` sizes. If you don't give it a size, it will default to medium. You can be replaced with the sizes below:
+This kit uses `icon` sizes. If you don't give it a size, it will default to medium. This can be replaced with the sizes below:
 
 * `lg` `xs` `sm` `1x` `2x` `3x` `4x` `5x` `6x` `7x` `8x` `9x` `10x`

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

@@ -4,8 +4,10 @@ examples:
   - collapsible_default: Default
   - collapsible_size: Size
   - collapsible_color: Color
+  # - collapsible_icons: Custom Icons
 
   react:
   - collapsible_default: Default
   - collapsible_size: Size
-  - collapsible_color: Color
+  - collapsible_color: Color
+  # - collapsible_icons: Custom Icons

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

@@ -1,3 +1,4 @@
 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'

data/app/pb_kits/playbook/pb_highlight/docs/_highlight_default.html.erb

@@ -1,20 +1,10 @@
 
-<%= pb_rails("highlight", props: {text: "Highlight Kit"})%>
-<br>
-<br>
-<%= pb_rails("title", props: {text: "Kit wrapping",size: 4})%>
-<br>
 <%= pb_rails("body") do%>
-This an example<%= pb_rails("highlight") do%>Highlight Example<% end %>around.
+    This is the <%= pb_rails("highlight") do%>Highlight Kit<% end %>.
 <% end %>
-<br>
-<br>
-<%= pb_rails("title", props: {text: "Search",size: 4})%>
-<br>
-<%= pb_rails("body", props: {text: "hello helpers are great even highlighting this", highlighting: true, highlighted_text: ["hello","great"]})%>
 
-<br>
-<br>
-<%= pb_rails("caption", props: {size: "xs", text: "To enable highlighting make sure the [highlighting] flag is set to true. "}) %>
-<br>
-<br>
+<%= pb_rails("body", props: {padding_bottom: "md"}) do%>
+    Hello this is a <%= pb_rails("highlight") do%>highlight<% end %> wrapped.
+<% end %>
+
+<%= pb_rails("body", props: {text: "This is text highlighted in the Body Kit using the text prop.", highlighting: true, highlighted_text: ["highlighted", "Body Kit"]})%>

data/app/pb_kits/playbook/pb_highlight/docs/_highlight_default.jsx

@@ -7,7 +7,7 @@ const HighlightDefault = (props) => (
   <div>
     <Highlight
         highlightedText={['highlight kit']}
-        text="This is the Highlight Kit"
+        text="This is the Highlight Kit."
         {...props}
     />
     <br />
@@ -15,7 +15,7 @@ const HighlightDefault = (props) => (
       {' '}
       {'Hello this is a'}
       {' '}
-      <Highlight text=" highlight wrapped"/>
+      <Highlight text=" highlight wrapped."/>
     </Body>
     <br />
     <Body

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

@@ -3,7 +3,5 @@ examples:
   rails:
   - highlight_default: Default
   
-  
   react:
   - highlight_default: Default
-  

data/app/pb_kits/playbook/pb_icon/docs/_icon_font.html.erb

@@ -0,0 +1,11 @@
+<div>
+<%= pb_rails("icon", props: { icon: "bumper-plates", font_family: "boxboard", prefix: "icon", size: "5x"} ) %>
+<%= pb_rails("icon", props: { icon: "boxboard", font_family: "boxboard", prefix: "icon", size: "5x", padding_left: "md"} ) %>
+<%= pb_rails("icon", props: { icon: "workout-journal", font_family: "boxboard", prefix: "icon", size: "5x", padding_left: "md"} ) %>
+</div>
+
+<div>
+<%= pb_rails("icon", props: { icon: "sushi", font_family: "boxicons", prefix: "bx bx", size: "5x", margin_top: "lg"} ) %>
+<%= pb_rails("icon", props: { icon: "bowl-rice", font_family: "boxicons", prefix: "bx bx", size: "5x", padding_left: "md"} ) %>
+<%= pb_rails("icon", props: { icon: "party", font_family: "boxicons", prefix: "bx bx", size: "5x", padding_left: "md"} ) %>
+</div>

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

@@ -9,6 +9,7 @@ examples:
   - icon_sizes: Icon Sizes
   - icon_custom: Icon Custom
   - icon_fa_kit: Icon with FontAwesome Kit
+  - icon_font: Bring Your Own Icon Font
 
   react:
   - icon_default: Icon Default

data/app/pb_kits/playbook/pb_message/docs/_message_mentions.html.erb

@@ -0,0 +1,24 @@
+<%= pb_rails("message", props: {
+  label: "Keith Craig",
+  timestamp: "2 days ago",
+  avatar_name: "Keith Craig",
+  padding_bottom: "md"
+}) do %>
+  <%= pb_rails("message/message_mention", props: { variant: "user" }) do %>
+    @all
+  <% end %> let's welcome 
+  <%= pb_rails("message/message_mention", props: { variant: "self" }) do %>
+    @Lucille Sanchez
+  <% end %> to the team this week!
+<% end %>
+
+<%= pb_rails("message", props: {
+  label: "Lucille Sanchez",
+  timestamp: "2 days ago",
+  avatar_name: "Lucille Sanchez",
+  avatar_url: "https://randomuser.me/api/portraits/women/50.jpg"
+}) do %>
+  <%= pb_rails("message/message_mention", props: {variant: "self"}) do %>
+    @Keith Craig
+  <% end %> thanks for the warm welcome! I'm so excited!
+<% end %>

data/app/pb_kits/playbook/pb_message/docs/_message_mentions.jsx

@@ -0,0 +1,31 @@
+import React from "react"
+import Message from "../_message"
+
+const MessageDefault = (props) => {
+    return (
+        <>
+            <Message
+                avatarName='Keith Craig'
+                label='Keith Craig'
+                paddingBottom="md"
+                timestamp='2 days ago'
+                {...props}
+            >
+                <Message.Mention variant='user'>{'@all'}</Message.Mention>{` let's welcome `}
+                <Message.Mention variant='self'>{'@Lucille Sanchez'}</Message.Mention>{' to the team this week!'}
+            </Message>
+
+            <Message
+                avatarName='Lucille Sanchez'
+                avatarUrl='https://randomuser.me/api/portraits/women/50.jpg'
+                label='Lucille Sanchez'
+                timestamp='2 days ago'
+                {...props}
+            >
+                <Message.Mention variant='self'>{'@Keith Craig'}</Message.Mention>{` thanks for the warm welcome! I'm so excited!`}
+            </Message>
+        </>
+    )
+}
+
+export default MessageDefault

data/app/pb_kits/playbook/pb_message/docs/_message_mentions.md

@@ -0,0 +1 @@
+The message kit also supports @mentions using a [compound component](https://kentcdodds.com/blog/compound-components-with-react-hooks) structure. See the code example for details on how to pass user mentions through your messages.

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

@@ -4,10 +4,10 @@ examples:
   - message_default: Default
   - message_timestamp: With Timestamp Hover
   - message_hover: Hover
-
+  - message_mentions: Mentions
 
   react:
   - message_default: Default
   - message_timestamp: With Timestamp Hover
   - message_hover: Hover
-
+  - message_mentions: Mentions

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

@@ -1,4 +1,4 @@
 export { default as MessageDefault } from './_message_default.jsx'
 export { default as MessageTimestamp } from './_message_timestamp.jsx'
 export { default as MessageHover } from './_message_hover.jsx'
-
+export { default as MessageMentions } from './_message_mentions.jsx'

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

@@ -0,0 +1,24 @@
+<%= pb_rails("nav", props: { variant: "subtle" }) do %>
+    <%= pb_rails("nav/item", props: { text: "Overview", link: "#", 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: "#", active: true, 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: "#", 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 %>
+  

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

@@ -0,0 +1,83 @@
+import React from "react";
+
+import Nav from "../_nav";
+import NavItem from "../_item";
+
+const CollapsibleNav = (props) => {
+  return (
+    <Nav variant="subtle">
+      <NavItem
+          collapsible 
+          iconLeft="city" 
+          link="#" 
+          text="Overview" 
+          {...props}
+      >
+        <NavItem
+            link="#" 
+            text="City"
+            {...props}
+        />
+        <NavItem
+            link="#"
+            text="People"
+            {...props}
+        />
+        <NavItem 
+            link="#" 
+            text="Business" 
+            {...props}
+        />
+      </NavItem>
+      <NavItem 
+          active 
+          collapsible 
+          iconLeft="theater-masks"
+          link="#" 
+          text="Albums" 
+          {...props}
+      >
+        <NavItem 
+            link="#" 
+            text="Entertainment" 
+            {...props}
+        />
+        <NavItem 
+            link="#" 
+            text="Food" 
+            {...props}
+        />
+        <NavItem 
+            link="#" 
+            text="Style" 
+            {...props}
+        />
+      </NavItem>
+      <NavItem 
+          collapsible 
+          iconLeft="city" 
+          link="#" 
+          text="Similar Artists" 
+          {...props}
+      >
+        <NavItem 
+            link="#" 
+            text="City"
+            {...props} 
+        />
+        <NavItem
+            link="#"
+            text="People"
+            {...props}
+        />
+        <NavItem 
+            link="#" 
+            text="Business" 
+            {...props}
+        />
+      </NavItem>
+    </Nav>
+  );
+};
+
+export default CollapsibleNav;

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

@@ -0,0 +1,86 @@
+import React from "react";
+
+import Nav from "../_nav";
+import NavItem from "../_item";
+
+const CollapsibleNavCustomIcons = (props) => {
+  return (
+    <Nav variant="subtle">
+      <NavItem
+          collapsible 
+          iconLeft="city" 
+          iconRight={["chevron-down", "chevron-up"]}
+          link="#" 
+          text="Overview" 
+          {...props}
+      >
+        <NavItem
+            link="#" 
+            text="City"
+            {...props}
+        />
+        <NavItem
+            link="#"
+            text="People"
+            {...props}
+        />
+        <NavItem 
+            link="#" 
+            text="Business" 
+            {...props}
+        />
+      </NavItem>
+      <NavItem 
+          active 
+          collapsible 
+          iconLeft="theater-masks"
+          iconRight={["chevron-down", "chevron-up"]}
+          link="#" 
+          text="Albums" 
+          {...props}
+      >
+        <NavItem 
+            link="#" 
+            text="Entertainment" 
+            {...props}
+        />
+        <NavItem 
+            link="#" 
+            text="Food" 
+            {...props}
+        />
+        <NavItem 
+            link="#" 
+            text="Style" 
+            {...props}
+        />
+      </NavItem>
+      <NavItem 
+          collapsible 
+          iconLeft="city" 
+          iconRight={["chevron-down", "chevron-up"]}
+          link="#" 
+          text="Similar Artists" 
+          {...props}
+      >
+        <NavItem 
+            link="#" 
+            text="City"
+            {...props} 
+        />
+        <NavItem
+            link="#"
+            text="People"
+            {...props}
+        />
+        <NavItem 
+            link="#" 
+            text="Business" 
+            {...props}
+        />
+      </NavItem>
+    </Nav>
+  );
+};
+
+export default CollapsibleNavCustomIcons;

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

@@ -7,6 +7,7 @@ examples:
   - borderless_nav: No Borders
   - subtle_nav: Subtle Variant
   - subtle_with_icons_nav: Subtle With Icons
+  # - collapsible_nav: Subtle With Collapsible
   - subtle_no_highlight_nav: Subtle No Highlight
   - bold_vertical_nav: Bold Variant
   - horizontal_nav: Horizontal Nav
@@ -24,6 +25,8 @@ examples:
   - borderless_nav: No Borders
   - subtle_nav: Subtle Variant
   - subtle_with_icons_nav: Subtle With Icons
+  # - collapsible_nav: Subtle With Collapsible
+  # - collapsible_nav_custom_icons: Subtle With Collapsible (Custom Toggle Icons)
   - subtle_no_highlight_nav: Subtle No Highlight
   - bold_vertical_nav: Bold Variant
   - horizontal_nav: Horizontal Nav

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

@@ -13,3 +13,5 @@ export { default as WithImgNav } from './_with_img_nav.jsx'
 export { default as NewTab } from './_new_tab.jsx'
 export { default as BoldHorizontalNav } from './_bold_horizontal_nav.jsx'
 export { default as BoldVerticalNav } from './_bold_vertical_nav.jsx'
+export { default as CollapsibleNav } from './_collapsible_nav.jsx'
+export { default as CollapsibleNavCustomIcons } from './_collapsible_nav_custom_icons.jsx'