playbook_ui 13.14.0 → 13.15.0

data/app/pb_kits/playbook/pb_title/_title.tsx

@@ -13,12 +13,11 @@ type TitleProps = {
   className?: string,
   color?: "default" | "light" | "lighter" | "success" | "error" | "link",
   data?: {[key: string]: string},
-  htmlOptions?: {[key: string]: string | number | boolean | Function},
+  htmlOptions?: {[key: string]: string | number | boolean | (() => void)},
   id?: string,
   size?: SizeType | SizeResponsiveType,
   tag?: "h1" | "h2" | "h3" | "h4" | "h5" | "h6" | "div" | "span",
   text?: string,
-  truncate?: null | "1" | "2" | "3" | "4" | "5",
   variant?: null | "link",
 } & GlobalProps
 
@@ -36,7 +35,6 @@ const Title = (props: TitleProps): React.ReactElement => {
     bold = true,
     tag = 'h3',
     text,
-    truncate = null,
     variant = null,
   } = props
 
@@ -44,7 +42,6 @@ const Title = (props: TitleProps): React.ReactElement => {
   const dataProps: {[key: string]: string | number} = buildDataProps(data)
   const htmlProps = buildHtmlProps(htmlOptions)
   const getBold = bold ? '' : 'thin'
-  const isTruncated = truncate ? `truncate-${truncate}` : null
   const isSizeNumberOrString = typeof size === "number" || typeof size === "string"
 
   const buildResponsiveSizeCss = () => {
@@ -60,7 +57,7 @@ const Title = (props: TitleProps): React.ReactElement => {
   }
 
   const classes = classnames(
-    buildCss('pb_title_kit', isSizeNumberOrString ? `size_${size}` : "", variant, color, getBold, isTruncated),
+    buildCss('pb_title_kit', isSizeNumberOrString ? `size_${size}` : "", variant, color, getBold),
     globalProps(props),
     buildResponsiveSizeCss(),
     className

data/app/pb_kits/playbook/pb_title/_title_mixin.scss

@@ -16,22 +16,3 @@ $pb_title_colors: (
     }
   }
 }
-
-$pb_title_truncate: (
-  truncate-1: 1,
-  truncate-2: 2,
-  truncate-3: 3,
-  truncate-4: 4,
-  truncate-5: 5
-);
-
-@mixin title_truncate {
-  @each $name, $number in $pb_title_truncate {
-    &[class*=_#{$name}] {
-      overflow: hidden;
-      display: -webkit-box;
-      -webkit-line-clamp: $number;
-      -webkit-box-orient: vertical;
-    }
-  }
-}

data/app/pb_kits/playbook/pb_title/title.rb

@@ -16,15 +16,12 @@ module Playbook
                      default: nil,
                      deprecated: true
       prop :bold, type: Playbook::Props::Boolean, default: true
-      prop :truncate, type: Playbook::Props::Enum,
-                      values: [nil, "1", "2", "3", "4", "5"],
-                      default: nil
 
       def classname
         if is_size_responsive
-          generate_classname("pb_title_kit", variant, color, is_bold, is_truncated) + generate_responsive_size_classname
+          generate_classname("pb_title_kit", variant, color, is_bold) + generate_responsive_size_classname
         else
-          generate_classname("pb_title_kit", size, variant, color, is_bold, is_truncated)
+          generate_classname("pb_title_kit", size, variant, color, is_bold)
         end
       end
 
@@ -32,10 +29,6 @@ module Playbook
         bold ? nil : "thin"
       end
 
-      def is_truncated
-        truncate ? "truncate-#{truncate}" : nil
-      end
-
       def is_size_responsive
         try(:size).is_a?(::Hash)
       end

data/app/pb_kits/playbook/pb_title_count/_title_count.tsx

@@ -16,7 +16,7 @@ type TitleCountProps = {
   count?: number,
   dark?: boolean,
   data?: { [key: string]: string },
-  htmlOptions?: {[key: string]: string | number | boolean | Function},
+  htmlOptions?: {[key: string]: string | number | boolean | (() => void)},
   id?: string,
   title?: string,
   size?: "lg" | "sm",

data/app/pb_kits/playbook/pb_title_detail/_title_detail.tsx

@@ -13,7 +13,7 @@ type TitleDetailProps = {
   className?: string,
   data?: { [key: string]: string },
   detail: string,
-  htmlOptions?: {[key: string]: string | number | boolean | Function},
+  htmlOptions?: {[key: string]: string | number | boolean | (() => void)},
   id?: string,
   title: string,
 } & GlobalProps

data/app/pb_kits/playbook/pb_toggle/_toggle.tsx

@@ -17,7 +17,7 @@ type Props = {
   children?: React.ReactNode | React.ReactNode[],
   className?: string,
   data?: { [key: string]: string },
-  htmlOptions?: {[key: string]: string | number | boolean | Function},
+  htmlOptions?: {[key: string]: string | number | boolean | (() => void)},
   id?: string,
   name?: string,
   onChange?: InputCallback<HTMLInputElement>,

data/app/pb_kits/playbook/pb_tooltip/_tooltip.tsx

@@ -23,7 +23,7 @@ type TooltipProps = {
   children: JSX.Element,
   data?: { [key: string]: string },
   delay?: number | Partial<{open: number; close: number}>,
-  htmlOptions?: {[key: string]: string | number | boolean | Function},
+  htmlOptions?: {[key: string]: string | number | boolean | (() => void)},
   icon?: string,
   interaction?: boolean,
   placement?: Placement,

data/app/pb_kits/playbook/pb_treemap_chart/_treemap_chart.tsx

@@ -25,7 +25,7 @@ type TreemapChartProps = {
   drillable: boolean;
   grouped: boolean;
   height?: string;
-  htmlOptions?: {[key: string]: string | number | boolean | Function};
+  htmlOptions?: {[key: string]: string | number | boolean | (() => void)},
   id: number | string;
   title?: string;
   tooltipHtml: string;

data/app/pb_kits/playbook/pb_typeahead/_typeahead.tsx

@@ -34,7 +34,7 @@ type TypeaheadProps = {
   dark?: boolean,
   data?: { [key: string]: string },
   error?: string,
-  htmlOptions?: {[key: string]: string | number | boolean | Function},
+  htmlOptions?: {[key: string]: string | number | boolean | (() => void)},
   id?: string,
   label?: string,
   loadOptions?: string | Noop,

data/app/pb_kits/playbook/pb_user/_user.tsx

@@ -16,7 +16,7 @@ type UserProps = {
   className?: string,
   dark?: boolean,
   data?: {[key: string]: string},
-  htmlOptions?: {[key: string]: string | number | boolean | Function},
+  htmlOptions?: {[key: string]: string | number | boolean | (() => void)},
   id?: string,
   name?: string,
   orientation?: "horizontal" | "vertical",

data/app/pb_kits/playbook/pb_user/docs/_user_horizontal_swift.md

@@ -0,0 +1,37 @@
+![user-horizontal](https://github.com/powerhome/playbook/assets/92755007/63680051-6a88-4ae7-bffd-74d8e9b3a805)
+
+```swift
+
+let img = Image("andrew", bundle: .module)
+let name = "Andrew K"
+let title = "Rebels Developer"
+
+VStack(alignment: .leading, spacing: Spacing.small) {
+  PBUser(
+    name: name,
+    image: img,
+    territory: "PHL",
+    title: title
+  )
+
+  PBUser(
+    name: name,
+    territory: "PHL",
+    title: title
+  )
+
+  PBUser(
+    name: name,
+    image: img,
+    size: .small,
+    title: title
+  )
+
+  PBUser(
+    name: name,
+    image: img,
+    size: .small
+  )
+}
+
+```

data/app/pb_kits/playbook/pb_user/docs/_user_props_table.md

@@ -0,0 +1,10 @@
+### Props
+| Name | Type | Description | Default | Values |
+| --- | ----------- | --------- | --------- | --------- |
+| **name** | `String` | Sets the User's name |  |  |
+| **displayAvatar** | `Bool` | Displays the User's avatar | `true` | `true` `false` |
+| **image** | `Image` | Sets image for the avatar |  |  |
+| **orientation** | `Orientation` | Changes the orientation of the User | `.horizontal` | `.horizontal` `.verticle` |
+| **size** | `UserAvatarSize` | Changes the size of the User | `.medium` | `.small` `.medium` `.large` |
+| **territory** | `String` | Adds the User's territory |  |  |
+| **title** | `String` | Adds a title |  |  |

data/app/pb_kits/playbook/pb_user/docs/_user_size_swift.md

@@ -0,0 +1,35 @@
+![user-size](https://github.com/powerhome/playbook/assets/54749071/ed012a15-64a1-4c13-a0bc-7457660992f6)
+
+
+```swift
+
+let img = Image("andrew", bundle: .module)
+let name = "Andrew K"
+let title = "Rebels Developer"
+
+VStack(alignment: .leading, spacing: Spacing.small) {
+  PBUser(
+    name: name,
+    image: img,
+    size: .small,
+    territory: "PHL",
+    title: title
+  )
+
+  PBUser(
+    name: name,
+    image: img,
+    territory: "PHL",
+    title: title
+  )
+
+  PBUser(
+    name: name,
+    image: img,
+    size: .large,
+    territory: "PHL",
+    title: title
+  )
+}
+
+```

data/app/pb_kits/playbook/pb_user/docs/_user_text_only_swift.md

@@ -0,0 +1,27 @@
+![user-text-only](https://github.com/powerhome/playbook/assets/54749071/ba04df54-6590-4db6-ad32-38932a08aced)
+
+
+```swift
+
+let img = Image("andrew", bundle: .module)
+let name = "Andrew K"
+let title = "Rebels Developer"
+
+VStack(spacing: Spacing.small) {
+  PBUser(
+    name: name,
+    displayAvatar: false,
+    size: .large,
+    territory: "PHL",
+    title: title
+  )
+
+  PBUser(
+    name: name,
+    displayAvatar: false,
+    territory: "PHL",
+    title: title
+  )
+}
+
+```

data/app/pb_kits/playbook/pb_user/docs/_user_vertical_size_swift.md

@@ -0,0 +1,35 @@
+![user-verticle-size](https://github.com/powerhome/playbook/assets/54749071/e99b4c9b-0752-467e-971e-a6a5f520009e)
+
+
+```swift
+
+let img = Image("andrew", bundle: .module)
+let name = "Andrew K"
+let title = "Rebels Developer"
+
+VStack(alignment: .leading, spacing: Spacing.small) {
+  PBUser(
+    name: name,
+    image: img,
+    orientation: .vertical,
+    size: .small,
+    title: title
+  )
+
+  PBUser(
+    name: name,
+    image: img,
+    orientation: .vertical,
+    title: title
+  )
+
+  PBUser(
+    name: name,
+    image: img,
+    orientation: .vertical,
+    size: .large,
+    title: title
+  )
+}
+
+```

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

@@ -17,3 +17,10 @@ examples:
   - user_vertical_size: Vertical Size
   - user_subtitle: Subtitle
   - user_block_content_subtitle_react: Block Content Subtitle
+
+  swift:
+  - user_horizontal_swift: Horizontal
+  - user_vertical_size_swift: Vertical
+  - user_text_only_swift: Text Only
+  - user_size_swift: Horizontal Size
+  - user_props_table: ""

data/app/pb_kits/playbook/pb_user_badge/_user_badge.tsx

@@ -10,7 +10,7 @@ type UserBadgeProps = {
   badge?: "million-dollar" | "veteran",
   className?: string,
   data?: {[key: string]: string},
-  htmlOptions?: {[key: string]: string | number | boolean | Function},
+  htmlOptions?: {[key: string]: string | number | boolean | (() => void)},
   id?: string,
   size?: "sm" | "md" | "lg",
 }

data/app/pb_kits/playbook/pb_walkthrough/_walkthrough.tsx

@@ -14,7 +14,7 @@ type WalkthroughProps = {
   className?: string,
   continuous?: boolean,
   data?: { [key: string]: string },
-  htmlOptions?: {[key: string]: string | number | boolean | Function},
+  htmlOptions?: {[key: string]: string | number | boolean | (() => void)},
   id?: string,
   run?: boolean,
   steps?: [],

data/app/pb_kits/playbook/pb_weekday_stacked/_weekday_stacked.tsx

@@ -16,7 +16,7 @@ type WeekdayStackedProps = {
   dark?: boolean,
   data?: object,
   date: Date,
-  htmlOptions?: {[key: string]: string | number | boolean | Function},
+  htmlOptions?: {[key: string]: string | number | boolean | (() => void)},
   id?: string,
   variant?: "day_only" | "month_day" | "expanded",
   compact?: boolean,

data/app/pb_kits/playbook/tokens/exports/exports.d.ts

@@ -0,0 +1 @@
+declare module '*.scss';

data/app/pb_kits/playbook/utilities/_truncate.scss

@@ -0,0 +1,20 @@
+$truncate-styles: (
+  truncate_1: 1,
+  truncate_2: 2,
+  truncate_3: 3,
+  truncate_4: 4,
+  truncate_5: 5
+);
+
+@mixin apply_truncate_styles($number) {
+  overflow: hidden;
+  display: -webkit-box;
+  -webkit-line-clamp: $number;
+  -webkit-box-orient: vertical;
+}
+
+@each $class, $number in $truncate-styles {
+  .#{$class} {
+    @include apply_truncate_styles($number);
+  }
+}

data/app/pb_kits/playbook/utilities/globalProps.ts

@@ -135,6 +135,11 @@ overflowY?: OverflowTypes,
 overflow?: OverflowTypes
 }
 
+type TruncateType = None | 1 | 2 | 3 | 4 | 5
+type Truncate = {
+  truncate?: TruncateType
+}
+
 type ZIndexType = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10
 type ZIndexResponsiveType = {[key: string]: ZIndexType}
 type ZIndex = {
@@ -146,7 +151,7 @@ export type GlobalProps = AlignContent & AlignItems & AlignSelf &
   BorderRadius & Cursor & Dark & Display & DisplaySizes & Flex & FlexDirection &
   FlexGrow & FlexShrink & FlexWrap & JustifyContent & JustifySelf &
   LineHeight & Margin & MaxWidth & NumberSpacing & Order & Overflow & Padding &
-  Position & Shadow & TextAlign & ZIndex & { hover?: string };
+  Position & Shadow & TextAlign & Truncate & ZIndex & { hover?: string };
 
 const getResponsivePropClasses = (prop: {[key: string]: string}, classPrefix: string) => {
   const keys: string[] = Object.keys(prop)
@@ -269,7 +274,13 @@ const PROP_CATEGORIES: {[key:string]: (props: {[key: string]: any}) => string} =
     css += overflowY ? `overflow_y_${overflowY}` : ''
     return css
   },
-
+  truncateProps: ({ truncate }: Truncate) => {
+    if (typeof truncate === 'object') {
+      return ''
+    } else {
+      return truncate ? `truncate_${truncate}` : ''
+    }
+  },
   darkProps: ({ dark }: Dark) => dark ? 'dark' : '',
   numberSpacingProps: ({ numberSpacing }: NumberSpacing) => {
     let css = ''

data/app/pb_kits/playbook/utilities/props.ts

@@ -57,8 +57,8 @@ export const buildCss = (...rules: (string | { [x: string]: string | boolean; })
  * @returns {Object} an object holding the HTML valid props and their values.
  */
 
-export const buildHtmlProps = (htmlOptions: { [key: string]: string | number | boolean | Function }) => {
-  const htmlProps: { [attr: string]: string | number | boolean | Function } = {}
+export const buildHtmlProps = (htmlOptions: { [key: string]: string | number | boolean | (() => void)}) => {
+  const htmlProps: { [attr: string]: string | number | boolean | (() => void) } = {}
   Object.keys(htmlOptions).forEach((key) => {
     htmlProps[key] = htmlOptions[key]
   })

data/app/pb_kits/playbook/utilities/test/globalProps/truncate.test.js

@@ -0,0 +1,21 @@
+import React from 'react'
+import { render, screen } from '../../test-utils'
+
+import Body from '../../../pb_body/_body'
+
+const testSubject = 'body'
+
+test('Global Props: Returns corrrect truncate class name', () => {
+  for(let x = 1, y = 5; x <= y; ++x) {
+    const testId = `${testSubject}-${x}`
+    render(
+      <Body
+          data={{ testid: testId }}
+          text="Hi"
+          truncate={`${x}`}
+      />
+    )
+    const kit = screen.getByTestId(testId)
+    expect(kit).toHaveClass(`truncate_${x}`)
+  }
+})