playbook_ui 13.12.0.pre.alpha.PLAY1093typeaheadkitdocbug1577 → 13.12.0.pre.alpha.play900startratingasinput1543

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

@@ -1,3 +1,9 @@
 export { default as StarRatingDefault } from './_star_rating_default.jsx'
 
+export { default as StarRatingColorOptions } from './_star_rating_color_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'

data/app/pb_kits/playbook/pb_star_rating/star.svg

@@ -0,0 +1,3 @@
+<svg width="50" height="48" viewBox="0 0 50 48" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path fill-rule="evenodd" clip-rule="evenodd" d="M26.7271 1.3113C26.3525 0.561986 25.6032 0 24.6665 0C23.8235 0 23.0742 0.561986 22.6996 1.3113L16.2367 14.518L1.90607 16.6723C1.06309 16.7659 0.40744 17.4216 0.126447 18.1709C-0.154546 19.0139 0.0327825 19.8568 0.688433 20.5125L11.0852 30.8156L8.55624 45.3335C8.46257 46.1765 8.83723 47.1132 9.49288 47.5815C10.2422 48.0498 11.0852 48.1435 11.8345 47.7688L24.6665 40.8377L37.4985 47.7688C38.2478 48.1435 39.1845 48.0498 39.9338 47.5815C40.5895 47.1132 40.9641 46.1765 40.7768 45.3335L38.3415 30.8156L48.7382 20.5125C49.3939 19.8568 49.5812 19.0139 49.3002 18.1709C49.0192 17.4216 48.3636 16.7659 47.5206 16.6723L33.19 14.518L26.7271 1.3113Z" fill="#0056CF"/>
+</svg>

data/app/pb_kits/playbook/pb_star_rating/star_rating.html.erb

@@ -3,29 +3,70 @@
     data: object.data,
     class: object.classname) do %>
     <%# Rating value %>
-    <% if !object.hide_rating %>
-      <%= content_tag(:div, object.rating, class: "pb_star_rating_number") %>
+    <% if layout_option == "number" %>
+      <%= content_tag(:div, class: "number_rails_#{size}") do %>
+        <% case object.size %>
+          <% when "xs", "sm" %>
+          <%= pb_rails("caption", props: { text: object.rating,
+                                           size: "sm",
+                                           dark: dark,
+                                           padding_right: "xxs" }) %>
+          <% when "md" %>
+          <%= pb_rails("body", props: { text: object.rating,
+                                        dark: dark,
+                                        padding_right: "xxs" }) %>
+          <% when "lg" %>
+          <%= pb_rails("title", props: { text: object.rating,
+                                         size: 2,
+                                         dark: dark,
+                                         padding_right: "sm" }) %>
+        <% end %>
+      <% end %>
     <% end %>
-
     <%= content_tag(:div, class: "pb_star_rating_wrapper") do %>
       <%# Gold stars generated by rating value %>
       <%= content_tag(:div, class: "pb_star_rating_highlight") do %>
         <% object.star_count.times do %>
-          <%= pb_rails("icon", props: { icon: "star" }) %>
+          <svg width="<%= svg_size %>" class="<%= %>" height="<%= svg_size %>" viewBox="0 0 18 16" fill="none" xmlns="http://www.w3.org/2000/svg">
+          <% case object.color_option %>
+            <% when "yellow"%>
+              <path fill-rule="evenodd" clip-rule="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"/>
+            <% when "primary", "outline" %>
+              <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"/>
+            <% when "subtle"%>
+              <path class="<%= subtle_star_color %>" fill-rule="evenodd" clip-rule="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" />
+          <% end %>
+          </svg>
         <% end %>
-        <% unless object.star_full %>
-          <%= pb_rails("icon", props: { icon: "star-half" }) %>
+        <% object.empty_stars.times do %>
+          <svg width="<%= svg_size %>" height="<%= svg_size %>" viewBox="0 0 17 16" fill="none" xmlns="http://www.w3.org/2000/svg">
+            <% if object.color_option == "outline" %>
+              <path class="<%= outline_star_color %>" 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" />
+            <% else %>
+              <path  class="<%= empty_star_color %>" fill-rule="evenodd" clip-rule="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" />
+            <% end %>
+          </svg>
         <% end %>
       <% end %>
-
-      <%# Grey background stars as base %>
-      <%= content_tag(:div, class: "pb_star_rating_base") do %>
-        <%= pb_rails("icon", props: { icon: "star" }) %>
-        <%= pb_rails("icon", props: { icon: "star" }) %>
-        <%= pb_rails("icon", props: { icon: "star" }) %>
-        <%= pb_rails("icon", props: { icon: "star" }) %>
-        <%= pb_rails("icon", props: { icon: "star" }) %>
+    <% end %>
+    <% if layout_option == "onestar" %>
+      <%= content_tag(:div, class: "number_rails_#{size}") do %>
+        <% case object.size %>
+          <% when "xs", "sm" %>
+          <%= pb_rails("caption", props: { text: "#{object.rating} of #{object.denominator}",
+                                           size: "xs",
+                                           dark: dark,
+                                           padding_left: "xxs" }) %>
+          <% when "md" %>
+          <%= pb_rails("body", props: { text: "#{object.rating} of #{object.denominator}",
+                                        dark: dark,
+                                        padding_left: "xxs" }) %>
+          <% when "lg" %>
+          <%= pb_rails("title", props: { text: "#{object.rating} of #{object.denominator}",
+                                         size: 2,
+                                         dark: dark,
+                                         padding_left: "sm" }) %>
+        <% end %>
       <% end %>
-
     <% end %>
 <% end %>

data/app/pb_kits/playbook/pb_star_rating/star_rating.rb

@@ -3,18 +3,61 @@
 module Playbook
   module PbStarRating
     class StarRating < Playbook::KitBase
-      prop :hide_rating, type: Playbook::Props::Boolean,
-                         default: false
-
       prop :rating, type: Playbook::Props::Numeric,
                     default: 0
 
+      prop :denominator, type: Playbook::Props::Numeric,
+                         default: 5
+
+      prop :layout_option, type: Playbook::Props::Enum,
+                           values: %w[default onestar number],
+                           default: "default"
+
+      prop :color_option, type: Playbook::Props::Enum,
+                          values: %w[yellow primary subtle outline],
+                          default: "yellow"
+
+      prop :size, type: Playbook::Props::Enum,
+                  values: %w[xs sm md lg],
+                  default: "sm"
+
       def star_count
-        rating.floor
+        rating.floor > denominator_style ? denominator_style : rating.floor
+      end
+
+      def denominator_style
+        layout_option == "onestar" ? 1 : denominator
+      end
+
+      def empty_stars
+        (denominator_style - rating.floor).negative? ? 0 : denominator_style - rating.floor
+      end
+
+      def empty_star_color
+        dark ? "empty_star_dark" : "empty_star_light"
+      end
+
+      def outline_star_color
+        dark ? "outline_star_dark" : "outline_star_light"
+      end
+
+      def subtle_star_color
+        dark ? "suble_star_dark" : "suble_star_light"
       end
 
-      def star_full
-        (rating.to_f % 1).zero?
+      def svg_size
+        case size
+        when "sx"
+          14
+        when "sm"
+          16
+        when "md"
+          24
+        when "lg"
+          48
+        else
+          16
+        end
       end
 
       def classname

data/app/pb_kits/playbook/pb_star_rating/star_rating.test.js

@@ -1,24 +1,22 @@
-import React from "react";
-import { render, screen } from "../utilities/test-utils";
+import React from "react"
+import { render, screen } from "../utilities/test-utils"
 
-import StarRating from "./_star_rating";
+import StarRating from "./_star_rating"
 
-const testId = "star-rating-kit";
+const testId = "star-rating-kit"
 
 describe("Star Rating Kit", () => {
   test("Expects to have correct classname", () => {
     render(
       <StarRating
           data={{ testid: testId }}
-          rating={2}
       />
-    );
-
+    )
 
-    const kit = screen.getByTestId(testId);
-    expect(kit).toHaveClass("pb_star_rating_kit");
+    const kit = screen.getByTestId(testId)
+    expect(kit.className).toBe("pb_star_rating_kit")
 
-  });
+  })
 
   test('should render aria-label', () => {
     render(
@@ -27,45 +25,46 @@ describe("Star Rating Kit", () => {
           data={{ testid: testId }}
           rating={2}
       />
-    );
+    )
 
     const kit = screen.getByTestId(testId)
     expect(kit).toHaveAttribute('aria-label', testId)
-  });
+  })
 
-  test("Displays two highlighted stars", () => {
+  test("Displays correct denominator", () => {
     render(
       <StarRating
           data={{ testid: testId }}
+          denominator={4}
           rating={2}
       />
-    );
-
+    )
 
-    const kit = screen.getByTestId(testId);
-    const highlight = kit.querySelector(".pb_star_rating_highlight");
-    const stars = highlight.querySelectorAll(".far.fa-star");
-    const count = stars.length;
+    const kit = screen.getByTestId(testId)
+    const highlight = kit.querySelector(".pb_star_rating_wrapper")
+    const stars = highlight.querySelectorAll(".pb_star_sm")
+    const count = stars.length
 
-    expect(count).toBe(2);
-  });
+    expect(count).toBe(4)
+  })
 
-  test("Displays three highlighted stars and a half star", () => {
+  test("Uses correct size", () => {
     render(
       <StarRating
           data={{ testid: testId }}
-          rating={3.5}
+          layoutOption="number"
+          rating={2}
+          size="lg"
       />
-    );
+    )
 
-    const kit = screen.getByTestId(testId);
-    const highlight = kit.querySelector(".pb_star_rating_highlight");
-    const stars = highlight.querySelectorAll(".far.fa-star");
-    const halfStars = highlight.querySelectorAll(".far.fa-star-half");
-    const starCount = stars.length;
-    const halfStarCount = halfStars.length;
+    const kit = screen.getByTestId(testId)
+    const highlight = kit.querySelector(".pb_star_rating_wrapper")
+    const title = kit.querySelector(".pb_star_rating_number_lg")
+    const stars = highlight.querySelectorAll(".pb_star_lg")
+    const count = stars.length
 
-    expect(starCount).toBe(3);
-    expect(halfStarCount).toBe(1);
-  });
-});
+    expect(title.className).toBe("pb_star_rating_number_lg")
+    expect(count).toBe(5)
+  })
+})

data/app/pb_kits/playbook/pb_typeahead/docs/_typeahead_with_highlight.jsx

@@ -70,8 +70,8 @@ const TypeaheadWithHighlight = (props) => {
   }
 
   const customComponents = {
-    Option: (highlightProps: OptionProps) => (
-      <components.Option {...highlightProps}/>
+    Option: (props: OptionProps) => (
+      <components.Option {...props}/>
     ),
     SingleValue: ({ data }: any) => (
       <span>{data.name}</span>