playbook_ui 12.12.0 → 12.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52982a7fd482e46a592ec1dd33c640b2f4c3468c8c2c6ef89e63c2ac3aedc642
-  data.tar.gz: 9b01af38e5ed588b0d649a9ff770a3aa6529cf8673eec79919b197f9c1cdacaa
+  metadata.gz: a8ab799be2c717401ccd987c55ab580b5ad66ad4180ff3590e679aa9f8b20e1b
+  data.tar.gz: 1061a9d85bf0cc5c7ef7731a9747eb29ff51e9151bd51e6f5401daec9c66429f
 SHA512:
-  metadata.gz: a6c68065b2497b859a00255121fd7240cf0dc4f667c3c74ccccf1e59b6dae29d1a8c5146fe95780a1c9e5f90ced89fad71f79046a0c70b1723268e1674170b6d
-  data.tar.gz: '08ea2b02f9def8c1da0372a5a4b76a8740217256cb47582fda6d668736adbd936c7b086313a533a51ad0c1e809366068dfecf799dd5098b3d9296c83e374d638'
+  metadata.gz: 2a058d2ba141e6f0867018940f66dbdbd2be9ebc77d921e83d54a9f0113f037e4c356c38b1e050e3e5d6a4a58262095707dd54f3929fcafefea53e4e2b023026
+  data.tar.gz: 6bcbc50017600ac0915e86ce76c1b5a55cbc2cbda223f9e883121851382b146609a53dfe148ca11110629cd766bb8aa935c27edca1a773c46aaefdc89d374076

data/app/pb_kits/playbook/pb_flex/_flex.scss

@@ -2,6 +2,7 @@
 @import "../tokens/spacing";
 
 $gapSpaces:(
+  xxs:  $space_xxs,
   xs:   $space_xs,
   sm:   $space_sm,
   md:   $space_md,

data/app/pb_kits/playbook/pb_flex/_flex.tsx

@@ -2,6 +2,7 @@ import React from 'react'
 import classnames from 'classnames'
 import { buildCss, buildDataProps } from '../utilities/props'
 import { GlobalProps, globalProps } from '../utilities/globalProps'
+import { Sizes } from '../types'
 
 type FlexProps = {
   children: React.ReactChild[] | React.ReactNode,
@@ -16,9 +17,9 @@ type FlexProps = {
   reverse?: boolean,
   vertical?: "top" | "center" | "bottom" | "stretch" | "baseline" | "none",
   align?: "start" | "center" | "end" | "stretch" | "baseline" | "none",
-  gap?: "xs" | "sm" | "md" | "lg" | "xl" | "none",
-  rowGap?: "xs" | "sm" | "md" | "lg" | "xl" | "none",
-  columnGap?: "xs" | "sm" | "md" | "lg" | "xl" | "none",
+  gap?: Sizes | "none",
+  rowGap?: Sizes| "none",
+  columnGap?: Sizes| "none",
   wrap?: boolean,
   alignSelf?: "start" | "end" | "center" | "stretch" | "none"
 } & GlobalProps

data/app/pb_kits/playbook/pb_flex/docs/_flex_gap.html.erb

@@ -1,7 +1,7 @@
 <%= pb_rails("title", props: {size: 4, text: "Row"}) %>
 <br/>
 <div class="flex-doc-example">
-  <%= pb_rails("flex", props:{ gap: "xs", wrap:true}) do %>
+  <%= pb_rails("flex", props:{ gap: "xxs", wrap:true}) do %>
    <%40.times do |i|%>
     <%= pb_rails("flex/flex_item") do %> <%=i%> <% end %>
    <% end %>

data/app/pb_kits/playbook/pb_flex/docs/_flex_gap.jsx

@@ -14,7 +14,7 @@ const FlexGap = (props) => {
     <>
       <div className="flex-doc-example">
         <Flex
-            gap="xs"
+            gap="xxs"
             wrap
             {...props}
         >

data/app/pb_kits/playbook/pb_flex/docs/_flex_gap.md

@@ -1,6 +1,6 @@
 ##### Prop
 
-*  `gap` | `row_gap` | `rowGap` | `column_gap` | `columnGap` | **Type**: String | **Values**: xs | sm | md | lg | xl | none
+*  `gap` | `row_gap` | `rowGap` | `column_gap` | `columnGap` | **Type**: String | **Values**: xxs | xs | sm | md | lg | xl | none
 
 - Setting the gap prop sets the row_gap || rowGap and the column_gap || columnGap props to the same size and creates equal space within a flex container.
 

data/app/pb_kits/playbook/pb_flex/flex.rb

@@ -25,15 +25,15 @@ module Playbook
                      deprecated: true
 
       prop :gap, type: Playbook::Props::Enum,
-                 values: %w[xs sm md lg xl none],
+                 values: %w[xxs xs sm md lg xl none],
                  default: "none"
 
       prop :row_gap, type: Playbook::Props::Enum,
-                     values: %w[xs sm md lg xl none],
+                     values: %w[xxs xs sm md lg xl none],
                      default: "none"
 
       prop :column_gap, type: Playbook::Props::Enum,
-                        values: %w[xs sm md lg xl none],
+                        values: %w[xxs xs sm md lg xl none],
                         default: "none"
 
       prop :reverse, type: Playbook::Props::Boolean,

data/app/pb_kits/playbook/pb_selectable_list/_item.tsx

@@ -0,0 +1,107 @@
+import React, { useState } from "react";
+import classnames from "classnames";
+
+import { buildAriaProps, buildCss, buildDataProps } from "../utilities/props";
+import { globalProps } from "../utilities/globalProps";
+
+import Checkbox from "../pb_checkbox/_checkbox";
+import ListItem from "../pb_list/_list_item";
+import Radio from "../pb_radio/_radio";
+
+export type SelectableListItemProps = {
+  aria?: { [key: string]: string };
+  children: React.ReactNode[] | React.ReactNode;
+  checked?: boolean;
+  className?: string;
+  data?: object;
+  defaultChecked?: boolean;
+  id?: string;
+  label?: string;
+  text?: string;
+  name?: string;
+  value?: string;
+  variant?: string;
+  onChange: (arg: React.ChangeEvent<HTMLInputElement>  | null) => void;
+};
+
+const SelectableListItem = ({
+  aria = {},
+  checked = false,
+  children,
+  className,
+  data = {},
+  defaultChecked,
+  id,
+  label,
+  text = "",
+  name = "",
+  value = "",
+  variant = "checkbox",
+  onChange = () => {},
+  ...props
+}: SelectableListItemProps) => {
+  const ariaProps = buildAriaProps(aria);
+  const dataProps = buildDataProps(data);
+  const classes = classnames(
+    buildCss("pb_selectable_list_item_kit"),
+    globalProps(props),
+    className
+  );
+
+  const initialCheckedState = checked;
+  const [checkedState, setCheckedState] = useState(initialCheckedState);
+
+  const handleChecked = (event: React.ChangeEvent<HTMLInputElement>) => {
+    onChange(event);
+    setCheckedState(event.target.checked);
+  };
+
+  return (
+    <ListItem
+      {...props}
+      className={classnames(checkedState ? "checked_item" : "", className)}
+    >
+      <div {...ariaProps} {...dataProps} className={classes}>
+        {variant == "checkbox" && (
+          <>
+            <Checkbox
+              checked={checkedState}
+              id={id}
+              name={name}
+              onChange={handleChecked}
+              // eslint suppressor, text is needed to display on screen
+              //@ts-ignore
+              text={label || (text && false)}
+              type="checkbox"
+              value={value}
+              {...props}
+            />
+            {children}
+          </>
+        )}
+        {variant == "radio" && (
+          <>
+            <Radio
+              defaultChecked={defaultChecked}
+              id={id}
+              label={label}
+              name={name}
+              onChange={onChange}
+              //@ts-ignore
+              text={label}
+              type="radio"
+              value={value}
+              {...props}
+            />
+            {children}
+          </>
+        )}
+        {variant !== "checkbox" && variant !== "radio" && (
+          { children }
+        )}
+      </div>
+    </ListItem>
+  );
+};
+
+export default SelectableListItem;

data/app/pb_kits/playbook/pb_selectable_list/{_selectable_list.jsx → _selectable_list.tsx}

@@ -1,16 +1,16 @@
-/* @flow */
 import React, { useState } from 'react'
 import classnames from 'classnames'
 
 import { buildAriaProps, buildCss, buildDataProps } from '../utilities/props'
 import { globalProps } from '../utilities/globalProps'
+import { SelectableListItemProps } from './_item.js'
 
 import List from  '../pb_list/_list'
-import SelectableListItem from './_item.jsx'
+import SelectableListItem from './_item'
 
 type SelectableListProps = {
-  aria?: object,
-  children?: Node,
+  aria?: {[key: string]: string },
+  children?: React.ReactElement[],
   className?: string,
   data?: object,
   id?: string,
@@ -30,17 +30,18 @@ const SelectableList = (props: SelectableListProps) => {
   const classes = classnames(buildCss('pb_selectable_list_kit'), globalProps(props), className)
   const dataProps = buildDataProps(data)
   const isRadio = props.variant === "radio"
-  const defaultCheckedRadioValue = children.filter(item => item.props.defaultChecked)[0]?.props?.value
+  const defaultCheckedRadioValue = children.filter((item: {props:SelectableListItemProps} ) => item.props.defaultChecked)[0]?.props?.value
+
   const [selectedRadioValue, setSelectedRadioValue] = useState(defaultCheckedRadioValue)
   
-  const onChangeRadioValue = ({ target }) => {
+  const onChangeRadioValue = ({ target }: React.ChangeEvent<HTMLInputElement>) => {
     setSelectedRadioValue(target.value)
   }
 
   let selectableListItems = children
 
   if (isRadio) {
-    selectableListItems = children.map(({ props }) => {
+    selectableListItems = children.map(( {props}: {props:SelectableListItemProps} ) => {
       return (
         <SelectableListItem
             {...props}
@@ -51,6 +52,7 @@ const SelectableList = (props: SelectableListProps) => {
       )
     })
   }
+
   
   return (
     <div
@@ -59,13 +61,13 @@ const SelectableList = (props: SelectableListProps) => {
         className={classes}
         id={id}
     >
-      <List {...props}>
+      <List variant={props.variant}>
         {selectableListItems}
       </List>
     </div>
   )
 }
-
+ 
 SelectableList.Item = SelectableListItem
 
 export default SelectableList

data/app/pb_kits/playbook/pb_selectable_list/selectable_list.test.js

@@ -0,0 +1,68 @@
+import React from 'react'
+import { render, screen } from '../utilities/test-utils'
+import SelectableList from './_selectable_list'
+
+const testId = "selectable-list-test"
+
+const SelectableListCheckbox = () => {
+    return (
+      <SelectableList 
+          data={{ testid: testId }} 
+          variant="checkbox">
+        <SelectableList.Item
+            label="Mild"
+            name="checkbox-name-1"
+            value="1"
+        />
+        <SelectableList.Item
+            checked
+            label="Medium"
+            name="checkbox-name-2"
+            value="2"
+        />
+      </SelectableList>
+    )
+}
+
+const SelectableListRadio = () => {
+    return (
+        <SelectableList
+            data={{ testid: testId }}
+            variant="radio">
+        <SelectableList.Item
+            label="Small"
+            name="radio"
+            value="1"
+        />
+        <SelectableList.Item
+            defaultChecked
+            label="Medium"
+            name="radio"
+            value="2"
+        />
+      </SelectableList>
+    )
+}
+
+
+test("classname renders as expected", () => {
+   render(<SelectableListCheckbox />)
+
+   const kit = screen.getByTestId("selectable-list-test")
+   expect(kit).toHaveClass("pb_selectable_list_kit")
+})
+
+test("renders variant checkbox", () => {
+    render(<SelectableListCheckbox />)
+    const kit = screen.getByTestId("selectable-list-test")
+    const checkbox = kit.querySelector(".pb_checkbox_kit")
+    expect(checkbox).toBeInTheDocument()
+})
+
+test("renders variant radio", () => {
+    render(<SelectableListRadio />)
+    const kit = screen.getByTestId("selectable-list-test")
+    const checkbox = kit.querySelector(".pb_radio_kit")
+    expect(checkbox).toBeInTheDocument()
+
+})

data/lib/playbook/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Playbook
-  PREVIOUS_VERSION = "12.11.0"
-  VERSION = "12.12.0"
+  PREVIOUS_VERSION = "12.12.0"
+  VERSION = "12.13.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: playbook_ui
 version: !ruby/object:Gem::Version
-  version: 12.12.0
+  version: 12.13.0
 platform: ruby
 authors:
 - Power UX
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-30 00:00:00.000000000 Z
+date: 2023-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -1843,9 +1843,9 @@ files:
 - app/pb_kits/playbook/pb_selectable_icon/selectable_icon.html.erb
 - app/pb_kits/playbook/pb_selectable_icon/selectable_icon.rb
 - app/pb_kits/playbook/pb_selectable_icon/selectable_icon.test.js
-- app/pb_kits/playbook/pb_selectable_list/_item.jsx
-- app/pb_kits/playbook/pb_selectable_list/_selectable_list.jsx
+- app/pb_kits/playbook/pb_selectable_list/_item.tsx
 - app/pb_kits/playbook/pb_selectable_list/_selectable_list.scss
+- app/pb_kits/playbook/pb_selectable_list/_selectable_list.tsx
 - app/pb_kits/playbook/pb_selectable_list/docs/_selectable_list_checkbox.html.erb
 - app/pb_kits/playbook/pb_selectable_list/docs/_selectable_list_checkbox.jsx
 - app/pb_kits/playbook/pb_selectable_list/docs/_selectable_list_radio.html.erb
@@ -1854,6 +1854,7 @@ files:
 - app/pb_kits/playbook/pb_selectable_list/docs/index.js
 - app/pb_kits/playbook/pb_selectable_list/selectable_list.html.erb
 - app/pb_kits/playbook/pb_selectable_list/selectable_list.rb
+- app/pb_kits/playbook/pb_selectable_list/selectable_list.test.js
 - app/pb_kits/playbook/pb_selectable_list/selectable_list_item.html.erb
 - app/pb_kits/playbook/pb_selectable_list/selectable_list_item.rb
 - app/pb_kits/playbook/pb_source/_source.scss

data/app/pb_kits/playbook/pb_selectable_list/_item.jsx

@@ -1,106 +0,0 @@
-/* @flow */
-
-import React, { Node, useState } from 'react'
-import classnames from 'classnames'
-
-import { buildAriaProps, buildCss, buildDataProps } from '../utilities/props'
-import { globalProps } from '../utilities/globalProps'
-
-import Checkbox from '../pb_checkbox/_checkbox'
-import ListItem from '../pb_list/_list_item'
-import Radio from '../pb_radio/_radio'
-
-type SelectableListItemProps = {
-  aria?: object,
-  children: array<Node> | Node,
-  checked?: boolean,
-  className?: string,
-  data?: object,
-  defaultChecked?: boolean,
-  id?: string,
-  label?: string,
-  text?: string,
-  name?: string,
-  value?: string,
-  variant?: string,
-  onChange: (boolean)=>void,
-}
-
-const SelectableListItem = ({
-  aria = {},
-  checked = false,
-  children,
-  className,
-  data = {},
-  defaultChecked,
-  id,
-  label,
-  text = '',
-  name = '',
-  value = '',
-  variant = 'checkbox',
-  onChange = () => {},
-  ...props
-}: SelectableListItemProps) => {
-  const ariaProps = buildAriaProps(aria)
-  const dataProps = buildDataProps(data)
-  const classes = classnames(
-    buildCss('pb_selectable_list_item_kit'),
-    globalProps(props),
-    className
-  )
-
-  const initialCheckedState = checked
-  const [checkedState, setCheckedState] = useState(initialCheckedState)
-
-  const handleChecked = (event) => {
-    onChange(event)
-    setCheckedState(event.target.checked)
-  }
-
-  return (
-    <ListItem 
-        {...props}
-        className={classnames(checkedState ? "checked_item" : "", className)}
-    >
-      <div
-          {...ariaProps}
-          {...dataProps}
-          className={classes}
-      >
-        <Choose>
-          <When condition={variant == 'checkbox'}>
-            <Checkbox
-                checked={checkedState}
-                id={id}
-                name={name}
-                onChange={handleChecked}
-                // eslint suppressor, text is needed to display on screen
-                text={label || (text && false)}
-                type="checkbox"
-                value={value}
-                {...props}
-            />
-            {children}
-          </When>
-          <When condition={variant == 'radio'}>
-            <Radio
-                defaultChecked={defaultChecked}
-                id={id}
-                label={label}
-                name={name}
-                onChange={onChange}
-                type="radio"
-                value={value}
-                {...props}
-            />
-            {children}
-          </When>
-          <Otherwise>{children}</Otherwise>
-        </Choose>
-      </div>
-    </ListItem>
-  )
-}
-
-export default SelectableListItem