playbook_ui 14.7.0.pre.rc.17 → 14.7.0.pre.rc.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2072d24d3604697c8b8201173a1b3fe1384f8acdcc7fffd52442d302f5e2f38
-  data.tar.gz: 9766561957de9ca49b03df0e3cb54d11c9e2350e95031b8a732779e8acf908bf
+  metadata.gz: ff95e6830d7c3a6d2ad6c69bd177579486ca0ceac9e75f827311089beeee445e
+  data.tar.gz: 12abc183a5222f5e601530a455f77a39de018355c50d0d84b064871e0c406fb6
 SHA512:
-  metadata.gz: 8eb6bf2917756b803c3d70ef69a353b9a4e5d900a2f43d5bb6fac6e6e5319e43b0687b409ab35257f7ab38e7f01bd98269650f954cd1f0cf887478899752baa9
-  data.tar.gz: 38e59e257ba51802810b8fa7164586d9b8e1e68092ce52c894240b5fb8726712dce06bd1b46524e7a1e5cd8aeefa08cddf3d1ef55b7da8ef357edd156f8b3f43
+  metadata.gz: 61fd7de49207a9766dbbcf14a08d0ec23a2a337b7aa1aaf28b17202893f41c9661c380302a096c399b5855521f44c3b715a8ccf08d9b78a58cfd698cba7c570c
+  data.tar.gz: 6f7bd6331cbca3e289110278961cf96b6c5149465d70c5ca15ce8a0f098259da0b42dceea0745998fade1d97a44c7f12030f8de6655af5e51f9dcdf08c5816b7

data/app/pb_kits/playbook/_playbook.scss

@@ -1,4 +1,3 @@
-
 @import 'pb_advanced_table/advanced_table';
 @import 'pb_avatar/avatar';
 @import 'pb_avatar_action_button/avatar_action_button';
@@ -85,6 +84,7 @@
 @import 'pb_selectable_card_icon/selectable_card_icon';
 @import 'pb_selectable_icon/selectable_icon';
 @import 'pb_selectable_list/selectable_list';
+@import 'pb_skeleton_loading/skeleton_loading';
 @import 'pb_source/source';
 @import 'pb_star_rating/star_rating';
 @import 'pb_stat_change/stat_change';

data/app/pb_kits/playbook/pb_skeleton_loading/_skeleton_loading.scss

@@ -0,0 +1,37 @@
+@import 'skeleton_loading_mixins';
+
+.pb_skeleton_loading {
+    display: "flex";
+    flex-direction: "column";
+    height: 100%;
+    .color_default {
+        @include skeleton-shimmer($silver);
+    }
+    .color_white {
+        @include skeleton-shimmer-light($white);
+    }
+    .dark {
+        @include skeleton-shimmer($border_dark);
+    }
+    .gap_xxs {
+        margin-top: 4px;
+    }
+    .gap_xs {
+        margin-top: 8px;
+    }
+    .gap_sm {
+        margin-top: 16px;
+    }
+    .gap_md {
+        margin-top: 24px;
+    }
+    .gap_lg {
+        margin-top: 32px;
+    }
+    .gap_xl {
+        margin-top: 40px;
+    }
+    .gap_xxl {
+        margin-top: 48px;
+    }
+}

data/app/pb_kits/playbook/pb_skeleton_loading/_skeleton_loading.tsx

@@ -0,0 +1,67 @@
+
+import React from 'react'
+import classnames from 'classnames'
+import { buildAriaProps, buildCss, buildDataProps, buildHtmlProps } from '../utilities/props'
+import { globalProps, GlobalProps } from '../utilities/globalProps'
+import { Sizes } from '../types'
+
+
+type SkeletonLoadingProps = {
+  aria?: { [key: string]: string },
+  className?: string,
+  data?: { [key: string]: string },
+  id?: string,
+  htmlOptions?: {[key: string]: string | number | boolean | (() => void)},
+  height?: string,
+  width?: string,
+  borderRadius?: string,
+  gap?: Sizes | "none",
+  stack?: number,
+  color?: "default" | "white",
+  dark?: boolean,
+} & GlobalProps
+
+const SkeletonLoading = (props: SkeletonLoadingProps): React.ReactElement => {
+  const {
+    aria = {},
+    className,
+    data = {},
+    id,
+    htmlOptions = {},
+    height = "16px",
+    width = "100%",
+    borderRadius = "sm",
+    gap = "xxs",
+    stack = 1,
+    color = "default",
+    dark = false,
+  } = props
+
+  const ariaProps = buildAriaProps(aria)
+  const dataProps = buildDataProps(data)
+  const htmlProps = buildHtmlProps(htmlOptions)
+  const skeletonContainerCss = classnames(buildCss('pb_skeleton_loading'), globalProps(props), className)
+  const gapClass = gap !== 'none' ? `gap_${gap}` : ''
+  const innerSkeletonCss = classnames(`border_radius_${borderRadius}`,`color_${color}`, dark && 'dark', )
+  const innerSizeStyle = { height, width }
+  
+  return (
+    <div
+        {...ariaProps}
+        {...dataProps}
+        {...htmlProps}
+        className={skeletonContainerCss}
+        id={id}
+    >
+      {Array.from({ length: Number(stack) }).map((_, index) => (
+        <div
+            className={classnames(buildCss('pb_skeleton_loading_item'), innerSkeletonCss, index > 0 && gapClass)}
+            key={index}
+            style={innerSizeStyle}
+        />
+      ))}
+    </div>
+  )
+}
+
+export default SkeletonLoading

data/app/pb_kits/playbook/pb_skeleton_loading/_skeleton_loading_mixins.scss

@@ -0,0 +1,40 @@
+// Animation
+@keyframes wave {
+    0% {
+      background-position: -468px 0;
+    }
+    100% {
+      background-position: 468px 0;
+    }
+}
+
+// Shimmer animation and gradient mixin based on color
+@mixin skeleton-shimmer($color) {
+    background: $color;
+    background-color: $color;
+    background-image: linear-gradient(
+      to left,
+      $color 0%,
+      lighten($color, 1%) 50%,
+      lighten($color, 1%) 60%,
+      $color 80%,
+      $color 100%
+    );
+    background-repeat: no-repeat;
+    animation: wave 1.5s linear infinite forwards;
+}
+
+@mixin skeleton-shimmer-light($color) {
+    background: $color;
+    background-color: $color;
+    background-image: linear-gradient(
+      to left,
+      $color 0%,
+      darken($color, 1%) 50%,
+      darken($color, 1%) 60%,
+      $color 80%,
+      $color 100%
+    );
+    background-repeat: no-repeat;
+    animation: wave 1.5s linear infinite forwards;
+}

data/app/pb_kits/playbook/pb_skeleton_loading/docs/_skeleton_loading_border_radius.jsx

@@ -0,0 +1,51 @@
+import React from 'react'
+import { Flex, SkeletonLoading } from "playbook-ui"
+
+
+const SkeletonLoadingBorderRadius = (props) => (
+  <Flex justify="evenly">
+    <SkeletonLoading 
+        borderRadius="rounded" 
+        height="50px" 
+        width="100px" 
+        {...props}
+    />
+    <SkeletonLoading 
+        borderRadius="xl" 
+        height="50px" 
+        width="100px" 
+        {...props}
+    />
+    <SkeletonLoading 
+        borderRadius="lg" 
+        height="50px" 
+        width="100px" 
+        {...props}
+    />
+    <SkeletonLoading 
+        borderRadius="md" 
+        height="50px" 
+        width="100px" 
+        {...props}
+    />
+    <SkeletonLoading 
+        height="50px" 
+        width="100px" 
+        {...props}
+    />
+    <SkeletonLoading 
+        borderRadius="xs" 
+        height="50px" 
+        width="100px" 
+        {...props}
+    />
+    <SkeletonLoading 
+        borderRadius="none" 
+        height="50px" 
+        width="100px" 
+        {...props}
+    />
+  </Flex>
+)
+
+export default SkeletonLoadingBorderRadius

data/app/pb_kits/playbook/pb_skeleton_loading/docs/_skeleton_loading_border_radius.md

@@ -0,0 +1 @@
+The `borderRadius` prop accepts all of our [BorderRadius](https://playbook.powerapp.cloud/visual_guidelines/border_radius) tokens, with `sm` as default.

data/app/pb_kits/playbook/pb_skeleton_loading/docs/_skeleton_loading_color.jsx

@@ -0,0 +1,26 @@
+import React from 'react'
+import { Card, SkeletonLoading } from "playbook-ui"
+
+
+const SkeletonLoadingColor = (props) => (
+  <div>
+    <Card 
+        borderNone 
+        {...props}
+    >
+      <SkeletonLoading {...props}/>
+    </Card>
+    <Card 
+        background="light" 
+        borderNone 
+        {...props}
+    >
+      <SkeletonLoading 
+          color="white" 
+          {...props} 
+      />
+    </Card>
+  </div>
+)
+
+export default SkeletonLoadingColor

data/app/pb_kits/playbook/pb_skeleton_loading/docs/_skeleton_loading_color.md

@@ -0,0 +1 @@
+The SkeletonLoading component has a default and a white `color` variant.

data/app/pb_kits/playbook/pb_skeleton_loading/docs/_skeleton_loading_default.html.erb

@@ -0,0 +1 @@
+<%= pb_rails("skeleton_loading") %>

data/app/pb_kits/playbook/pb_skeleton_loading/docs/_skeleton_loading_default.jsx

@@ -0,0 +1,11 @@
+import React from 'react'
+import { SkeletonLoading } from "playbook-ui"
+
+
+const SkeletonLoadingDefault = (props) => (
+  <div>
+    <SkeletonLoading {...props} />
+  </div>
+)
+
+export default SkeletonLoadingDefault

data/app/pb_kits/playbook/pb_skeleton_loading/docs/_skeleton_loading_height_width.jsx

@@ -0,0 +1,59 @@
+import React from 'react'
+import { Card, SkeletonLoading } from "playbook-ui"
+
+
+const SkeletonLoadingHeightWidth = (props) => (
+  <div>
+    <SkeletonLoading
+        height="100px"
+        width="50%"
+        {...props}
+    />
+    <SkeletonLoading
+        gap="md"
+        height="20px"
+        marginY="md"
+        stack="3"
+        width="50px"
+        {...props}
+    />
+    <Card htmlOptions={{ style: { height: '200px', width: '100%' }}} 
+        marginBottom="md"
+        padding="none" 
+    >
+      <SkeletonLoading
+          borderRadius="md"
+          gap="xl"
+          height="50%"
+          width="300px"
+          {...props}
+      />
+    </Card>
+    <Card htmlOptions={{ style: { height: '200px', width: '100%' }}} 
+        padding="none"
+    >
+      <SkeletonLoading
+          borderRadius="md"
+          gap="xl"
+          height="30%"
+          stack="2"
+          width="70%"
+          {...props}
+      />
+    </Card>
+    <SkeletonLoading 
+        height="150px"
+        marginY="md"
+        width="150px"
+        {...props}
+    />
+    <SkeletonLoading 
+        borderRadius="rounded"
+        height="150px"
+        width="150px"
+        {...props}
+    />
+  </div>
+)
+
+export default SkeletonLoadingHeightWidth

data/app/pb_kits/playbook/pb_skeleton_loading/docs/_skeleton_loading_height_width.md

@@ -0,0 +1,3 @@
+The `height` and `width` props accept pixel and percentage values. If using a percentage for `height`, the parent container must have a set height.
+
+Set the `height` and `width` props to the same value to make a square. A `rounded` borderRadius will make a square a circle. If using percentages to make a square, your parent container must also be a square.

data/app/pb_kits/playbook/pb_skeleton_loading/docs/_skeleton_loading_layout.jsx

@@ -0,0 +1,20 @@
+import React from 'react'
+import { SkeletonLoading } from "playbook-ui"
+
+
+const SkeletonLoadingLayout = (props) => (
+  <div>
+    <SkeletonLoading
+        stack="5"
+        {...props}
+    />
+    <SkeletonLoading
+        gap="md"
+        paddingTop="xl"
+        stack="3"
+        {...props}
+    />
+  </div>
+)
+
+export default SkeletonLoadingLayout

data/app/pb_kits/playbook/pb_skeleton_loading/docs/_skeleton_loading_layout.md

@@ -0,0 +1,3 @@
+Use the `stack` and `gap` props in conjunction to layer multiple Skeleton loading bars on top of each other.
+
+`stack` accepts a number that correlates to the number of rows (1 is default), and `gap` accepts a portion of our [spacing props](https://playbook.powerapp.cloud/visual_guidelines/spacing) (`xxs` as default, `xs`, `sm`, `md`, `lg`, `xl`, `xxl`) to set the pixel distance between each row. `gap` will not do anything if there is no corresponding `stack` prop set.

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

@@ -0,0 +1,13 @@
+examples:
+  
+  rails:
+  # - skeleton_loading_default: Default
+  
+  
+  react:
+  - skeleton_loading_default: Default
+  - skeleton_loading_color: Color
+  - skeleton_loading_layout: Layout
+  - skeleton_loading_border_radius: Border Radius
+  - skeleton_loading_height_width: Height & Width
+  

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

@@ -0,0 +1,5 @@
+export { default as SkeletonLoadingDefault } from './_skeleton_loading_default.jsx'
+export { default as SkeletonLoadingColor } from './_skeleton_loading_color.jsx'
+export { default as SkeletonLoadingLayout } from './_skeleton_loading_layout.jsx'
+export { default as SkeletonLoadingBorderRadius } from './_skeleton_loading_border_radius.jsx'
+export { default as SkeletonLoadingHeightWidth } from './_skeleton_loading_height_width.jsx'

data/app/pb_kits/playbook/pb_skeleton_loading/skeleton_loading.html.erb

@@ -0,0 +1,12 @@
+<!-- Go to pb_content_tag definition in kit_base.rb for usage information. Commented out options are default (showing the default shape), and each can be deleted if not customizing that param. -->
+<!-- If using nonstandard params please un-comment out and replace with your custom params. -->
+<%= pb_content_tag(
+    # :div,
+    # aria: object.aria,
+    # class: object.classname,
+    # data: object.data,
+    # id: object.id,
+    # **combined_html_options
+) do %>
+  <span>SKELETON_LOADING CONTENT</span>
+<% end %>

data/app/pb_kits/playbook/pb_skeleton_loading/skeleton_loading.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Playbook
+  module PbSkeletonLoading
+    class SkeletonLoading < ::Playbook::KitBase
+    end
+  end
+end

data/app/pb_kits/playbook/pb_skeleton_loading/skeleton_loading.test.jsx

@@ -0,0 +1,81 @@
+import React from 'react'
+import { render, screen } from '@testing-library/react'
+import { ensureAccessible } from '../utilities/test-utils'
+import { SkeletonLoading } from 'playbook-ui'
+
+/* See these resources for more testing info:
+  - https://github.com/testing-library/jest-dom#usage for useage and examples
+  - https://jestjs.io/docs/en/using-matchers
+*/
+
+describe('SkeletonLoading', () => {
+  const defaultProps = {
+    data: { testid: 'skeleton-loading' }
+  }
+
+  it('should be accessible', async () => {
+    ensureAccessible(SkeletonLoading, defaultProps)
+  })
+
+  it('renders with default props', () => {
+    const { container } = render(<SkeletonLoading {...defaultProps} />)
+    const skeleton = screen.getByTestId('skeleton-loading')
+    
+    expect(skeleton).toBeInTheDocument()
+    expect(skeleton).toHaveClass('pb_skeleton_loading')
+    expect(container.querySelectorAll('div[class*="border_radius_"]')).toHaveLength(1)
+  })
+
+  it('renders multiple skeleton items based on stack prop', () => {
+    const props = {
+      ...defaultProps,
+      stack: 3
+    }
+    const { container } = render(<SkeletonLoading {...props} />)
+    
+    expect(container.querySelectorAll('div[class*="border_radius_"]')).toHaveLength(3)
+  })
+
+  it('applies custom styles correctly', () => {
+    const props = {
+      ...defaultProps,
+      height: '24px',
+      width: '50%',
+      borderRadius: 'lg',
+      color: 'light',
+      dark: true
+    }
+    const { container } = render(<SkeletonLoading {...props} />)
+    const skeletonItem = container.querySelector('div[class*="border_radius_"]')
+
+    expect(skeletonItem).toHaveClass('border_radius_lg')
+    expect(skeletonItem).toHaveClass('dark')
+  })
+
+  it('applies gap class to items after first one', () => {
+    const props = {
+      ...defaultProps,
+      stack: 3,
+      gap: 'md'
+    }
+    const { container } = render(<SkeletonLoading {...props} />)
+    const skeletonItems = container.querySelectorAll('div[class*="border_radius_"]')
+    
+    expect(skeletonItems[0]).not.toHaveClass('gap_md')
+    expect(skeletonItems[1]).toHaveClass('gap_md')
+    expect(skeletonItems[2]).toHaveClass('gap_md')
+  })
+
+  it('handles no gap properly', () => {
+    const props = {
+      ...defaultProps,
+      stack: 2,
+      gap: 'none'
+    }
+    const { container } = render(<SkeletonLoading {...props} />)
+    const skeletonItems = container.querySelectorAll('div[class*="border_radius_"]')
+    
+    expect(skeletonItems[0]).not.toHaveClass('gap_none')
+    expect(skeletonItems[1]).not.toHaveClass('gap_none')
+  })
+})