playbook_ui 8.0.0.pre.alpha4 → 8.2.0.pre.alpha1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '061590a33e32cccf2c0a6b1f434921d84723d0bcbbdbbc088fd3b5f3d13cb978'
-  data.tar.gz: '01921feae3d387c46af5f4c9e05121df1808fddaa37f18c842fcb61d68efd33b'
+  metadata.gz: a9372b2a0d2e36aab28186cfe5988ec72e62cce82525ebf3bfb5886c7eff1ae6
+  data.tar.gz: 758cacaf5bd93949d6673680da6ffe90d37079508d0580dda1a956c8d15f965f
 SHA512:
-  metadata.gz: 05f0cc3aed39dda97c7bff82f2630b05b26242623ea00848f0b0efd327dccd1087cd95ddda329a78ded17139ec7c4e715dec853b485da79d0f1a9dbeac978656
-  data.tar.gz: ba4974ce61c5a6b1f56f3bb3aae34cc63000dd22db441d2387c506e5c924947013575840e36cecab9272d731cd4a1337d25d4e8944d5520037a085b644a24af6
+  metadata.gz: 6a9e10a2e3a90ce39438f1d47c600463ddb7ee2a168a411edd783b53dfccdcfa2b4b8c864c714bd13fd3bcfbb54b1e56da87529dabf6ea812d802164f0a860bd
+  data.tar.gz: 8a984eb608eb57dde4d1e5e1c71984bcdce86b349c405f7bc9b11d94f72e229ead4de53e7263fbea38a748d6064e901627612d65338e60dc7b4a4447662d95ef

data/app/pb_kits/playbook/_playbook.scss

@@ -1,11 +1,11 @@
-@import "tokens/fonts";
-@import "pb_background/background";
-@import "pb_body/body";
-@import "pb_button/button";
+@import 'tokens/fonts';
+@import 'pb_background/background';
+@import 'pb_body/body';
+@import 'pb_button/button';
 @import 'pb_button_toolbar/button_toolbar';
-@import "pb_caption/caption";
-@import "pb_card/card";
-@import "pb_title/title";
+@import 'pb_caption/caption';
+@import 'pb_card/card';
+@import 'pb_title/title';
 @import 'pb_avatar/avatar';
 @import 'pb_avatar_action_button/avatar_action_button';
 @import 'pb_badge/badge';
@@ -13,6 +13,7 @@
 @import 'pb_checkbox/checkbox';
 @import 'pb_circle_chart/circle_chart';
 @import 'pb_circle_icon_button/circle_icon_button';
+@import 'pb_collapsible/collapsible';
 @import 'pb_contact/contact';
 @import 'pb_currency/currency';
 @import 'pb_dashboard_value/dashboard_value';

data/app/pb_kits/playbook/data/menu.yml

@@ -8,6 +8,7 @@ kits:
     - circle_icon_button
   - card
   - checkbox
+  - collapsible
   - charts_and_graphs:
     - bar_graph
     - circle_chart

data/app/pb_kits/playbook/index.js

@@ -17,6 +17,7 @@ export Card from './pb_card/_card.jsx'
 export Checkbox from './pb_checkbox/_checkbox.jsx'
 export CircleChart from './pb_circle_chart/_circle_chart.jsx'
 export CircleIconButton from './pb_circle_icon_button/_circle_icon_button.jsx'
+export Collapsible from './pb_collapsible/_collapsible.jsx'
 export Contact from './pb_contact/_contact.jsx'
 export Currency from './pb_currency/_currency.jsx'
 export DashboardValue from './pb_dashboard_value/_dashboard_value.jsx'

data/app/pb_kits/playbook/pb_card/card_header.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
 module Playbook
-    module PbCard
-      class CardHeader < Playbook::KitBase
-        prop :header_color, type: Playbook::Props::String,
-                            default: "category_1"
+  module PbCard
+    class CardHeader < Playbook::KitBase
+      prop :header_color, type: Playbook::Props::String,
+                          default: "category_1"
 
-        def classname
-          generate_classname("pb_card_header_kit", header_color)
-        end
+      def classname
+        generate_classname("pb_card_header_kit", header_color)
       end
     end
   end
+end

data/app/pb_kits/playbook/pb_collapsible/_collapsible.jsx

@@ -0,0 +1,84 @@
+/* @flow */
+
+import classnames from 'classnames'
+import React, { useState } from 'react'
+import { globalProps } from '../utilities/globalProps.js'
+import { buildAriaProps, buildCss, buildDataProps } from '../utilities/props'
+import CollapsibleContent from './child_kits/CollapsibleContent'
+import CollapsibleMain from './child_kits/CollapsibleMain'
+
+export const CollapsibleContext = React.createContext({})
+
+type CollapsibleProps = {
+  children: CollapsibleMain | CollapsibleContent | ReactNode,
+  aria?: object,
+  className?: string,
+  collapsed?: boolean,
+  data?: object,
+  id?: string,
+  padding?: string,
+}
+
+const useCollapsible = (initial = false) => {
+  const [collapsed, setCollapsed] = useState(initial)
+
+  return [
+    collapsed,
+    () => setCollapsed((t) => !t),
+  ]
+}
+
+const Collapsible = ({
+  aria = {},
+  className,
+  children = [],
+  collapsed = true,
+  data = {},
+  id,
+  padding = 'md',
+  ...props
+}: CollapsibleProps) => {
+  const [isCollapsed, collapse] = useCollapsible(collapsed)
+  const CollapsibleParent = React.Children.toArray(children)
+
+  if (CollapsibleParent.length !== 2) {
+    throw new Error('Collapsible requires <CollapsibleMain> and <CollapsibleContent> to function properly.')
+  }
+
+  const Main = CollapsibleParent[0]
+  const Content = CollapsibleParent[1]
+
+  const { children: mainChildren, ...mainProps } = Main.props
+  const { children: contentChildren, ...contentProps } = Content.props
+  const ariaProps = buildAriaProps(aria)
+  const dataProps = buildDataProps(data)
+  const classes = classnames(
+    buildCss('pb_collapsible'),
+    className,
+    globalProps(props, { padding })
+  )
+
+  return (
+    <CollapsibleContext.Provider value={{ collapsed: isCollapsed, collapse }}>
+      <div
+          {...ariaProps}
+          {...dataProps}
+          className={classes}
+          id={id}
+      >
+        <CollapsibleMain {...mainProps}>
+          {mainChildren}
+        </CollapsibleMain>
+
+        <CollapsibleContent {...contentProps}>
+          {contentChildren}
+        </CollapsibleContent>
+      </div>
+    </CollapsibleContext.Provider>
+  )
+}
+
+Collapsible.Main = CollapsibleMain
+Collapsible.Content = CollapsibleContent
+
+export default Collapsible

data/app/pb_kits/playbook/pb_collapsible/_collapsible.scss

@@ -0,0 +1,15 @@
+[class^=pb_collapsible_kit] {
+  .toggle-content {
+    display: none;
+    height: 0;
+    padding-bottom: 0 !important;
+    padding-top: 0 !important;
+    overflow: hidden;
+    transition: height 300ms, padding 300ms ease-in-out;
+  }
+
+  .toggle-content.is-visible {
+    display: block;
+    height: auto;
+  }
+}

data/app/pb_kits/playbook/pb_collapsible/child_kits/CollapsibleContent.jsx

@@ -0,0 +1,40 @@
+/* @flow */
+
+import classnames from 'classnames'
+import React, { useContext } from 'react'
+import AnimateHeight from 'react-animate-height'
+import { buildCss } from '../../utilities/props'
+import { globalProps } from '../../utilities/globalProps.js'
+
+import { CollapsibleContext } from '../_collapsible.jsx'
+
+type CollapsibleContentProps = {
+  children: array<React.ReactNode> | React.ReactNode | string,
+  className?: string,
+  padding?: string,
+}
+
+const CollapsibleContent = ({
+  children,
+  className,
+  padding = 'md',
+  ...props
+}: CollapsibleContentProps) => {
+  const context = useContext(CollapsibleContext)
+  const contentCSS = buildCss('pb_collapsible_content_kit')
+  const contentSpacing = globalProps(props, { padding })
+
+  return (
+    <div className={classnames(contentCSS, className, contentSpacing)}>
+      <AnimateHeight
+          duration={300}
+          height={context.collapsed ? 0 : 'auto'}
+          id="bottom-section"
+      >
+        {children}
+      </AnimateHeight>
+    </div>
+  )
+}
+
+export default CollapsibleContent

data/app/pb_kits/playbook/pb_collapsible/child_kits/CollapsibleMain.jsx

@@ -0,0 +1,59 @@
+/* @flow */
+
+import classnames from 'classnames'
+import { Flex, FlexItem } from '../../'
+import React, { useContext } from 'react'
+import { buildCss } from '../../utilities/props'
+import { globalProps } from '../../utilities/globalProps.js'
+
+import { CollapsibleContext } from '../_collapsible.jsx'
+
+type CollapsibleMainProps = {
+  children: array<React.ReactNode> | React.ReactNode,
+  className?: string,
+  padding?: string,
+}
+
+type IconProps = {
+  collapsed: boolean
+}
+
+const Icon = ({ collapsed }: IconProps) => {
+  const direction = collapsed ? 'down' : 'up'
+
+  return (
+    <div
+        key={direction}
+        style={{ verticalAlign: 'middle' }}
+    >
+      <i className={`far fa-chevron-${direction} fa-fw`} />
+    </div>
+  )
+}
+
+const CollapsibleMain = ({
+  children,
+  className,
+  padding = 'md',
+  ...props
+}: CollapsibleMainProps) => {
+  const context = useContext(CollapsibleContext)
+  const mainCSS = buildCss('pb_collapsible_main_kit')
+  const mainSpacing = globalProps(props, { padding })
+
+  return (
+    <div className={classnames(mainCSS, className, mainSpacing)}>
+      <div onClick={() => context.collapse()}>
+        <Flex
+            spacing="between"
+            vertical="center"
+        >
+          <FlexItem>{children}</FlexItem>
+          <FlexItem><Icon collapsed={context.collapsed} /></FlexItem>
+        </Flex>
+      </div>
+    </div>
+  )
+}
+
+export default CollapsibleMain

data/app/pb_kits/playbook/pb_collapsible/collapsible.html.erb

@@ -0,0 +1,7 @@
+<%= content_tag(:div,
+    aria: object.aria,
+    class: object.classname,
+    data: object.data,
+    id: object.id) do %>
+  <%= content.presence %>
+<% end %>

data/app/pb_kits/playbook/pb_collapsible/collapsible.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Playbook
+  module PbCollapsible
+    class Collapsible < Playbook::KitBase
+      def classname
+        generate_classname("pb_collapsible_kit")
+      end
+    end
+  end
+end

data/app/pb_kits/playbook/pb_collapsible/collapsible.test.js

@@ -0,0 +1,50 @@
+import React from 'react'
+import { render, screen } from '../utilities/test-utils'
+
+import Collapsible from './_collapsible'
+
+beforeEach(() => {
+  // Silences error logs within the test suite.
+  jest.spyOn(console, 'error')
+  // eslint-disable-next-line
+  console.error.mockImplementation(() => {})
+})
+
+afterEach(() => {
+  // eslint-disable-next-line
+  console.error.mockRestore()
+})
+
+const testId = 'collapsible1',
+  kitClass = 'pb_collapsible'
+
+test('throws error if incorrect # of children', () => {
+  expect(() => {
+    render(
+      <Collapsible />
+    )
+  }).toThrow()
+})
+
+test('returns namespaced additional_class class name', () => {
+  render(
+    <Collapsible
+        className="additional_class"
+        data={{ testid: testId }}
+    >
+      <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>
+  )
+
+  const kit = screen.getByTestId(testId)
+  expect(kit).toHaveClass(`${kitClass} additional_class`)
+})

data/app/pb_kits/playbook/pb_collapsible/collapsible_content.html.erb

@@ -0,0 +1,7 @@
+<%= content_tag(:div,
+    id: object.id,
+    data: object.data,
+    class: object.classname,
+    aria: object.aria) do %>
+  <%= content.presence %>
+<% end %>

data/app/pb_kits/playbook/pb_collapsible/collapsible_content.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Playbook
+  module PbCollapsible
+    class CollapsibleContent < Playbook::KitBase
+      def data
+        Hash(values[:data]).merge(
+          collapsible_content: true
+        )
+      end
+
+      def classname
+        generate_classname("pb_collapsible_content_kit", "toggle-content", padding, separator: " ")
+      end
+    end
+  end
+end

data/app/pb_kits/playbook/pb_collapsible/collapsible_main.html.erb

@@ -0,0 +1,16 @@
+<%= content_tag(:div,
+    id: object.id,
+    data: object.data,
+    class: object.classname,
+    aria: object.aria) do %>
+
+    <%= pb_rails("flex", props: {vertical: "center", spacing: "between"}) do %>
+      <%= pb_rails("flex/flex_item") do %>
+        <%= content.presence %>
+      <% end %>
+      <%= pb_rails("flex/flex_item") do %>
+        <i class="far fa-chevron-down"></i>
+        <i class="far fa-chevron-up" style="display: none"></i>
+      <% end %>
+    <% end %>
+<% end %>

data/app/pb_kits/playbook/pb_collapsible/collapsible_main.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Playbook
+  module PbCollapsible
+    class CollapsibleMain < Playbook::KitBase
+      def data
+        Hash(prop(:data)).merge(collapsible_main: true)
+      end
+
+      def classname
+        generate_classname("pb_collapsible_main_kit", padding, separator: " ")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+<%= pb_rails("collapsible", props: { name: "default-example" }) do %>
+  <%= pb_rails("collapsible/collapsible_main", props: { padding: "md", name: "default-main" }) 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_default.jsx

@@ -0,0 +1,19 @@
+import React from 'react'
+import { Collapsible } from '../..'
+
+const CollapsibleDefault = () => (
+  <Collapsible>
+    <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 CollapsibleDefault