playbook_ui 13.12.0 → 13.13.0.pre.alpha.play900startratingasinput1657

data/app/pb_kits/playbook/pb_star_rating/_star_rating.tsx

@@ -1,97 +1,218 @@
 import React from "react"
 import classnames from "classnames"
 
-import { buildAriaProps, buildDataProps } from "../utilities/props"
+import { buildAriaProps, buildCss, buildDataProps, buildHtmlProps } from '../utilities/props'
+import { globalProps, GlobalProps } from '../utilities/globalProps'
 
-import Icon from "../pb_icon/_icon"
+import Caption from '../pb_caption/_caption'
+import Body from '../pb_body/_body'
+import Title from '../pb_title/_title'
+import Icon from '../pb_icon/_icon'
+import Flex from '../pb_flex/_flex'
 
 type StarRatingProps = {
   aria?: {[key: string]: string},
   className?: string,
   data?: object,
+  dark?: boolean,
   fixedWidth?: boolean,
-  hideRating: boolean,
+  layoutOption?: "default" | "number" | "onestar",
+  htmlOptions?: {[key: string]: string | number | boolean | Function},
   icon?: string,
   id?: string,
   rating: number,
-};
+  denominator: number,
+  colorOption?: "yellow" | "primary" | "subtle" | "outline",
+  backgroundType?: "fill" | "outline",
+  size?: "xs" | "sm" | "md" | "lg";
+} & GlobalProps
 
-const StarRating = ({
+const StarRating = (props: StarRatingProps) => {
+  const {
   aria = {},
   className,
   data = {},
-  hideRating = false,
+  dark = false,
+  layoutOption = "default",
+  htmlOptions = {},
   id,
   rating = 0,
-}: StarRatingProps) => {
+  denominator = 5,
+  colorOption = "yellow",
+  backgroundType = "fill",
+  size = "sm",
+} = props
+
+  const classes = classnames(buildCss('pb_star_rating_kit'), globalProps(props), className)
   const ariaProps = buildAriaProps(aria)
   const dataProps = buildDataProps(data)
-  const css = classnames([
-    "pb_star_rating_kit", className,
-  ])
+  const htmlProps = buildHtmlProps(htmlOptions)
+  const denominatorStyle = layoutOption === "onestar" ? 1 : denominator
+  const activeStars = Math.round(rating) > denominatorStyle ? denominatorStyle : Math.round(rating)
+  const emptyStars = denominatorStyle - Math.round(rating) < 0 ? 0 : denominatorStyle - Math.round(rating)
+  // let iconSize = ``
+  let iconSize = `pb_star_${size}`
+  // let iconDivClass = `pb_star_padding_${size}`
+
+  const starYellow = (
+    <svg className="iamyellow"  viewBox="0 0 18 16" fill="none" xmlns="http://www.w3.org/2000/svg">
+      <path fillRule="evenodd" clipRule="evenodd" d="M9.86015 0.4371C9.73527 0.187329 9.4855 0 9.17328 0C8.89229 0 8.64252 0.187329 8.51763 0.4371L6.36335 4.83932L1.58647 5.55742C1.30547 5.58864 1.08692 5.80719 0.99326 6.05696C0.899595 6.33795 0.962038 6.61895 1.18059 6.8375L4.64617 10.2719L3.80319 15.1112C3.77197 15.3922 3.89685 15.7044 4.11541 15.8605C4.36518 16.0166 4.64617 16.0478 4.89594 15.9229L9.17328 13.6126L13.4506 15.9229C13.7004 16.0478 14.0126 16.0166 14.2624 15.8605C14.4809 15.7044 14.6058 15.3922 14.5434 15.1112L13.7316 10.2719L17.1972 6.8375C17.4157 6.61895 17.4782 6.33795 17.3845 6.05696C17.2909 5.80719 17.0723 5.58864 16.7913 5.55742L12.0144 4.83932L9.86015 0.4371Z" fill="#F9BB00"/>
+    </svg>
+  )
+
+  const starPrimary = (
+    <svg  viewBox="0 0 18 16" fill="none" xmlns="http://www.w3.org/2000/svg">
+      <path fillRule="evenodd" clipRule="evenodd" d="M9.86015 0.4371C9.73527 0.187329 9.4855 0 9.17328 0C8.89229 0 8.64252 0.187329 8.51763 0.4371L6.36335 4.83932L1.58647 5.55742C1.30547 5.58864 1.08692 5.80719 0.99326 6.05696C0.899595 6.33795 0.962038 6.61895 1.18059 6.8375L4.64617 10.2719L3.80319 15.1112C3.77197 15.3922 3.89685 15.7044 4.11541 15.8605C4.36518 16.0166 4.64617 16.0478 4.89594 15.9229L9.17328 13.6126L13.4506 15.9229C13.7004 16.0478 14.0126 16.0166 14.2624 15.8605C14.4809 15.7044 14.6058 15.3922 14.5434 15.1112L13.7316 10.2719L17.1972 6.8375C17.4157 6.61895 17.4782 6.33795 17.3845 6.05696C17.2909 5.80719 17.0723 5.58864 16.7913 5.55742L12.0144 4.83932L9.86015 0.4371Z" fill="#0056CF"/>
+    </svg>
+  );
 
-  const starCount = () => (
-    [...Array(Math.floor(rating))]
+  const starSubtle = (
+    <svg  viewBox="0 0 18 16" fill="none" xmlns="http://www.w3.org/2000/svg">
+      <path className={dark === true ? "suble_star_dark" : "suble_star_light"} fillRule="evenodd" clipRule="evenodd" d="M8.90904 0.4371C8.78416 0.187329 8.53438 0 8.22217 0C7.94118 0 7.69141 0.187329 7.56652 0.4371L5.41224 4.83932L0.635357 5.55742C0.354364 5.58864 0.135813 5.80719 0.042149 6.05696C-0.0515154 6.33795 0.0109275 6.61895 0.229478 6.8375L3.69506 10.2719L2.85208 15.1112C2.82086 15.3922 2.94574 15.7044 3.16429 15.8605C3.41407 16.0166 3.69506 16.0478 3.94483 15.9229L8.22217 13.6126L12.4995 15.9229C12.7493 16.0478 13.0615 16.0166 13.3113 15.8605C13.5298 15.7044 13.6547 15.3922 13.5923 15.1112L12.7805 10.2719L16.2461 6.8375C16.4646 6.61895 16.5271 6.33795 16.4334 6.05696C16.3397 5.80719 16.1212 5.58864 15.8402 5.55742L11.0633 4.83932L8.90904 0.4371Z" />
+    </svg>
+  );
+
+  const starBackground = (
+    <svg  viewBox="0 0 18 16" fill="none" xmlns="http://www.w3.org/2000/svg">
+      <path className={dark === true ? "empty_star_dark" : "empty_star_light"} fillRule="evenodd" clipRule="evenodd" d="M9.31126 0.4371C9.18638 0.187329 8.93661 0 8.62439 0C8.3434 0 8.09363 0.187329 7.96874 0.4371L5.81446 4.83932L1.03758 5.55742C0.756585 5.58864 0.538035 5.80719 0.444371 6.05696C0.350706 6.33795 0.413149 6.61895 0.631699 6.8375L4.09728 10.2719L3.2543 15.1112C3.22308 15.3922 3.34797 15.7044 3.56652 15.8605C3.81629 16.0166 4.09728 16.0478 4.34705 15.9229L8.62439 13.6126L12.9017 15.9229C13.1515 16.0478 13.4637 16.0166 13.7135 15.8605C13.932 15.7044 14.0569 15.3922 13.9945 15.1112L13.1827 10.2719L16.6483 6.8375C16.8669 6.61895 16.9293 6.33795 16.8356 6.05696C16.742 5.80719 16.5234 5.58864 16.2424 5.55742L11.4655 4.83932L9.31126 0.4371Z" />
+    </svg>
   )
 
-  const hasHalfStar = () => (
-    rating % 1 !== 0
+  const starOutline = (
+    <svg  viewBox="0 0 18 16" fill="none" xmlns="http://www.w3.org/2000/svg">
+      <path className={dark === true ? "outline_star_dark" : "outline_star_light"} d="M5.91323 5.33377L6.17269 5.29477L6.28801 5.0591L8.44116 0.659187C8.49971 0.543364 8.59517 0.5 8.64884 0.5C8.74499 0.5 8.83506 0.555009 8.88775 0.659235L11.0409 5.0591L11.1562 5.29477L11.4157 5.33377L16.1925 6.05186L16.2021 6.0533L16.2117 6.05436C16.2359 6.05706 16.2671 6.06847 16.3024 6.09973C16.3374 6.13062 16.3686 6.17476 16.3886 6.22412C16.4186 6.32162 16.401 6.40181 16.3198 6.48332C16.3196 6.48353 16.3194 6.48374 16.3192 6.48394L12.8552 9.91671L12.6712 10.0991L12.7141 10.3546L13.5258 15.1939L13.528 15.2068L13.5308 15.2196C13.5488 15.3004 13.5074 15.402 13.4567 15.4462C13.3391 15.5132 13.2227 15.5096 13.1546 15.4781L8.88646 13.1726L8.64884 13.0443L8.41121 13.1726L4.14274 15.4782C4.07877 15.5083 3.99031 15.5147 3.87267 15.4466C3.82302 15.4033 3.76655 15.2914 3.77463 15.1781L4.61431 10.3577L4.65911 10.1005L4.47368 9.91671L1.0097 6.48394C1.00947 6.48372 1.00925 6.4835 1.00903 6.48327C0.927878 6.40178 0.910311 6.3216 0.94026 6.22412C0.960274 6.17476 0.99154 6.13062 1.02646 6.09973C1.0618 6.06847 1.09296 6.05706 1.11724 6.05436L1.12682 6.0533L1.13635 6.05186L5.91323 5.33377Z"/>
+    </svg>
   )
 
   return (
     <div
         {...ariaProps}
         {...dataProps}
-        className={css}
+        {...htmlProps}
+        className={classes}
         id={id}
     >
-    {!hideRating && (
-      <div className="pb_star_rating_number">
-        {rating}
-      </div>
-    )}
-      <div className="pb_star_rating_wrapper">
-        <div className="pb_star_rating_highlight">
-          {starCount().map((_, index) => (
-            <Icon
-                fixedWidth={false}
-                icon="star"
-                key={index}
-            />
-          ))}
-          {hasHalfStar() && (
-            <Icon
-              fixedWidth={false}
-              icon="star-half"
-            />
-          )}
-        </div>
-
-        <div className="pb_star_rating_base">
-          <Icon
-              fixedWidth={false}
-              icon="star"
-          />
-          <Icon
-              fixedWidth={false}
-              icon="star"
-          />
-          <Icon
-              fixedWidth={false}
-              icon="star"
-          />
-          <Icon
-              fixedWidth={false}
-              icon="star"
-          />
-          <Icon
-              fixedWidth={false}
-              icon="star"
-          />
-        </div>
+      {layoutOption === "number" && (
+        <>
+          {size === 'xs' && (
+              <Caption
+                text={rating.toString()}
+                size="xs"
+                paddingRight="xs"
+                dark={dark}
+                className="pb_star_rating_number_sm"
+              />
+            )}
+            {size === 'sm' && (
+              <Caption
+                text={rating.toString()}
+                size="xs"
+                paddingRight="xs"
+                dark={dark}
+                className="pb_star_rating_number_sm"
+              />
+            )}
+            {size === 'md' && (
+              <Body
+                text={rating.toString()}
+                paddingRight="xs"
+                dark={dark}
+                className="pb_star_rating_number_md"
+              />
+            )}
+            {size === 'lg' && (
+              <Title
+                text={rating.toString()}
+                size={2}
+                paddingRight="sm"
+                dark={dark}
+                className="pb_star_rating_number_lg"
+              />
+            )}
+        </>
+      )}
+      <Flex className="star_flex_area">
+        {[...Array(activeStars)].map((_, index) => (
+          <React.Fragment key={index}>
+            {colorOption === 'yellow' && (
+              <Icon
+                // @ts-ignore
+                customIcon={starYellow}
+                className={iconSize}
+              />
+            ) }
+            {colorOption === 'primary' && (
+              <Icon
+                // @ts-ignore
+                customIcon={starPrimary}
+                className={iconSize}
+              />
+            ) }
+            {colorOption === 'subtle' && (
+              <Icon
+                // @ts-ignore
+                customIcon={starSubtle}
+                className={iconSize}
+              />
+            ) }
+          </React.Fragment>
+        ))}
+        {[...Array(emptyStars)].map((_, index) => (
+          <React.Fragment key={index}>
+            {backgroundType === 'outline' && (
+              <Icon
+                // @ts-ignore
+                customIcon={starOutline}
+                className={iconSize}
+              />
+            ) }
+            {backgroundType !== 'outline' && (
+              <Icon
+                // @ts-ignore
+                customIcon={starBackground}
+                className={iconSize}
+              />
+            ) }
+          </React.Fragment>
+        ))}
+      </Flex>
+      {layoutOption === "onestar" && (
+          <>
+            {size === 'xs' && (
+              <Caption
+                  text={`${rating.toString()} of ${denominator}`}
+                  size="sm"
+                  dark={dark}
+                  className="pb_star_rating_number_sm"
+              />
+            )}
+            {size === 'sm' && (
+              <Caption
+                  text={`${rating.toString()} of ${denominator}`}
+                  size="sm"
+                  dark={dark}
+                  className="pb_star_rating_number_sm"
+              />
+            )}
+            {size === 'md' && (
+              <Body
+                  text={`${rating.toString()} of ${denominator}`}
+                  dark={dark}
+                  className="pb_star_rating_number_md"
+              />
+            )}
+            {size === 'lg' && (
+              <Title
+                  text={`${rating.toString()} of ${denominator}`}
+                  size={2}
+                  dark={dark}
+                  className="pb_star_rating_number_lg"
+              />
+            )}
+          </>
+        )}
       </div>
-    </div>
-  )
-}
+    )
+  }
 
 export default StarRating

data/app/pb_kits/playbook/pb_star_rating/docs/_star_rating_background_options.html.erb

@@ -0,0 +1,2 @@
+<%= pb_rails("star_rating", props: { rating: 3, background_type: "fill", padding_bottom: "xs" }) %>
+<%= pb_rails("star_rating", props: { rating: 3, background_type: "outline", padding_bottom: "xs" }) %>

data/app/pb_kits/playbook/pb_star_rating/docs/_star_rating_background_options.jsx

@@ -0,0 +1,25 @@
+import React from 'react'
+
+import StarRating from '../_star_rating'
+
+const StarRatingBackgroundOptions = (props) => (
+  <>
+
+    <StarRating
+        paddingBottom="xs"
+        rating={3}
+        {...props}
+    />
+
+
+    <StarRating
+        backgroundType='outline'
+        paddingBottom="xs"
+        rating={3}
+        {...props}
+    />
+
+  </>
+)
+
+export default StarRatingBackgroundOptions

data/app/pb_kits/playbook/pb_star_rating/docs/_star_rating_color_options.html.erb

@@ -0,0 +1,3 @@
+<%= pb_rails("star_rating", props: { rating: 3, padding_bottom: "xs" }) %>
+<%= pb_rails("star_rating", props: { rating: 3, color_option: "primary", padding_bottom: "xs" }) %>
+<%= pb_rails("star_rating", props: { rating: 3, color_option: "subtle", padding_bottom: "xs" }) %>

data/app/pb_kits/playbook/pb_star_rating/docs/_star_rating_color_options.jsx

@@ -0,0 +1,31 @@
+import React from 'react'
+
+import StarRating from '../_star_rating'
+
+const StarRatingColorOptions = (props) => (
+  <>
+
+    <StarRating
+        paddingBottom="xs"
+        rating={3}
+        {...props}
+    />
+
+    <StarRating
+        colorOption='primary'
+        paddingBottom="xs"
+        rating={3}
+        {...props}
+    />
+
+    <StarRating
+        colorOption='subtle'
+        paddingBottom="xs"
+        rating={3}
+        {...props}
+    />
+
+  </>
+)
+
+export default StarRatingColorOptions

data/app/pb_kits/playbook/pb_star_rating/docs/_star_rating_default.html.erb

@@ -1,13 +1,11 @@
-<%= pb_rails("star_rating") %>
+<%= pb_rails("star_rating", props: { padding_bottom: "xs" }) %>
 
-<br>
+<%= pb_rails("star_rating", props: { rating: 1, padding_bottom: "xs" }) %>
 
-<%= pb_rails("star_rating", props: { rating: 3 }) %>
+<%= pb_rails("star_rating", props: { rating: 2, padding_bottom: "xs" }) %>
 
-<br>
+<%= pb_rails("star_rating", props: { rating: 3, padding_bottom: "xs" }) %>
 
-<%= pb_rails("star_rating", props: { rating: 1.5 }) %>
+<%= pb_rails("star_rating", props: { rating: 4, padding_bottom: "xs" }) %>
 
-<br>
-
-<%= pb_rails("star_rating", props: { rating: 5 }) %>
+<%= pb_rails("star_rating", props: { rating: 5, padding_bottom: "xs" }) %>

data/app/pb_kits/playbook/pb_star_rating/docs/_star_rating_default.jsx

@@ -4,25 +4,38 @@ import StarRating from '../_star_rating'
 
 const StarRatingDefault = (props) => (
   <>
-    <StarRating />
+    <StarRating
+        paddingBottom="xs"
+        {...props}
+    />
 
-    <br />
 
     <StarRating
-        rating={3}
+        paddingBottom="xs"
+        rating={0.9}
         {...props}
     />
 
-    <br />
-
     <StarRating
+        paddingBottom="xs"
         rating={1.5}
         {...props}
     />
 
-    <br />
+    <StarRating
+        paddingBottom="xs"
+        rating={3}
+        {...props}
+    />
+
+    <StarRating
+        paddingBottom="xs"
+        rating={4.2}
+        {...props}
+    />
 
     <StarRating
+        paddingBottom="xs"
         rating={5}
         {...props}
     />

data/app/pb_kits/playbook/pb_star_rating/docs/_star_rating_hide.html.erb

@@ -1 +1,3 @@
-<%= pb_rails("star_rating", props: { rating: 3.5, hide_rating: true }) %>
+<%= pb_rails("star_rating", props: { rating: 3, padding_bottom: "xs" }) %>
+<%= pb_rails("star_rating", props: { rating: 3, layout_option: "number", padding_bottom: "xs" }) %>
+<%= pb_rails("star_rating", props: { rating: 3, layout_option: "onestar", padding_bottom: "xs" }) %>

data/app/pb_kits/playbook/pb_star_rating/docs/_star_rating_hide.jsx

@@ -3,13 +3,30 @@ import React from 'react'
 import StarRating from '../_star_rating'
 
 const StarRatingHide = (props) => (
+  <>
 
-  <StarRating
-      hideRating
-      rating={3.5}
-      {...props}
-  />
+    <StarRating
+        paddingBottom="xs"
+        rating={3}
+        {...props}
+    />
 
+
+    <StarRating
+        layoutOption={"number"}
+        paddingBottom="xs"
+        rating={3}
+        {...props}
+    />
+
+    <StarRating
+        layoutOption={"onestar"}
+        paddingBottom="xs"
+        rating={3}
+        {...props}
+    />
+
+  </>
 )
 
 export default StarRatingHide

data/app/pb_kits/playbook/pb_star_rating/docs/_star_rating_number_config.html.erb

@@ -0,0 +1,6 @@
+<%= pb_rails("star_rating", props: { rating: 3, denominator: 3, padding_bottom: "xs" }) %>
+<%= pb_rails("star_rating", props: { rating: 3, denominator: 4, padding_bottom: "xs" }) %>
+<%= pb_rails("star_rating", props: { rating: 3, padding_bottom: "xs" }) %>
+<%= pb_rails("star_rating", props: { rating: 3, denominator: 6, padding_bottom: "xs" }) %>
+<%= pb_rails("star_rating", props: { rating: 3, denominator: 7, padding_bottom: "xs" }) %>
+<%= pb_rails("star_rating", props: { rating: 3, denominator: 8, padding_bottom: "xs" }) %>

data/app/pb_kits/playbook/pb_star_rating/docs/_star_rating_number_config.jsx

@@ -0,0 +1,58 @@
+import React from 'react'
+
+import StarRating from '../_star_rating'
+
+const StarRatingNumberConfig = (props) => (
+  <>
+
+    <StarRating
+        denominator={3}
+        paddingBottom="xs"
+        rating={3}
+        {...props}
+    />
+
+
+    <StarRating
+        denominator={4}
+        paddingBottom="xs"
+        rating={3}
+        {...props}
+    />
+
+
+    <StarRating
+        denominator={5}
+        paddingBottom="xs"
+        rating={3}
+        {...props}
+    />
+
+
+    <StarRating
+        denominator={6}
+        paddingBottom="xs"
+        rating={3}
+        {...props}
+    />
+
+
+    <StarRating
+        denominator={7}
+        paddingBottom="xs"
+        rating={3}
+        {...props}
+    />
+
+
+    <StarRating
+        denominator={8}
+        paddingBottom="xs"
+        rating={3}
+        {...props}
+    />
+
+  </>
+)
+
+export default StarRatingNumberConfig

data/app/pb_kits/playbook/pb_star_rating/docs/_star_rating_size_options.html.erb

@@ -0,0 +1,16 @@
+<%= pb_rails("star_rating", props: { rating: 3, size: "xs", padding_bottom: "xs" }) %>
+
+
+<%= pb_rails("star_rating", props: { rating: 3, size: "sm", padding_bottom: "xs" }) %>
+
+
+<%= pb_rails("star_rating", props: { rating: 3, size: "md", padding_bottom: "xs" }) %>
+
+
+<%= pb_rails("star_rating", props: { rating: 3, size: "lg", padding_bottom: "xs" }) %>
+
+
+<%= pb_rails("star_rating", props: { rating: 3, size: "lg", layout_option: "number", padding_bottom: "xs" }) %>
+
+
+<%= pb_rails("star_rating", props: { rating: 3, size: "lg", layout_option: "onestar", padding_bottom: "xs" }) %>

data/app/pb_kits/playbook/pb_star_rating/docs/_star_rating_size_options.jsx

@@ -0,0 +1,60 @@
+import React from 'react'
+
+import StarRating from '../_star_rating'
+
+const StarRatingSizeOptions = (props) => (
+  <>
+
+    <StarRating
+        paddingBottom="xs"
+        rating={3}
+        size="xs"
+        {...props}
+    />
+
+
+    <StarRating
+        paddingBottom="xs"
+        rating={3}
+        size="sm"
+        {...props}
+    />
+
+
+    <StarRating
+        paddingBottom="xs"
+        rating={3}
+        size="md"
+        {...props}
+    />
+
+
+    <StarRating
+        paddingBottom="xs"
+        rating={3}
+        size="lg"
+        {...props}
+    />
+
+
+    <StarRating
+        layoutOption="number"
+        paddingBottom="xs"
+        rating={3}
+        size="lg"
+        {...props}
+    />
+
+
+    <StarRating
+        layoutOption="onestar"
+        paddingBottom="xs"
+        rating={3}
+        size="lg"
+        {...props}
+    />
+
+  </>
+)
+
+export default StarRatingSizeOptions

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

@@ -1,9 +1,16 @@
 examples:
-
   rails:
-  - star_rating_default: Default
-  - star_rating_hide: Hide Rating Value
+    - star_rating_default: Default
+    - star_rating_color_options: Color Options
+    - star_rating_background_options: Background Options
+    - star_rating_hide: Layout Options
+    - star_rating_number_config: Number Config
+    - star_rating_size_options: Size Options
 
   react:
-  - star_rating_default: Default
-  - star_rating_hide: Hide Rating Value
+    - star_rating_default: Default
+    - star_rating_color_options: Color Options
+    - star_rating_background_options: Background Options
+    - star_rating_hide: Layout Options
+    - star_rating_number_config: Number Config
+    - star_rating_size_options: Size Options

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

@@ -1,3 +1,11 @@
 export { default as StarRatingDefault } from './_star_rating_default.jsx'
 
+export { default as StarRatingColorOptions } from './_star_rating_color_options.jsx'
+
+export { default as StarRatingBackgroundOptions } from './_star_rating_background_options.jsx'
+
 export { default as StarRatingHide } from './_star_rating_hide.jsx'
+
+export { default as StarRatingNumberConfig } from './_star_rating_number_config.jsx'
+
+export { default as StarRatingSizeOptions } from './_star_rating_size_options.jsx'