playbook_ui_docs 13.25.0 → 13.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54249d47fb093face53275deaaf8384698f82baf614f1f78cc2205a08ebd3c53
-  data.tar.gz: 73040e7d8eac641cfdb2932c47ad87e398b7344ed6000ece7da5accfda2cedca
+  metadata.gz: 506f0f2408c89875b290043f9fb12e8cb0bfa8937bb37ba9a2f955b2367a4054
+  data.tar.gz: ae596ee753bd1153ea66228e5ed56ad2e2f8552c162a287881b2fba11b3587e4
 SHA512:
-  metadata.gz: 11fcc781cdc61c9d5dc75618b73f98845d695bc57206572474e93742e967b2b883d7a602902c4a779e447c5403188d8f532d8ebe2f882c7732410a302cf451b4
-  data.tar.gz: 8a1d3f2d28f43e071cd9e7171e2446161bb5c1e81252d018735d71221f61b64fdb2c9817c946997b9e2f667bb4ba9900daa5ceea8e35b2b18b190ead5af05262
+  metadata.gz: ee88bbfb7b88283f206212ec714d0aecf139d9b7adff62899f9eb71327084de9748718e5b9b3867f114085c084559dbb3146e726fd9ae32cc831e92ce2130047
+  data.tar.gz: 7b4dd023282b0a4e5ada4325582f6d8acf824d02832c857b9c24b12e5d155e452c28b1e3d2b1a7f8456b672be2a8cadc0e166ab87a95358073206507b2ded18d

data/app/pb_kits/playbook/pb_checkbox/docs/_checkbox_disabled.html.erb

@@ -0,0 +1,23 @@
+<%= pb_rails("flex", props: {orientation: "column"}) do %>
+    <%= pb_rails("flex/flex_item") do %>
+        <%= pb_rails("checkbox" , props: {
+            input_options: { tabindex: 0 },
+            margin_bottom: "xs",
+            text: "Disabled unchecked",
+            value: "checkbox-value",
+            disabled: true,
+            name: "checkbox-name"
+        }) %>
+    <% end %>
+    <%= pb_rails("flex/flex_item") do %>
+        <%= pb_rails("checkbox" , props: {
+            input_options: { tabindex: 0 },
+            text: "Disabled checked",
+            value: "checkbox-value",
+            disabled: true,
+            checked: true,
+            name: "checkbox-name"
+        }) %>
+    <% end %>
+<% end %>
+

data/app/pb_kits/playbook/pb_checkbox/docs/_checkbox_disabled.jsx

@@ -0,0 +1,29 @@
+import React from 'react'
+
+import Checkbox from '../_checkbox'
+
+const CheckboxDisabled = (props) => {
+  return (
+    <div style={{ display: "flex", flexDirection: "column" }}>
+      <Checkbox
+          disabled
+          marginBottom="xs"
+          name="default name"
+          tabIndex={0}
+          text="Disabled unchecked"
+          value="default value"
+          {...props}
+      />
+      <Checkbox
+          checked
+          disabled
+          name="checkbox-name"
+          text="Disabled checked"
+          value="check-box value"
+          {...props}
+      />
+    </div>
+  )
+}
+
+export default CheckboxDisabled

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

@@ -6,6 +6,7 @@ examples:
     - checkbox_error: Default w/ Error
     - checkbox_options: Checkbox w/ Options
     - checkbox_indeterminate: Indeterminate Checkbox
+    - checkbox_disabled: Disabled Checkbox
 
   react:
   - checkbox_default: Default
@@ -13,6 +14,7 @@ examples:
   - checkbox_custom: Custom Checkbox
   - checkbox_error: Default w/ Error
   - checkbox_indeterminate: Indeterminate Checkbox
+  - checkbox_disabled: Disabled Checkbox
 
   swift:
     - checkbox_default_swift: Default

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

@@ -3,3 +3,4 @@ export { default as CheckboxCustom } from './_checkbox_custom.jsx'
 export { default as CheckboxError } from './_checkbox_error.jsx'
 export { default as CheckboxChecked } from './_checkbox_checked.jsx'
 export { default as CheckboxIndeterminate } from './_checkbox_indeterminate.jsx'
+export { default as CheckboxDisabled } from './_checkbox_disabled.jsx'

data/app/pb_kits/playbook/pb_currency/docs/_currency_alignment_swift.md

@@ -0,0 +1,43 @@
+[!Currency-Alignment](https://github.com/powerhome/playbook-swift/assets/112719604/d74a9c5a-c606-4cd0-bf70-20e9297ec246)
+
+```swift
+VStack(alignment: .leading, spacing: Spacing.small) {
+  HStack {
+    PBCurrency(
+      amount: "2,000",
+      decimalAmount: ".50",
+      label: "left",
+      size: .title4,
+      symbol: "en_US",
+      isEmphasized: true,
+      alignment: .leading
+    )
+  }
+  .frame(maxWidth: .infinity, alignment: .leading)
+  HStack {
+    PBCurrency(
+      amount: "342",
+      decimalAmount: ".00",
+      label: "center",
+      size: .title4,
+      symbol: "en_EU",
+      isEmphasized: true,
+      alignment: .center
+    )
+  }
+  .frame(maxWidth: .infinity, alignment: .center)
+  HStack {
+    PBCurrency(
+      amount: "45",
+      label: "right",
+      size: .title4,
+      symbol: "en_US",
+      unit: "/mo",
+      isEmphasized: true,
+      hasUnit: true,
+      alignment: .trailing
+    )
+  }
+  .frame(maxWidth: .infinity, alignment: .trailing)
+}
+```

data/app/pb_kits/playbook/pb_currency/docs/_currency_props_swift.md

@@ -0,0 +1,12 @@
+### Props
+| Name | Type | Description | Default | Values |
+| --- | ----------- | --------- | --------- | --------- |
+| **amount** | `String` | Allows user to enter a currency amount | |  |
+| **decimalAmount** | `String` | Allows user to enter a decimal amount |  | |
+| **label** | `String` | Allows user to a descriptive label value |  | |
+| **size** | `PBFont` | Allows user to choose the size of the amount that is being displayed | `.title4` | `title4` `title3` `title4` |
+| **symbol** | `String` | A string value used to produce the desired currency symbol |  | |
+| **unit** | `String` | Allows user to add a unit of measure instead of a decimal amount |  | |
+| **alignment** | `Alignment` | Sets alignment of content | `.leading` | `leading` `center` `trailing` |
+| **isEmphasized** | `Bool` | Determines whether or not the currency that is being displayed is emphasized | `false` | `true` `false` |
+| **hasUnit** | `Bool` | Determines whether or not the currency has a decimal value or a unit of measure | `false` | `true` `false` |

data/app/pb_kits/playbook/pb_currency/docs/_currency_size_swift.md

@@ -0,0 +1,31 @@
+![Currency-Default](https://github.com/powerhome/playbook-swift/assets/54749071/bf3810f9-6dd2-4bdd-b32a-14109f3a0b9a)
+
+```swift
+VStack(alignment: .leading, spacing: Spacing.small) {
+  PBCurrency(
+    amount: "2,000",
+    decimalAmount: ".50",
+    label: "small",
+    size: .title4,
+    symbol: "en_US",
+    isEmphasized: true
+  )
+  PBCurrency(
+    amount: "342",
+    decimalAmount: ".00",
+    label: "medium",
+    size: .title3,
+    symbol: "en_EU",
+    isEmphasized: true
+  )
+  PBCurrency(
+    amount: "45",
+    label: "large",
+    size: .title1,
+    symbol: "en_US",
+    unit: "/mo",
+    isEmphasized: true,
+    hasUnit: true
+  )
+}
+```

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

@@ -17,3 +17,8 @@ examples:
   - currency_abbreviated: Abbreviate Larger Amounts
   - currency_matching_decimals: Matching Decimals
   - currency_unstyled: Unstyled
+
+  swift:
+  - currency_size_swift: Size
+  - currency_alignment_swift: Alignment
+  - currency_props_swift: ""

data/app/pb_kits/playbook/pb_date_picker/docs/_date_picker_on_change.md

@@ -1,3 +1,5 @@
 Your change handler function has access to two arguments: `dateStr` and `selectedDates`.
 
-The first, `dateStr`, is a string of the chosen date.  The second, `selectedDates`, is an array of selected date objects. In many use cases `selectedDates` will have only one value but you'll still need to access it from index 0.
+The first, `dateStr`, is a string of the chosen date.  The second, `selectedDates`, is an array of selected date objects. In many use cases `selectedDates` will have only one value but you'll still need to access it from index 0.
+
+NOTE: On Change does not account for manual input by users, so if your date picker sets `allowInput`, you should use the `onClose` method instead.

data/app/pb_kits/playbook/pb_date_picker/docs/_date_picker_on_close.md

@@ -1,3 +1,5 @@
 The `onClose` handler function has access to two arguments: `dateStr` and `selectedDates`.
 
-The first, `dateStr`, is a string of the chosen date.  The second, `selectedDates`, is an array of selected date objects. In many use cases `selectedDates` will have only one value but you'll still need to access it from index 0.
+The first, `dateStr`, is a string of the chosen date.  The second, `selectedDates`, is an array of selected date objects. In many use cases `selectedDates` will have only one value but you'll still need to access it from index 0.
+
+NOTE: `onClose` is the ideal handler function to use when `allowInput` is enabled.

data/app/pb_kits/playbook/pb_date_picker/docs/_date_picker_quick_pick_range_limit.md

@@ -1 +1 @@
-Applying `this_ranges_end_today` (Rails) or `thisRangesEndToday` (React) causes all “This” preset ranges (i.e., this week, this month, this quarter, this year) to use an endDate of today, instead of their natural end date in the future.
+Because the Quick Pick variant has `allowInput` set to `true` by default, use the `onClose` handler function to access the startDate and endDate values. See the `onClose` example for details.

data/app/pb_kits/playbook/pb_date_range_stacked/docs/_date_range_stacked_default_swift.md

@@ -0,0 +1,14 @@
+![Date-Range-Stacked-Default](https://github.com/powerhome/playbook-swift/assets/54749071/ccb85e5d-0f6d-4ced-8154-aa9dfa72a131)
+
+```swift
+VStack(alignment: .leading, spacing: Spacing.small) {
+  PBDateRangeStacked(
+    startDate: Date().makeDate(year: 2019, month: 6, day: 18),
+    endDate: Date().makeDate(year: 2020, month: 3, day: 20),
+    startAlignment: .trailing,
+    endAlignment: .leading,
+    startVariant: .short(showIcon: false),
+    endVariant: .short(showIcon: false)
+  )
+}
+```

data/app/pb_kits/playbook/pb_date_range_stacked/docs/_date_range_stacked_props_swift.md

@@ -0,0 +1,9 @@
+### Props
+| Name | Type | Description | Default | Values |
+| --- | ----------- | --------- | --------- | --------- |
+| **startDate** | `Date()` | Takes a string value to set the starting date range value | `Date()` |  |
+| **endDate** | `Date()` | Takes a string value to set the ending date range value |  `Date()` |  |
+| **startAlignment** | `Alignment` | Changes the alignment of the starting date | `.leading` | `.leading` `.trailing` |
+| **endAlignment** | `Alignment` | Changes the alignment of the ending date | `.leading` | `.leading` `.trailing` |
+| **startVariant** | `PBDate.Variant` | Changes the style of the starting date | `.short(showIcon: false)` | `.short(showIcon: false)` `.dayDate` `.standard` `.withIcon(isStandard: true)` `withIcon(isStandard: false)` |
+| **endVariant** | `PBDate.Variant` | Changes the style of the ending date | `.short(showIcon: false)` | `.short(showIcon: false)` `.dayDate` `.standard` `.withIcon(isStandard: true)` `withIcon(isStandard: false)` |

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

@@ -5,3 +5,7 @@ examples:
   
   react:
   - date_range_stacked_default: Default
+
+  swift:
+  - date_range_stacked_default_swift: Default
+  - date_range_stacked_props_swift: ""

data/app/pb_kits/playbook/pb_dropdown/docs/_dropdown_default.jsx

@@ -1,31 +1,20 @@
-import React, { useState } from 'react'
+import React from 'react'
 import { Dropdown } from '../../'
 
 const DropdownDefault = (props) => {
-// eslint-disable-next-line no-unused-vars
-const [selectedOption, setSelectedOption] = useState();
 
   const options = [
     {
       label: "United States",
       value: "United States",
-      areaCode: "+1",
-      icon: "🇺🇸",
-      id: "United-states"
     },
     {
-      label: "Ukraine",
-      value: "Ukraine",
-      areaCode: "+380",
-      icon: "🇺🇦",
-      id: "ukraine"
+      label: "Canada",
+      value: "Canada",
     },
     {
       label: "Pakistan",
       value: "Pakistan",
-      areaCode: "+92",
-      icon: "🇵🇰",
-      id: "pakistan"
     }
   ];  
 
@@ -33,16 +22,9 @@ const [selectedOption, setSelectedOption] = useState();
   return (
   <div>
     <Dropdown
-        onSelect={(selectedItem) => setSelectedOption(selectedItem)}
         options={options}
         {...props}
-    >
-      {options.map((option) => (
-        <Dropdown.Option key={option.id} 
-            option={option}
-        /> 
-      ))}
-    </Dropdown>
+    />
   </div>
   )
 }

data/app/pb_kits/playbook/pb_dropdown/docs/_dropdown_default.md

@@ -0,0 +1 @@
+The Dropdown kit accepts an `options` array and renders each object from that array as a selectable option within a dropdown container. `options` is a required prop and must be an array of objects. Each object can contain as many key/value pairs as needed but MUST contain 'label' and 'value' as the only required items within each object.

data/app/pb_kits/playbook/pb_dropdown/docs/_dropdown_subcomponent_structure.jsx

@@ -0,0 +1,42 @@
+import React from 'react'
+import { Dropdown } from '../..'
+
+const DropdownSubcomponentStructure = (props) => {
+
+
+  const options = [
+    {
+      label: "United States",
+      value: "United States",
+    },
+    {
+      label: "Canada",
+      value: "Canada",
+    },
+    {
+      label: "Pakistan",
+      value: "Pakistan",
+    }
+  ];  
+
+
+  return (
+  <div>
+    <Dropdown
+        options={options}
+        {...props}
+    >
+      <Dropdown.Trigger/>
+      <Dropdown.Container>
+        {options.map((option) => (
+          <Dropdown.Option key={option.id} 
+              option={option}
+          />
+        ))}
+      </Dropdown.Container>
+    </Dropdown>
+  </div>
+  )
+}
+
+export default  DropdownSubcomponentStructure

data/app/pb_kits/playbook/pb_dropdown/docs/_dropdown_subcomponent_structure.md

@@ -0,0 +1,7 @@
+The dropdown comes with the following subcomponents that can be used to achieve various levels of customization:
+
+`Dropdown. Trigger`
+`Dropdown.Container`
+`Dropdown.Option`
+
+See the code snippet below for a visual on how to use the kit with subcomponents. Each subcomponent allows for GlobalProps in addition to any subcomponent specfic props. 

data/app/pb_kits/playbook/pb_dropdown/docs/_dropdown_with_autocomplete.jsx

@@ -0,0 +1,84 @@
+import React from 'react'
+import { Dropdown, User, Badge, FlexItem } from '../..'
+
+const DropdownWithAutocomplete = (props) => {
+
+  const options = [
+    {
+      label: "Jasper Furniss",
+      value: "Jasper Furniss",
+      territory: "PHL",
+      title: "Senior UX Engineer",
+      id: "jasper-furniss",
+      status: "Offline"
+    },
+    {
+      label: "Ramon Ruiz",
+      value: "Ramon Ruiz",
+      territory: "PHL",
+      title: "Senior UX Desinger",
+      id: "ramon-ruiz",
+      status: "Away"
+    },
+    {
+      label: "Jason Cypret",
+      value: "Jason Cypret",
+      territory: "PHL",
+      title: "VP of User Experience",
+      id: "jason-cypret",
+      status: "Online"
+    },
+    {
+      label: "Courtney Long",
+      value: "Courtney Long",
+      territory: "PHL",
+      title: "UX Design Mentor",
+      id: "courtney-long",
+      status: "Online"
+    }
+  ];
+
+
+  return (
+  <div>
+    <Dropdown autocomplete
+        options={options}
+        {...props}
+    >
+        {options.map((option) => (
+          <Dropdown.Option key={option.id} 
+              option={option}
+          >
+            <>
+              <FlexItem>
+                <User
+                    align="left"
+                    avatar
+                    name={option.label}
+                    orientation="horizontal"
+                    territory={option.territory}
+                    title={option.title}
+                />
+              </FlexItem>
+              <FlexItem>
+                <Badge
+                    rounded
+                    text={option.status}
+                    variant={`${
+                        option.status === "Offline"
+                        ? "neutral"
+                        : option.status === "Online"
+                        ? "success"
+                        : "warning"
+                    }`}
+                />
+              </FlexItem>
+            </>
+          </Dropdown.Option>
+        ))}
+    </Dropdown>
+  </div>
+  )
+}
+
+export default  DropdownWithAutocomplete

data/app/pb_kits/playbook/pb_dropdown/docs/_dropdown_with_autocomplete.md

@@ -0,0 +1 @@
+The `autocomplete` prop can be used to add autocomplete or typeahead functionality to the Dropdown's default Trigger. This prop is set to 'false' by default. 

data/app/pb_kits/playbook/pb_dropdown/docs/_dropdown_with_autocomplete_and_custom_display.jsx

@@ -0,0 +1,101 @@
+import React, { useState } from 'react'
+import { Dropdown, User, Badge, FlexItem, Avatar } from '../..'
+
+const DropdownWithAutocompleteAndCustomDisplay = (props) => {
+  const [selectedOption, setSelectedOption] = useState();
+
+  const options = [
+    {
+      label: "Jasper Furniss",
+      value: "Jasper Furniss",
+      territory: "PHL",
+      title: "Senior UX Engineer",
+      id: "jasper-furniss",
+      status: "Offline"
+    },
+    {
+      label: "Ramon Ruiz",
+      value: "Ramon Ruiz",
+      territory: "PHL",
+      title: "Senior UX Desinger",
+      id: "ramon-ruiz",
+      status: "Away"
+    },
+    {
+      label: "Jason Cypret",
+      value: "Jason Cypret",
+      territory: "PHL",
+      title: "VP of User Experience",
+      id: "jason-cypret",
+      status: "Online"
+    },
+    {
+      label: "Courtney Long",
+      value: "Courtney Long",
+      territory: "PHL",
+      title: "UX Design Mentor",
+      id: "courtney-long",
+      status: "Online"
+    }
+  ];
+
+  const CustomDisplay = () => {
+    return (
+      <>
+      {
+        selectedOption && (
+            <Avatar
+                name={selectedOption.label}
+                size="xs"
+            />
+        )
+      }
+    </>
+    )
+  };
+
+  return (
+  <div>
+    <Dropdown autocomplete
+        onSelect={(selectedItem) => setSelectedOption(selectedItem)}
+        options={options}
+        {...props}
+    >
+        <Dropdown.Trigger customDisplay={<CustomDisplay/>} />
+        {options.map((option) => (
+          <Dropdown.Option key={option.id} 
+              option={option}
+          >
+            <>
+              <FlexItem>
+                <User
+                    align="left"
+                    avatar
+                    name={option.label}
+                    orientation="horizontal"
+                    territory={option.territory}
+                    title={option.title}
+                />
+              </FlexItem>
+              <FlexItem>
+                <Badge
+                    rounded
+                    text={option.status}
+                    variant={`${
+                        option.status === "Offline"
+                        ? "neutral"
+                        : option.status === "Online"
+                        ? "success"
+                        : "warning"
+                    }`}
+                />
+              </FlexItem>
+            </>
+          </Dropdown.Option>
+        ))}
+    </Dropdown>
+  </div>
+  )
+}
+
+export default  DropdownWithAutocompleteAndCustomDisplay

data/app/pb_kits/playbook/pb_dropdown/docs/_dropdown_with_autocomplete_and_custom_display.md

@@ -0,0 +1 @@
+`autocomplete` prop can also be used in conjunction with the `customDisplay` prop.

data/app/pb_kits/playbook/pb_dropdown/docs/_dropdown_with_custom_display.jsx

@@ -39,7 +39,7 @@ const DropdownWithCustomDisplay = (props) => {
     }
   ];
 
-  const customDisplay = () => {
+  const CustomDisplay = () => {
     return (
       <>
       {
@@ -62,7 +62,9 @@ const DropdownWithCustomDisplay = (props) => {
         options={options}
         {...props}
     >
-      <Dropdown.Trigger customDisplay={customDisplay()}/>
+      <Dropdown.Trigger customDisplay={<CustomDisplay/>}
+          placeholder="Select a User"
+      />
         {options.map((option) => (
           <Dropdown.Option key={option.id} 
               option={option}
@@ -79,7 +81,7 @@ const DropdownWithCustomDisplay = (props) => {
                 />
               </FlexItem>
               <FlexItem>
-                <Badge
+                <Badge dark
                     rounded
                     text={option.status}
                     variant={`${

data/app/pb_kits/playbook/pb_dropdown/docs/_dropdown_with_custom_display.md

@@ -0,0 +1,5 @@
+The `customDisplay` prop can be used to customize the display of the selected item by allowing devs to pass in a component that will be rendered to the left of the default text-based display. In this example the Avatar kit is being used.
+
+The `placeholder` prop can also be used to customize the placeholder text for the default Trigger. 
+
+The `onSelect` prop is a function that gives the dev one argument: the selected option. In this example we are using the `onSelect` to set a state with the selected option and using it to customize the `customDisplay`.

data/app/pb_kits/playbook/pb_dropdown/docs/_dropdown_with_custom_options.jsx

@@ -1,9 +1,7 @@
-import React, { useState } from 'react'
+import React from 'react'
 import { Dropdown, Icon, Body, FlexItem, Flex } from '../..'
 
 const DropdownWithCustomOptions = (props) => {
-// eslint-disable-next-line no-unused-vars
-  const [selectedOption, setSelectedOption] = useState();
 
   const options = [
     {
@@ -14,11 +12,11 @@ const DropdownWithCustomOptions = (props) => {
       id: "United-states"
     },
     {
-      label: "Ukraine",
-      value: "Ukraine",
-      areaCode: "+380",
-      icon: "🇺🇦",
-      id: "ukraine"
+      label: "Canada",
+      value: "Canada",
+      areaCode: "+1",
+      icon: "🇨🇦",
+      id: "canada"
     },
     {
       label: "Pakistan",
@@ -33,7 +31,6 @@ const DropdownWithCustomOptions = (props) => {
   return (
   <div>
     <Dropdown
-        onSelect={(selectedItem) => setSelectedOption(selectedItem)}
         options={options}
         {...props}
     >

data/app/pb_kits/playbook/pb_dropdown/docs/_dropdown_with_custom_options.md

@@ -0,0 +1 @@
+The Dropdown also allows for custom options that can be passed in as children to the `Dropdown.Option` subcomponent. If no children are passed to `Dropdown.Option`, the kit will render each option as text within a Body kit by default. 

data/app/pb_kits/playbook/pb_dropdown/docs/_dropdown_with_custom_padding.jsx

@@ -0,0 +1,48 @@
+import React from 'react'
+import { Dropdown } from '../..'
+
+const DropdownWithCustomPadding = (props) => {
+
+  const options = [
+    {
+      label: "United States",
+      value: "United States",
+      areaCode: "+1",
+      icon: "🇺🇸",
+      id: "United-states"
+    },
+    {
+      label: "Canada",
+      value: "Canada",
+      areaCode: "+1",
+      icon: "🇨🇦",
+      id: "canada"
+    },
+    {
+      label: "Pakistan",
+      value: "Pakistan",
+      areaCode: "+92",
+      icon: "🇵🇰",
+      id: "pakistan"
+    }
+  ];  
+
+
+  return (
+  <div>
+    <Dropdown
+        options={options}
+        {...props}
+    >
+      {options.map((option) => (
+        <Dropdown.Option key={option.id} 
+            option={option}
+            padding="sm"
+        /> 
+      ))}
+    </Dropdown>
+  </div>
+  )
+}
+
+export default DropdownWithCustomPadding