RubyGems - playbook_ui - Versions diffs - 12.4.0 → 12.5.0.pre.alpha.filter1 - Mend

playbook_ui 12.4.0 → 12.5.0.pre.alpha.filter1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (38) hide show

data/app/pb_kits/playbook/pb_loading_inline/_loading_inline.tsx ADDED Viewed

@@ -0,0 +1,55 @@
+import React from 'react'
+import classnames from 'classnames'
+import { buildAriaProps, buildCss, buildDataProps } from '../utilities/props'
+import { globalProps } from '../utilities/globalProps'
+import Body from '../pb_body/_body'
+import Icon from '../pb_icon/_icon'
+type LoadingInlineProps = {
+  align?: "left" | "center" | "right",
+  aria?: { [key: string]: string },
+  className?: string,
+  data?: { [key: string]: string },
+  id?: string,
+}
+const LoadingInline = (props: LoadingInlineProps) => {
+  const {
+    align = 'left',
+    aria = {},
+    className,
+    data = {},
+    id,
+  } = props
+  const ariaProps = buildAriaProps(aria)
+  const dataProps = buildDataProps(data)
+  const classes = classnames(
+    buildCss(`pb_loading_inline_kit_${align}`),
+    globalProps(props),
+    className
+  )
+  return (
+    <div
+      {...ariaProps}
+      {...dataProps}
+      className={classes}
+      id={id}
+    >
+      <Body color="light">
+        <Icon
+          aria={{ label: 'loading icon' }}
+          fixedWidth
+          icon="spinner"
+          pulse
+        />
+        {' Loading'}
+      </Body>
+    </div>
+  )
+}
+export default LoadingInline

data/app/pb_kits/playbook/pb_loading_inline/loading_inline.test.js ADDED Viewed

@@ -0,0 +1,41 @@
+import React from 'react'
+import { render, screen } from '../utilities/test-utils'
+import LoadingInline from './_loading_inline'
+const testId = "loadingInline"
+test('should render custom class and data', () => {
+    render(
+        <LoadingInline
+            className='custom-class'
+            data={{ testid: testId }}
+        />
+    )
+    const kit = screen.getByTestId(testId)
+    expect(kit).toHaveClass('custom-class')
+})
+test('should render id', () => {
+    render(
+        <LoadingInline
+            data={{ testid: testId }}
+            id={testId}
+        />
+    )
+    const kit = screen.getByTestId(testId)
+    expect(kit).toHaveProperty('id', testId)
+})
+test('should render aria-label', () => {
+    render(
+        <LoadingInline
+            aria={{ label: testId }}
+            data={{ testid: testId }}
+        />
+    )
+    const kit = screen.getByTestId(testId)
+    expect(kit).toHaveAttribute('aria-label', testId)
+})

data/app/pb_kits/playbook/pb_map/_map.scss CHANGED Viewed

@@ -1,8 +1,120 @@
 @import "../tokens/typography";
-@import "../tokens/colors";
+@import "../tokens/colors";
 @import "../tokens/shadows";
+@import "../tokens/border_radius";
-.pb_map {
+[class*="pb_map"] {
   font-family: $font_family_base !important;
+  .maplibregl-ctrl-attrib-button {
+    &:focus {
+      box-shadow: unset;
+    }
+    &:focus-visible {
+      box-shadow: 0 0 0 1px $primary_action;
+    }
+    &:hover {
+      box-shadow: $shadow_deep;
+    }
+  }
+  .custom-nav-control {
+    position: absolute;
+    right: $space_xs + 2;
+    top: $space_xs + 2;
+    z-index: 2;
+    .custom-nav-control-zoom {
+      border-radius: $border_radius_md;
+      box-shadow: $shadow_deep;
+      background: $card_light;
+      .map-zoom-in-button {
+        border-bottom-left-radius: unset;
+        border-bottom-right-radius: unset;
+        border-bottom: transparent;
+      }
+      .map-zoom-out-button {
+        border-top-left-radius: unset;
+        border-top-right-radius: unset;
+      }
+    }
+    .map-zoom-in-button,
+    .map-zoom-out-button,
+    .map-flyto-button {
+      border: solid 1px $border_light;
+      cursor: pointer;
+      padding: $space_xs + 2;
+      text-align: center;
+      color: $text_lt_light;
+      background-color: $card_light;
+      display: flex;
+      justify-content: center;
+      align-items: center;
+      svg {
+        width: $space_xs + 4;
+        height: $space_sm;
+        display: flex;
+      }
+      &:hover {
+        background-color: darken($bg_light, 2%);
+      }
+      &:focus-visible {
+        border: solid 1px $primary_action;
+        box-shadow: unset;
+      }
+    }
+    .map-flyto-button {
+      border-radius: $border_radius_md;
+      margin-top: $space_xs;
+      box-shadow: $shadow_deep;
+      background-color: $card_light;
+    }
+  }
+  .maplibregl-popup-content {
+    padding: $space_sm;
+    background-color: $card_light;
+    box-shadow: $shadow_deeper;
+  }
+  &.dark {
+    .maplibregl-canvas {
+      filter: invert(100%) brightness(175%) contrast(80%) sepia(50%) saturate(2)
+        hue-rotate(185deg);
+    }
+    .pb_section_separator_kit_card_horizontal::after {
+      background: $border_dark;
+    }
+    .custom-nav-control-zoom {
+      border: solid 1px #0a0527;
+      background: $bg_dark;
+    }
+    .maplibregl-popup-content {
+      background-color: $bg_dark;
+      color: $text_dk_default;
+    }
+    .mapboxgl-popup-anchor-bottom .mapboxgl-popup-tip,
+    .maplibregl-popup-anchor-bottom .maplibregl-popup-tip {
+      border-top-color: $bg_dark;
+    }
+    .map-zoom-in-button,
+    .map-zoom-out-button,
+    .map-flyto-button {
+      color: $text_dk_default;
+      background-color: $bg_dark;
+      border-color: $border_dark;
+      &:hover {
+        background-color: #221e3d;
+      }
+    }
+  }
 }

data/app/pb_kits/playbook/pb_map/_map.tsx CHANGED Viewed

@@ -1,8 +1,11 @@
 import React from 'react'
 import classnames from 'classnames'
 import { buildAriaProps, buildCss, buildDataProps } from '../utilities/props'
-import { globalProps } from '../utilities/globalProps'
+import { globalProps, GlobalProps } from '../utilities/globalProps'
+import Flex  from "../pb_flex/_flex"
+import Icon from '../pb_icon/_icon'
+import Button from '../pb_button/_button'
 type MapProps = {
   aria?: { [key: string]: string },
@@ -10,7 +13,12 @@ type MapProps = {
   className?: string,
   data?: { [key: string]: string },
   id?: string,
-}
+  zoomBtns?: boolean,
+  flyTo?: boolean,
+  zoomInClick?: () => {},
+  zoomOutClick?: () => {},
+  flyToClick?: () => {},
+} & GlobalProps
 const Map = (props: MapProps) => {
   const {
@@ -19,6 +27,11 @@ const Map = (props: MapProps) => {
   className,
   data = {},
   id,
+  zoomBtns = false,
+  flyTo = false,
+  zoomInClick,
+  zoomOutClick,
+  flyToClick
   } = props
   const ariaProps = buildAriaProps(aria)
@@ -32,6 +45,33 @@ const Map = (props: MapProps) => {
         className={classes}
         id={id}
     >
+      {
+        zoomBtns ? (
+          <Flex className="custom-nav-control" orientation='column'>
+            <div className="custom-nav-control-zoom">
+              <Button className='map-zoom-in-button'
+                  onClick={zoomInClick}
+              >
+                    <Icon icon="plus"/>
+              </Button>
+              <Button className='map-zoom-out-button'
+                 onClick={zoomOutClick}
+              >
+                    <Icon icon="minus"/>
+              </Button>
+            </div>
+            {
+              flyTo ? (
+                <Button className='map-flyto-button'
+                  onClick={flyToClick}
+                >
+                      <Icon icon="eye"/>
+                </Button>
+              ) : null
+            }
+         </Flex>
+         ) : null
+      }
       {children}
     </div>
   )

data/app/pb_kits/playbook/pb_map/docs/_map_default.jsx CHANGED Viewed

@@ -1,40 +1,63 @@
-import React, { useRef, useEffect } from 'react'
+import React, { useRef, useEffect, useState } from 'react'
 import { Map } from '../../'
 import maplibregl from 'maplibre-gl'
+import mapTheme from '../pbMapTheme'
-const MapDefault = () => {
+const MapDefault = (props) => {
+  //set Map instance to access from outside useEffect
+  const [mapInstance, setMapInstance] = useState(null)
   const mapContainerRef = useRef(null)
-    useEffect(() => {
-      if (!maplibregl.supported()) {
-        alert('Your browser does not support MapLibre GL');
-        } else {
-         const map = new maplibregl.Map({
-            container: mapContainerRef.current,
-            style: 'https://basemaps.cartocdn.com/gl/positron-gl-style/style.json',
-            center: [-75.379143, 39.831200],
-            zoom: 13,
-        })
+  //Set default position
+  const defaultPosition = [-75.379143, 39.831200]
+  // linking Maplibre methods to PB custom zoom in, zoom out, and fly to buttons
+  const handleZoomIn = (map) => {map.zoomIn({...mapTheme.zoomConfig})}
+  const handleZoomOut = (map) => {map.zoomOut({...mapTheme.zoomConfig})}
+  const handleFlyTo = (map) => {map.flyTo({
+                                center: defaultPosition,
+                                ... mapTheme.flyToConfig
+                                });}
+  //This function is called by the useEffect when map instance first loads
+  const loadMap = ( { target: map }) => {
         //set marker/pin
-        /* eslint-disable-next-line */
-        const marker = new maplibregl.Marker({
-          color: "#0056CF",
-        }).setLngLat([-75.379143, 39.831200])
-        .setPopup(new maplibregl.Popup({className: 'map_popup', closeButton: false}).setHTML(`<h4 class="pb_title_kit_size_4">Hello World!</h4>`)) // add popup
+        new maplibregl.Marker({
+          color: mapTheme.marker,
+        }).setLngLat(defaultPosition)
+        .setPopup(new maplibregl.Popup({closeButton: false}).setHTML(`<h4 class="pb_title_kit_size_4">Hello World!</h4>`)) // add popup
         .addTo(map);
-        //add zoom controls
-        map.addControl(new maplibregl.NavigationControl({showCompass: false}))
         // disable map zoom when using scroll
         map.scrollZoom.disable();
+        //add attributioncontrols
+        map.addControl(new maplibregl.AttributionControl({
+          compact: true
+          }));
+        //set map instance
+        setMapInstance(map)
+  }
+    useEffect(() => {
+         new maplibregl.Map({
+            container: mapContainerRef.current,
+            center: defaultPosition,
+            ...mapTheme.mapConfig
+        }).on('load', loadMap)
-      }
     }, [])
 return (
-  <Map>
+  <Map flyTo
+      flyToClick={()=> {handleFlyTo(mapInstance)}}
+      zoomBtns
+      zoomInClick={() => {handleZoomIn(mapInstance)}}
+      zoomOutClick={()=> {handleZoomOut(mapInstance)}}
+      {...props}
+  >
        <div
            ref={mapContainerRef}
            style={{
@@ -44,7 +67,7 @@ return (
               top: 0,
               bottom: 0,
            }}
-        />
+       />
     </Map>
 )
 }

data/app/pb_kits/playbook/pb_map/docs/_map_default.md CHANGED Viewed

@@ -2,12 +2,12 @@ This kit provides a wrapping class to place around the MapLibre library. Complet
 Basic setup to start using MapLibre:
 - Install the npm package using `yarn add maplibre-gl`
-- Include a link to the CSS file as a CDN in your stylesheet using the following syntax:
-`@import url("https://unpkg.com/maplibre-gl@2.4.0/dist/maplibre-gl.css");`
- or include it as a link in the <head> tag `<link href='https://unpkg.com/maplibre-gl@2.4.0/dist/maplibre-gl.css' rel='stylesheet' />`
-- To use Maplibre, you must also set a height on the containing div.
+- To include the maplibre css, include a link to the CSS file as a CDN in your stylesheet using the following syntax: `@import url("https://unpkg.com/maplibre-gl@2.4.0/dist/maplibre-gl.css");`
+ OR include it as a link in the <head> tag `<link href='https://unpkg.com/maplibre-gl@2.4.0/dist/maplibre-gl.css' rel='stylesheet' />`
 - You can now use MapLibre within the Map Kit as shown in this example.
 __Notes__ :
-- The MapLibre Marker allows us to pass it a HEX value as a color prop. In these doc examples we are using our primary color for the Marker.
+- To enable custom buttons, set `zoomBtns` and `flyTo` to true and pass in `zoomInClick`, `zoomOutClick` and `flyToClick` as shown in this doc example.
+- Use `mapTheme.marker` to set the Marker color.
+- To use Maplibre, you must also set a height and width to the containing div (.pb_map) and set position to 'relative'.
 - `scrollZoom` has been disabled in these doc examples for page usability

data/app/pb_kits/playbook/pb_map/docs/_map_with_plugin.jsx CHANGED Viewed

@@ -2,30 +2,26 @@ import React, { useRef, useEffect } from 'react'
 import { Map } from '../../'
 import maplibregl from 'maplibre-gl'
 import MapboxDraw from "@mapbox/mapbox-gl-draw";
+import mapTheme from '../pbMapTheme'
-const MapWithPlugin = () => {
+const MapWithPlugin = (props) => {
+    //set Map instance to access from outside useEffect
+    const mapContainerRef = useRef(null)
-  const mapContainerRef = useRef(null)
+      //Set default position
+    const defaultPosition = [-75.379143, 39.831200]
-    useEffect(() => {
-      if (!maplibregl.supported()) {
-        alert('Your browser does not support MapLibre GL');
-        } else {
-         const map = new maplibregl.Map({
-            container: mapContainerRef.current,
-            style: 'https://basemaps.cartocdn.com/gl/positron-gl-style/style.json',
-            center: [-75.379143, 39.831200],
-            zoom: 13,
-        })
+    //This function should contain all maplibre related code
+    const loadMap = ( { target: map }) => {
         //set marker/pin
         /* eslint-disable-next-line */
         const marker = new maplibregl.Marker({
-          color: "#0056CF",
-        }).setLngLat([-75.379143, 39.831200])
+          color: mapTheme.marker,
+        }).setLngLat(defaultPosition)
         .setPopup(new maplibregl.Popup({className: 'map_popup', closeButton: false}).setHTML(`<h4 class="pb_title_kit_size_4">Hello World!</h4>`)) // add popup
         .addTo(map);
-        //add zoom controls
+        //add maplibre default zoom controls
         map.addControl(new maplibregl.NavigationControl({showCompass: false}))
         // disable map zoom when using scroll
@@ -40,13 +36,20 @@ const MapWithPlugin = () => {
             }
             });
             map.addControl(draw);
-      }
+    }
+    useEffect(() => {
+         new maplibregl.Map({
+            container: mapContainerRef.current,
+            center: [-75.379143, 39.831200],
+            ...mapTheme.mapConfig
+        }).on('load', loadMap)
     }, [])
 return (
-  <Map>
+  <Map {...props} >
        <div
            ref={mapContainerRef}
            style={{

data/app/pb_kits/playbook/pb_map/docs/example.yml CHANGED Viewed

@@ -4,4 +4,3 @@ examples:
   react:
   - map_default: Default
   - map_with_plugin: Map With Polygon Draw Plugin

data/app/pb_kits/playbook/pb_map/pbMapTheme.ts ADDED Viewed

@@ -0,0 +1,23 @@
+import colors from '../tokens/exports/_colors.scss'
+const mapTheme = {
+    marker : colors.primary_action,
+    maptiles: 'https://basemaps.cartocdn.com/gl/positron-gl-style/style.json',
+    flyToConfig: {
+        zoom: 13,
+        bearing: 0,
+        curve: 1.42, // change the speed at which it zooms
+               easing: function (t: any) {
+                return t;
+                },
+        essential: true
+    },
+    zoomConfig: { duration:1000 },
+    mapConfig: {
+            style: 'https://basemaps.cartocdn.com/gl/positron-gl-style/style.json',
+            zoom: 13,
+            attributionControl: false,
+    }
+}
+export default mapTheme

data/app/pb_kits/playbook/pb_message/{_message.jsx → _message.tsx} RENAMED Viewed

@@ -13,11 +13,11 @@ import Timestamp from '../pb_timestamp/_timestamp'
 import Title from '../pb_title/_title'
 type MessageProps = {
-  aria: object,
+  aria: { [key: string]: string },
   avatarName?: string,
-  avatarStatus?: string,
+  avatarStatus?: "away" | "offline" | "online",
   avatarUrl?: string,
-  children?: array<React.ReactNode> | React.ReactNode,
+  children?: React.ReactChild[] | React.ReactChild,
   className?: string,
   data?: object,
   id?: string,
@@ -61,53 +61,53 @@ const Message = (props: MessageProps) => {
   return (
     <div
-        {...ariaProps}
-        {...dataProps}
-        className={classes}
-        id={id}
+      {...ariaProps}
+      {...dataProps}
+      className={classes}
+      id={id}
     >
-      <If condition={shouldDisplayAvatar}>
+      {shouldDisplayAvatar &&
         <Avatar
-            imageUrl={avatarUrl}
-            name={avatarName}
-            size="xs"
-            status={avatarStatus}
+          imageUrl={avatarUrl}
+          name={avatarName}
+          size="xs"
+          status={avatarStatus}
         />
-      </If>
+      }
       <div className="content_wrapper">
         <Flex
-            justify={alignTimestamp === 'left' ? 'none' : 'between'}
-            orientation="row"
+          justify={alignTimestamp === 'left' ? 'none' : 'between'}
+          orientation="row"
         >
-          <If condition={label}>
+          {label &&
             <Title
-                className="message_title"
-                size={4}
-                text={label}
+              className="message_title"
+              size={4}
+              text={label}
             />
-          </If>
+          }
           <Timestamp
-              className={`pull-${alignTimestamp} ${timestampObject ? 'message_humanized_time' : null}`}
-              text={timestamp}
-              timezone={timezone}
+            className={`pull-${alignTimestamp} ${timestampObject ? 'message_humanized_time' : null}`}
+            text={timestamp}
+            timestamp={''}
+            timezone={timezone}
           />
-          <If condition={timestampObject}>
+          {timestampObject &&
             <Timestamp
-                className={`pull-${alignTimestamp} message_timestamp`}
-                timestamp={timestampObject}
-                timezone={timezone}
+              className={`pull-${alignTimestamp} message_timestamp`}
+              text={''}
+              timestamp={timestampObject}
+              timezone={timezone}
             />
-          </If>
+          }
         </Flex>
-        <If condition={message}>
+        {message &&
           <Body
-              className="pb_message_body"
-              text={message}
+            className="pb_message_body"
+            text={message}
           />
-        </If>
-        <If condition={children}>
-          { children }
-        </If>
+        }
+        {children}
       </div>
     </div>
   )

data/app/pb_kits/playbook/pb_message/message.test.js ADDED Viewed

@@ -0,0 +1,63 @@
+import React from 'react'
+import { render, screen } from '../utilities/test-utils'
+import Message from './_message'
+import Image from './../pb_image/_image'
+const testId = "message"
+const MessageDefault = () => {
+    return (
+        <>
+            <Message
+                avatarName="Becca Jacobs"
+                avatarUrl="https://randomuser.me/api/portraits/women/50.jpg"
+                className='custom-class'
+                data={{ testid: testId }}
+                label="Lucille Sanchez"
+                message="Application for Kate Smith is waiting for your approval"
+                timestamp="2 days ago"
+            >
+                <Image
+                    alt="picture of a misty forest"
+                    size="md"
+                    url="https://unsplash.it/500/400/?image=634"
+                />
+            </Message>
+        </>
+    )
+}
+test('should render message', () => {
+    render(<MessageDefault />)
+    const kit = screen.getByText('Application for Kate Smith is waiting for your approval')
+    expect(kit).toBeInTheDocument()
+})
+test('should render label', () => {
+    render(<MessageDefault />)
+    const kit = screen.getByText('Lucille Sanchez')
+    expect(kit).toBeInTheDocument()
+})
+test('should render timestamp', () => {
+    render(<MessageDefault />)
+    const kit = screen.getByText('2 days ago')
+    expect(kit).toBeInTheDocument()
+})
+test('should render custom class and data', () => {
+    render(<MessageDefault />)
+    const kit = screen.getByTestId(testId)
+    expect(kit).toHaveClass('custom-class')
+})
+test('should render a children', () => {
+    render(<MessageDefault />)
+    const kit = screen.getByAltText('picture of a misty forest')
+    expect(kit).toBeInTheDocument()
+})