playbook_ui 12.25.0.pre.alpha.play822bolddefaultfortitle3764 → 12.25.0.pre.alpha.play824786

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f92b0ba0b6815c0e58e6245b7ab5c168f842a740774aae7f42157b772d47b65
-  data.tar.gz: 8b6d4937bdf2cd755f0787c25ab8743ea363381f05fcca13627b5363e1f484f0
+  metadata.gz: 0d16e0bc40834178270464f25bde81545d40620d3c632b7adda792ae7f7e6bed
+  data.tar.gz: 10ac729f13f811e0f16f4e83dfddcfd897ff2bbb234fdd012d3737f70a1c2c0a
 SHA512:
-  metadata.gz: 7ef87aa97ccafa5bd9291457af632c5710747f680e300b8ad56060a0b9b65c1ac22738079663831be6a2e9bd3a705a8f201be0b0a2826e28261d88541a70f80b
-  data.tar.gz: cbc07ce3495e7df2bccb5c40adc653b824de1506e0a64895ff632897529b4250232317278026ef9d9071071ff1ed4c8245ce514fdf6569162e8720d942c84da8
+  metadata.gz: 9b8880be33d9fbe2f373640058faa2392f405c0404b9f83d54831f709ecd06ae500834cbc66c0d36e4ae840724825ad56c03eece94df03eea9d1601bd24da115
+  data.tar.gz: 8a1c0f8500386822a9f30217ea506eb463000d2d83db924ba3e90f1e3b3b0dff88ebd2f24b30e945e3b5e65d1e2f31900cf18fb6d347a47afec1d2ea7423950d

data/app/pb_kits/playbook/_playbook.scss

@@ -5,6 +5,7 @@
 @import 'pb_button_toolbar/button_toolbar';
 @import 'pb_caption/caption';
 @import 'pb_card/card';
+@import 'pb_detail/detail';
 @import 'pb_title/title';
 @import 'pb_avatar/avatar';
 @import 'pb_avatar_action_button/avatar_action_button';

data/app/pb_kits/playbook/index.js

@@ -31,6 +31,7 @@ export { default as DateStacked } from './pb_date_stacked/_date_stacked'
 export { default as DateTime } from './pb_date_time/_date_time'
 export { default as DateTimeStacked } from './pb_date_time_stacked/_date_time_stacked'
 export { default as DateYearStacked } from './pb_date_year_stacked/_date_year_stacked'
+export { default as Detail} from './pb_detail/_detail'
 export { default as Dialog } from './pb_dialog/_dialog'
 export { default as DistributionBar } from './pb_distribution_bar/_distribution_bar'
 export { default as FileUpload } from './pb_file_upload/_file_upload'

data/app/pb_kits/playbook/pb_avatar/docs/_avatar_swift.md

@@ -1 +1,82 @@
-![image for avatar](https://images.unsplash.com/photo-1684237276530-a562fa8338b1?ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D&auto=format&fit=crop&w=580&q=80)
+In the world of design, consistency is key. Whether you're designing a website, app, or product, having a consistent visual language can make all the difference. That's where design systems come in.
+
+A design system is a collection of reusable components, guidelines, and assets that help ensure consistency across all of your design work. It's a way to standardize your design language, making it easier for your team to work together and for your users to navigate your products.
+
+In this article, we'll explore the various elements of a design system and how they can be used to create a cohesive and effective design language.
+
+### Headings
+Headings are an essential component of any design system. They help organize content, provide visual hierarchy, and make it easier for users to scan and find what they're looking for. A good design system will have headings of various sizes, ranging from H1 (the largest) to H6 (the smallest). Here's an example:
+
+# H1: Main Title Headings
+## H2: Headings
+### H3: Subheadings
+#### H4: Sub-Subheadings
+
+![image for avatar](https://images.unsplash.com/photo-1684237276530-a562fa8338b1?ixlib=rb-4.0.3&ixid=M3wxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8fA%3D%3D&auto=format&fit=crop&w=580&q=80)
+
+### Lists
+Lists are another important component of a design system. They help organize content into easily digestible chunks, making it easier for users to read and understand. There are two types of lists: ordered and unordered.
+
+Ordered lists are numbered, and each item is listed in a specific order. For example:
+
+1. Headings
+2. Lists
+3. Blockquotes
+4. Links
+5. Bold
+6. Underline
+7. Code Blocks
+8. Inline Code
+9. Example Tables
+10. Horizontal Rules
+
+Unordered lists, on the other hand, use bullet points to separate each item. For example:
+
+* Headings
+* Lists
+* Blockquotes
+* Links
+* Bold
+* Underline
+* Code Blocks
+* Inline Code
+* Example Tables
+* Horizontal Rules
+
+### Blockquotes
+Blockquotes are used to highlight a particular section of text or quote. They’re often used to emphasize an important point or to provide context. Here’s an example:
+
+> “Design systems are a collection of reusable components, guidelines, and assets that help ensure consistency across all of your design work.” - ChatGPT
+
+
+### Links
+Links are an important part of any design system. They allow users to navigate between different pages and sections of your product. When using links in your design system, it’s important to make sure they’re consistent in color, size, and style. Here’s an example:
+Click here to learn more about design systems.
+
+### Bold, Underline, & Italics
+**Bold** and _underline_ are used to *highlight specific words* or phrases within ~~a block of~~ text. They help draw the user’s attention to important information. Here’s an example: *Design systems are* a collection of **reusable components**, **guidelines**, and **assets** that help ensure _consistency across all of your design work_.
+
+### Code Blocks and Inline Code
+Code blocks and `inline code` are used to display and highlight code within a block of text. This is especially useful for developers who need to reference code snippets in their work. 
+
+Here’s an example:
+
+```js
+function greet() {
+	console.log(“Hello, world!”);
+}
+```
+
+### Example Tables
+Example tables are used to display data in a clear and organized way. They help users compare and analyze information quickly. Here’s an example:
+
+| Tables   |      Are      |  Cool |
+|----------|:-------------:|------:|
+| col 1 is |  left-aligned | $1600 |
+| col 2 is |    centered   |   $12 |
+| col 3 is | right-aligned |    $1 |
+
+---
+
+### Horizontal Rules
+Horizontal rules are used to separate sections of content visually. They help break up long blocks of text and make it easier for users

data/app/pb_kits/playbook/pb_detail/_detail.scss

@@ -0,0 +1,44 @@
+@import "./detail_mixins";
+@import "../tokens/titles";
+@import "../tokens/typography";
+
+[class^=pb_detail_kit]{
+  @include pb_detail;
+
+  @each $color_name, $color_value in $pb_detail_colors {
+    &[class*=_#{$color_name}] {
+      @include pb_detail($color_value);
+    }
+  }
+
+  @each $dark_color_name, $dark_color_value in $pb_dark_detail_colors{
+    &[class*=_#{$dark_color_name}][class*=dark]{
+      @include pb_detail($dark_color_value)
+    }
+  }
+
+  // Styles
+  &.bold,
+  &.bold.dark,
+  b,
+  strong {
+    font-weight: $bold;
+  }
+
+  a {
+    color: $primary;
+    &:hover {
+      cursor: pointer;
+      color: $text_lt_default;
+    }
+  }
+
+  em {
+    font-weight: $bold;
+  }
+
+  small {
+    font-size: $font_smaller;
+    letter-spacing: $lspace_loose;
+  }
+}

data/app/pb_kits/playbook/pb_detail/_detail.tsx

@@ -0,0 +1,55 @@
+import React from 'react'
+import classnames from 'classnames'
+import { buildAriaProps, buildCss, buildDataProps } from '../utilities/props'
+import { globalProps, GlobalProps } from '../utilities/globalProps'
+
+type DetailProps = {
+  aria?: { [key: string]: string },
+  bold?: boolean,
+  children?: React.ReactChild[] | React.ReactChild,
+  className?: string,
+  color?: 'light' | 'default' | 'lighter' | 'link' | 'error' | 'success',
+  dark?: boolean,
+  data?: { [key: string]: string },
+  id?: string,
+  tag?: 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'p' | 'span' | 'div',
+  text?: string,
+} & GlobalProps
+
+const Detail = (props: DetailProps) => {
+  const {
+    aria = {},
+    bold = false,
+    children,
+    className,
+    color = 'light',
+    data = {},
+    id = '',
+    tag = 'div',
+    text= ''
+  } = props
+
+  const ariaProps: {[key: string]: any} = buildAriaProps(aria)
+  const dataProps: {[key: string]: any} = buildDataProps(data)
+  const isBold = bold ? "bold" : null
+  const classes = classnames(
+    buildCss('pb_detail_kit', color),
+    isBold,
+    globalProps(props),
+    className
+  )
+  const Tag: React.ReactElement | any = `${tag}`
+
+  return (
+    <Tag
+        {...ariaProps}
+        {...dataProps}
+        className={classes}
+        id={id}
+    >
+      {text || children}
+    </Tag>
+  )
+}
+
+export default Detail

data/app/pb_kits/playbook/pb_detail/_detail_mixins.scss

@@ -0,0 +1,29 @@
+@import "../tokens/colors";
+@import "../tokens/line_height";
+@import "../tokens/typography";
+
+$pb_detail_colors: (
+  light:          $text_lt_light,
+  default:        $text_lt_default,
+  lighter:        $text_lt_lighter,
+  link:           $primary,
+  error:          $error,
+  success:        $text_lt_success_sm,
+);
+
+$pb_dark_detail_colors: (
+  light:          $text_dk_light,
+  default:        $text_dk_default,
+  lighter:        $text_dk_lighter,
+  link:           $primary,
+  error:          $error_dark,
+  success:        $text_dk_success_sm,
+);
+
+@mixin pb_detail($color: $text_lt_light) {
+  line-height: $lh_tight;
+  color: $color;
+  font-size: $text_small;
+  font-weight: $regular;
+  font-family: $font-family-base;
+}

data/app/pb_kits/playbook/pb_detail/detail.html.erb

@@ -0,0 +1,7 @@
+<%= content_tag(object.tag,
+    aria: object.aria,
+    class: object.classname,
+    data: object.data,
+    id: object.id) do %>
+  <%= object.content %>
+<% end %>

data/app/pb_kits/playbook/pb_detail/detail.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Playbook
+  module PbDetail
+    class Detail < Playbook::KitBase
+      prop :bold, type: Playbook::Props::Boolean,
+                  default: false
+      prop :color, type: Playbook::Props::Enum,
+                   values: %w[light default lighter link error success],
+                   default: "light"
+      prop :tag, type: Playbook::Props::Enum,
+                 values: %w[h1 h2 h3 h4 h5 h6 p span div],
+                 default: "div"
+      prop :text
+
+      def classname
+        generate_classname("pb_detail_kit", color) + is_bold
+      end
+
+      def content
+        super.presence || text
+      end
+
+    private
+
+      def is_bold
+        bold ? " bold" : ""
+      end
+    end
+  end
+end

data/app/pb_kits/playbook/pb_detail/detail.test.jsx

@@ -0,0 +1,46 @@
+import React from 'react'
+import { render, screen } from '../utilities/test-utils'
+
+import Detail from './_detail'
+
+test('returns namespaced class name', () => {
+  render(
+    <Detail
+        data={{ testid: 'primary-test' }}
+        text="Test class name"
+    />
+  )
+
+  const kit = screen.getByTestId('primary-test')
+  expect(kit).toHaveClass('pb_detail_kit_light')
+})
+
+test('with colors', () => {
+  ['light', 'default', 'lighter', 'link', 'success', 'error'].forEach((color) => {
+    const testId = `colors-test-${color}`
+
+    render(
+      <Detail
+          color={color}
+          data={{ testid: testId }}
+          text="Test colors"
+      />
+    )
+
+    const kit = screen.getByTestId(testId)
+    expect(kit).toHaveClass(`pb_detail_kit_${color}`)
+  })
+})
+
+test('bold font-weight should be 600', () => {
+  render(
+    <Detail
+        bold
+        data={{ testid: 'primary-test' }}
+        text="Test bold prop"
+    />
+  )
+
+  const kit = screen.getByTestId('primary-test')
+  expect(kit).toHaveClass("bold")
+})

data/app/pb_kits/playbook/pb_detail/docs/_description.md

@@ -0,0 +1 @@
+Used for tables or designs with large amounts of data or text.

data/app/pb_kits/playbook/pb_detail/docs/_detail_bold.html.erb

@@ -0,0 +1,34 @@
+<%= pb_rails("detail", props: {
+  bold: true,
+  text: "I am a bold detail kit"
+}) %>
+
+<%= pb_rails("detail", props: {
+  bold: true,
+  color: "default",
+  text: "I am a bold detail kit"
+}) %>
+
+<%= pb_rails("detail", props: {
+  bold: true,
+  color: "lighter",
+  text: "I am a bold detail kit"
+}) %>
+
+<%= pb_rails("detail", props: {
+  bold: true,
+  color: "link",
+  text: "I am a bold detail kit"
+}) %>
+
+<%= pb_rails("detail", props: {
+  bold: true,
+  color: "error",
+  text: "I am a bold detail kit"
+}) %>
+
+<%= pb_rails("detail", props: {
+  bold: true,
+  color: "success",
+  text: "I am a bold detail kit"
+}) %>

data/app/pb_kits/playbook/pb_detail/docs/_detail_bold.jsx

@@ -0,0 +1,49 @@
+import React from 'react'
+import { Detail } from '../..'
+
+const DetailBold = (props) => (
+  <div>
+    <Detail
+        bold
+        text="I am a bold detail kit"
+        {...props}
+    />
+
+    <Detail
+        bold
+        color="default"
+        text="I am a bold detail kit"
+        {...props}
+    />
+
+    <Detail
+        bold
+        color="lighter"
+        text="I am a bold detail kit"
+        {...props}
+    />
+
+    <Detail
+        bold
+        color="link"
+        text="I am a bold detail kit"
+        {...props}
+    />
+
+    <Detail
+        bold
+        color="error"
+        text="I am a bold detail kit"
+        {...props}
+    />
+
+    <Detail
+        bold
+        color="success"
+        text="I am a bold detail kit"
+        {...props}
+    />
+  </div>
+)
+
+export default DetailBold

data/app/pb_kits/playbook/pb_detail/docs/_detail_bold.md

@@ -0,0 +1 @@
+Use the `bold` prop to strongly emphasis your text.

data/app/pb_kits/playbook/pb_detail/docs/_detail_colors.html.erb

@@ -0,0 +1,24 @@
+<%= pb_rails("detail", props: {
+  text: "I am a detail kit",
+  color: "default"
+}) %>
+
+<%= pb_rails("detail", props: {
+  text: "I am a detail kit",
+  color: "lighter"
+}) %>
+
+<%= pb_rails("detail", props: {
+  text: "I am a detail kit",
+  color: "link"
+}) %>
+
+<%= pb_rails("detail", props: {
+  text: "I am a detail kit",
+  color: "error"
+}) %>
+
+<%= pb_rails("detail", props: {
+  text: "I am a detail kit",
+  color: "success"
+}) %>

data/app/pb_kits/playbook/pb_detail/docs/_detail_colors.jsx

@@ -0,0 +1,38 @@
+import React from 'react'
+import { Detail } from '../..'
+
+const DetailColors = (props) => (
+  <div>
+    <Detail
+        color="default"
+        text="I am a detail kit"
+        {...props}
+    />
+
+    <Detail
+        color="lighter"
+        text="I am a detail kit"
+        {...props}
+    />
+
+    <Detail
+        color="link"
+        text="I am a detail kit"
+        {...props}
+    />
+
+    <Detail
+        color="error"
+        text="I am a detail kit"
+        {...props}
+    />
+
+    <Detail
+        color="success"
+        text="I am a detail kit"
+        {...props}
+    />
+  </div>
+)
+
+export default DetailColors

data/app/pb_kits/playbook/pb_detail/docs/_detail_colors.md

@@ -0,0 +1,6 @@
+##### Prop
+This kit uses the `light` color by default, and can be replaced with colors below:
+
+`default` `lighter` `link` `error` `success`
+
+These colors are not for standard usage. You can use the `color` prop to make fixes if colors are not appearing properly, but consult your UX team members if you are deciding to implement it.

data/app/pb_kits/playbook/pb_detail/docs/_detail_default.html.erb

@@ -0,0 +1,3 @@
+<%= pb_rails("detail", props: {
+  text: "I am a detail kit"
+}) %>

data/app/pb_kits/playbook/pb_detail/docs/_detail_default.jsx

@@ -0,0 +1,13 @@
+import React from 'react'
+import { Detail } from '../..'
+
+const DetailDefault = (props) => (
+  <div>
+    <Detail
+        text="I am a detail kit"
+        {...props}
+    />
+  </div>
+)
+
+export default DetailDefault

data/app/pb_kits/playbook/pb_detail/docs/_detail_styled.html.erb

@@ -0,0 +1,22 @@
+<%= pb_rails("detail") do %>
+    <b>This text is using the <%="<b>"%> tag.</b>
+    <br />
+    <br />
+    <strong>This text is using the <%="<strong>"%> tag.</strong>
+    <br />
+    <br />
+    <a>This text is using the <%="<a>"%> tag.</a>
+    <br />
+    <br />
+    <i>This text is using the <%="<i>"%> tag.</i>
+    <br />
+    <br />
+    This <em>word</em> is using an <%="<em>"%> tag.
+    <br />
+    <br />
+    <small>This text is using the <%="<small>"%> tag.</small>
+    <br />
+    <br />
+    <u>This text is using the <%="<u>"%> tag.</u>
+    <br />
+<% end %>

data/app/pb_kits/playbook/pb_detail/docs/_detail_styled.jsx

@@ -0,0 +1,32 @@
+import React from 'react'
+import { Detail } from '../..'
+
+const DetailStyled = (props) => (
+  <>
+    <Detail {...props}>
+      <b>{"This text is using the <b> tag."}</b>
+      <br />
+      <br />
+      <strong>{"This text is using the <strong> tag."}</strong>
+      <br />
+      <br />
+      <a>{"This text is using the <a> tag."}</a>
+      <br />
+      <br />
+      <i>{"This text is using the <i> tag."}</i>
+      <br />
+      <br />
+      {"This "}<em>{"word"}</em>{" is using an <em> tag."}
+      <br />
+      <br />
+      <small>{"This text is using the <small> tag."}</small>
+      <br />
+      <br />
+      <u>{"This text is using the <u> tag."}</u>
+      <br />
+      <br />
+    </Detail>
+  </>
+)
+
+export default DetailStyled

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

@@ -0,0 +1,11 @@
+examples:
+
+  rails:
+  - detail_default: Default
+  - detail_colors: Colors
+  - detail_bold: Bold
+
+  react:
+  - detail_default: Default
+  - detail_colors: Colors
+  - detail_bold: Bold

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

@@ -0,0 +1,4 @@
+export { default as DetailDefault } from './_detail_default.jsx'
+export { default as DetailColors } from './_detail_colors.jsx'
+export { default as DetailStyled } from './_detail_styled.jsx'
+export { default as DetailBold } from './_detail_bold.jsx'

data/app/pb_kits/playbook/pb_docs/kit_example.html.erb

@@ -1,20 +1,21 @@
 <% example_html = ERB.new(example).result %>
 
 <%= pb_rails("card", props: { classname: "pb--doc", padding: "none", dark: dark }) do %>
-  <div class="pb--kit-example">
-    <%= pb_rails("caption", props: { text: example_title, dark: dark }) %>
-    <br />
-    <%= example %>
-    <br>
-  </div>
-  
-  <% if (action_name == "kit_show_swift") %>
-    <div class="pb--kit-example-markdown pt_none <%= dark ? "dark" : "" %>">
+  <% unless (action_name == "kit_show_swift") %>
+    <div class="pb--kit-example">
+      <%= pb_rails("caption", props: { text: example_title, dark: dark }) %>
+      <br />
+      <%= example %>
+      <br>
+    </div>
+  <% else %>
+    <div class="pb--kit-example-markdown pt_none markdown <%= dark ? "dark" : "" %>">
+      <%= pb_rails("caption", props: { text: example_title, dark: dark, margin_top: "md" }) %>
       <%= render_markdown(description) %>
     </div>
   <% end %>
   <% if show_code %>
-    <div class="markdown pb--kit-example-markdown <%= dark ? "dark" : "" %>">
+    <div class="markdown pb--kit-example-markdown markdown <%= dark ? "dark" : "" %>">
       <%= render_markdown(description) %>
     </div>
     <div id="code-wrapper">
@@ -32,10 +33,10 @@
       </div>
       <div class="pb--codeCopy" data-action="toggle" data-togglable="code_example" style="display: none" >
         <%= pb_rails("section_separator", props: { dark: dark })%>
-        <a href="#" style="padding: 16px 0px 22px 0px;" id="copy-code-<%= example_key %>" class="pb--copy-code" onclick="copyOnClick(`<%= source %>`, `copy-code-<%= example_key %>`)">
-          <%= pb_rails("button", props: { id: "copy-button-#{example_key}", text: "Copy Code", size: "sm", icon: "copy" }) %>
+        <a href="#" id="copy-code-<%= example_key %>" class="pb--copy-code" onclick="copyOnClick(`<%= source %>`, `copy-code-<%= example_key %>`)">
+          <%= pb_rails("button", props: { id: "copy-button-#{example_key}", text: "Copy Code", size: "sm", icon: "copy", padding_x: "xs" }) %>
         </a>
-        <pre class="highlight"><%= raw rouge(source, highlighter) %></pre>
+        <pre class="highlight"><%= raw render_code(source, highlighter) %></pre>
       </div>
         <%= pb_rails("popover", props: {
           trigger_element_id: "copy-button-#{example_key}",

data/app/pb_kits/playbook/pb_form_pill/_form_pill.tsx

@@ -10,7 +10,7 @@ type FormPillProps = {
   className?: string,
   id?: string,
   text: string,
-  name: string,
+  name?: string,
   onClick?: React.MouseEventHandler<HTMLSpanElement>,
   avatar?: boolean,
   avatarUrl?: string,
@@ -25,6 +25,7 @@ type FormPillProps = {
 const FormPill = (props: FormPillProps) => {
   const {
     className,
+    id,
     text,
     name,
     onClick = () => {},
@@ -41,7 +42,7 @@ const FormPill = (props: FormPillProps) => {
     textTransform,
   )
   return (
-    <div className={css}>
+    <div className={css} id={id}>
         {name &&
         <>
         <Avatar