playbook_ui 13.12.0 → 13.13.0.pre.alpha.PLAY1097linterenhancedelement1728

data/app/pb_kits/playbook/utilities/props.ts

@@ -49,3 +49,19 @@ export const buildDataProps = (data: {[key: string]: any}) => buildPrefixedProps
  */
 export const buildCss = (...rules: (string | { [x: string]: string | boolean; })[]): string => classnames(rules).replace(/\s/g, '_')
 
+/**
+ * Maps a given data object into HTML valid attributes and their values.
+ * This is a more general version of what buildAriaProps and buildDataProps do.
+ * It is used to map any arbitrary prop into a valid HTML attribute.
+ *  
+ * @returns {Object} an object holding the HTML valid props and their values.
+ */
+
+export const buildHtmlProps = (htmlOptions: { [key: string]: string | number | boolean | Function }) => {
+  const htmlProps: { [attr: string]: string | number | boolean | Function } = {}
+  Object.keys(htmlOptions).forEach((key) => {
+    htmlProps[key] = htmlOptions[key]
+  })
+  return htmlProps
+}
+

data/dist/menu.yml

@@ -7,279 +7,351 @@ react_only: &react_only ["react"]
 swift_only: &swift_only ["swift"]
 
 kits:
-  - name: "avatars"
+  - name: alerts_and_dialogs
+    description: 
     components:
-      - name: "avatar"
-        platforms: *all
-      - name: "avatar_action_button"
-        platforms: *web
-      - name: "multiple_users"
-        platforms: *web
-      - name: "multiple_users_stacked"
+      - name: "dialog"
         platforms: *web
-      - name: "user"
+        description: 
+      - name: "fixed_confirmation_toast"
         platforms: *web
-  - name: "background"
-    components:
-      - name: "background"
+        description: Fixed Confirmation Toast is used as an alert. Success is used when a user successfully completes an action. Error is used when there is an error and the user cannot proceed. Neutral is used to display information to a user to complete a task.
+      - name: "popover"
         platforms: *web
-  - name: "bread_crumbs"
-    components:
-      - name: "bread_crumbs"
+        description: A popover is a way to toggle content on top of other content. It can be used for small texts, small forms, or even dropdowns. By default, popover will toggle open/closed by simply clicking the trigger element.
+      - name: "tooltip"
         platforms: *web
-  - name: "buttons"
+        description:
+  - name: buttons
+    description: Buttons are used primarily for actions, such as “Save” and “Cancel”. Link Buttons are used for less important or less commonly used actions, such as “view shipping settings”.
     components:
       - name: "button"
         platforms: *web
+        description: 
       - name: "button_toolbar"
         platforms: *web
+        description: This kit should primarily hold the most commonly used buttons.
       - name: "circle_icon_button"
         platforms: *web
-  - name: "card"
-    components:
-      - name: "card"
-        platforms: *all
-  - name: "collapsible"
+        description: When using Icon Circle Button, the icon must be clear a clear indication of what the button does because there is no text. 
+  - name: data_visualization
+    description: 
     components:
-      - name: "collapsible"
+      - name: "map"
+        platforms: *react_only
+        description: This kit provides a wrapping class to place around the MapLibre library.
+      - name: "table"
         platforms: *web
-  - name: "charts_and_graphs"
-    components:
-      - name: "bar_graph"
+        description: Tables display a collection of structured data and typically have the ability to sort, filter, and paginate data. 
+      - name: "list"
         platforms: *web
-      - name: "circle_chart"
+        description: Lists display a vertical set of related content.
+      - name: "filter"
         platforms: *web
+        description: This kit can be implemented in a variety of ways. To see examples of how to implement this kit in production visit the /dev_docs/search page in production.
       - name: "distribution_bar"
         platforms: *web
+        description: Can be used in the same way a pie chart can be used. By default, Distribution Bar comparatively represents data without numbers. 
+      - name: "legend"
+        platforms: *web
+        description: A key used to compare the variables and their value in any given graph.
       - name: "gauge"
         platforms: *web
-      - name: "legend"
+        description: 
+      - name: "bar_graph"
+        platforms: *web
+        description: Bar graphs are used to compare data. Bar graphs are not typically used to show percentages.
+      - name: "circle_chart"
         platforms: *web
+        description: 
       - name: "line_graph"
         platforms: *web
+        description: Line graphs are used to show changes in data over time.
       - name: "treemap_chart"
         platforms: *web
-  - name: "dialog"
+        description: Treemap charts are used to compare the relative size of groups of data. They can also use a nested data structure, allowing a user to drill down into a group to see its constituent data points.
+  - name: date_and_time_text_patterns
+    description: ""
     components:
-      - name: "dialog"
+      - name: "date"
         platforms: *web
-  - name: "filter"
-    components:
-      - name: "filter"
+        description: Use to display the date. Year will not display if it is the current year.
+      - name: "date_range_inline"
         platforms: *web
-  - name: "fixed_confirmation_toast"
-    components:
-      - name: "fixed_confirmation_toast"
+        description: Use to display a date range. Year will not show if it is the current year.
+      - name: "date_range_stacked"
+        platforms: *web
+        description: 
+      - name: "date_stacked"
+        platforms: *web
+        description: Use to display the date, stacking month and day. Year will not show if it is the current year.
+      - name: "date_time"
+        platforms: *web
+        description: Date Time is a composite kit that leverages the Date and Time kits. The Date Time kit is affected by time zones and defaults to "America/New_York".
+      - name: "date_time_stacked"
+        platforms: *web
+        description: 
+      - name: "date_year_stacked"
+        platforms: *web
+        description: This kit is a simple option for displaying dates in a month, day and the year format.
+      - name: "time"
+        platforms: *web
+        description: This kit consist of large display and table display format. It includes and icon, and a time zone.
+      - name: "time_range_inline"
+        platforms: *web
+        description: 
+      - name: "time_stacked"
+        platforms: *web
+        description: 
+      - name: "timestamp"
+        platforms: *all
+        description: This low profile kit displays time. Elapsed, current, future, or otherwise.
+      - name: "weekday_stacked"
         platforms: *web
-  - name: "forms"
+        description: 
+  - name: form_and_dashboard_text_patterns
+    description: ""
     components:
-      - name: "checkbox"
+      - name: "contact"
         platforms: *web
-      - name: "date_picker"
+        description: Use to display customer's or user's contact information.
+      - name: "currency"
+        platforms: *web
+        description: Use to display monetary amounts, typically on dashboards or other layouts to show an overview or summary. User understanding increase when paired with labels.
+      - name: "home_address_street"
+        platforms: *web
+        description: This kit can be used to display the address for a homeowner/project. It contains street address, APT format, City, state and zip. A Project hashtag can be used as a prop to link back to a project.
+      - name: "label_pill"
+        platforms: *web
+        description: This kit combines the caption and pill kit with all its variants.
+      - name: "label_value"
+        platforms: *web
+        description: This kit can be very versatile when used to display text data.
+      - name: "person"
+        platforms: *web
+        description: This kit is broken down into a first name last name format with normal and bold weighted text.
+      - name: "person_contact"
+        platforms: *web
+        description: This kit can be used to display a person contact information. 
+      - name: "source"
+        platforms: *web
+        description: General use is to describe the discovery of businesses, customers, etc. This kit can also be used for other purposes as well.
+      - name: "dashboard_value"
+        platforms: *web
+        description: Use in dashboards to give the viewer a quick overview of important metrics. If want to show currency, use Currency Kit.
+      - name: "stat_change"
+        platforms: *web
+        description: Displays the increase, decrease, or neutral change in data.
+      - name: "stat_value"
         platforms: *web
+        description: This kit was cerated for the main use as a dashboard display for numbers. A large label is an optional part if it needs more clarity.
+      - name: "title_count"
+        platforms: *web
+        description: This kits consists of title kit and body text. It is used to display a title and a count (numbers). It has a base size and a large formation for dashboard use.
+      - name: "title_detail"
+        platforms: *web
+        description: This kit can be used in many versatile ways. It consist of a title 4 and light body text kit.
+  - name: form_elements
+    description: 
+    components:
       - name: "file_upload"
         platforms: *web
-      - name: "form"
-        platforms: *rails_only
-      - name: "form_group"
+        description: 
+      - name: "toggle"
         platforms: *web
+        description: Physical switch that allows users to turn things on or off. Used for applying system states, presenting binary options and activating a state.
       - name: "form_pill"
         platforms: *web
-      - name: "multi_level_select"
+        description: 
+      - name: "form"
+        platforms: *rails_only
+        description: The form kit provides consumers with a convenient, consistently styled <form> wrapper.
+      - name: "form_group"
         platforms: *web
+        description: 
+  - name: form_input
+    description: ""
+    components:
       - name: "passphrase"
         platforms: *web
+        description: 
       - name: "phone_number_input"
         platforms: *web
-      - name: "radio"
-        platforms: *all
+        description: 
+      - name: "text_input"
+        platforms: *web
+        description: Area where user can enter small amount of text. Commonly used in forms.
       - name: "rich_text_editor"
         platforms: *web
-      - name: "select"
+        description: 
+      - name: "textarea"
         platforms: *web
-      - name: "selectable_card"
+        description: Area where user can enter larger amounts of text. Commonly used in forms.
+      - name: "typeahead"
         platforms: *web
-      - name: "selectable_card_icon"
+        description: Typeahead is auto suggestion or completion based on what the user is starting to type, gets refined as the user types more.
+  - name: form_selection
+    description: 
+    components:
+      - name: "date_picker"
         platforms: *web
-      - name: "selectable_icon"
+        description: Playbook's date picker is built using flatpickr, a vanilla js library. Common date picker use cases and features have been adapted into simple prop based configuration detailed in the docs below.
+      - name: "multi_level_select"
         platforms: *web
-      - name: "selectable_list"
+        description: The MultiLevelSelect kit renders a multi leveled select dropdown based on data from the user. 
+      - name: "select"
         platforms: *web
-      - name: "text_input"
+        description: Select displays multiple options for a user to pick from in a dropdown menu. User selects one option.
+      - name: "selectable_card"
         platforms: *web
-      - name: "textarea"
+        description: Cards for information/content that can be selected. There is design for unselected and selected states. Typically used as a form element.
+      - name: "selectable_card_icon"
         platforms: *web
-      - name: "toggle"
+        description: 
+      - name: "selectable_icon"
         platforms: *web
-      - name: "typeahead"
+        description: 
+      - name: "radio"
+        platforms: *all
+        description: Radio is a control that allows the user to only choose one predefined option.
+      - name: "checkbox"
         platforms: *web
-  - name: "highlight"
-    components:
-      - name: "highlight"
+        description: Checkbox is used for a list of selections that are meant to have one or more options checked.
+      - name: "selectable_list"
         platforms: *web
-  - name: "icon"
+        description: 
+  - name: icons_and_images
+    description: ""
     components:
       - name: "icon"
         platforms: *web
-  - name: "icon_circle"
-    components:
+        description: An icon is a graphic symbol that represents an object (ie a file) or a function. They can be used to give the user feedback.
       - name: "icon_circle"
         platforms: *web
-  - name: "icon_stat_value"
-    components:
+        description: Similar to Icon, Icon Circle is a graphical symbol within a circle used to visually indicate an object or function.
       - name: "icon_stat_value"
         platforms: *web
-  - name: "icon_value"
-    components:
+        description: 
       - name: "icon_value"
         platforms: *web
-  - name: "image"
-    components:
+        description: Icon Value leverages our icon kit, to display a value of some sort in the interface. Typically, this includes a numerical value.
+      - name: "user_badge"
+        platforms: *web
+        description: This kit was created to display employee icons related to a Nitro user. Currently there is the PVI logo and the Million Dollar Rep Icon.
       - name: "image"
         platforms: *web
-  - name: "layouts"
+        description: A responsive image component.
+      - name: "lightbox"
+        platforms: *react_only
+        description: The Lightbox kit is a popup window overlay that will appear on top of your webpage and cover the entirety of the screen. 
+      - name: "star_rating"
+        platforms: *web
+        description: A component to view other people’s opinions and experiences. Use when you want to show evaluation or a quick quantitative rating. Most effective when paired with reviews.
+  - name: layout_and_structure
+    description: 
     components:
       - name: "flex"
         platforms: *web
+        description: This kit is used to build most of the complex interfaces. The Flex Kit is used the same way flex box is used.
       - name: "layout"
         platforms: *web
-  - name: "lightbox"
-    components:
-      - name: "lightbox"
-        platforms: *react_only
-  - name: "list"
-    components:
-      - name: "list"
+        description: Layouts used for positioning content inside of pages, cards, or containers.
+      - name: "card"
+        platforms: *all
+        description: 
+      - name: "section_separator"
         platforms: *web
-  - name: "loading_inline"
-    components:
-      - name: "loading_inline"
+        description: Section separator is a divider line that compartmentalizes content, typically used on cards or white backgrounds.
+      - name: "background"
         platforms: *web
-  - name: "map"
+        description: The background kit is used for adding a background to a page or to any container.
+      - name: "collapsible"
+        platforms: *web
+        description: 
+  - name: message_text_patterns
+    description: 
     components:
-      - name: "map"
-        platforms: *react_only
-  - name: "nav"
+      - name: "highlight"
+        platforms: *web
+        description: Highlight is used to pick out or emphasize content.
+      - name: "message"
+        platforms: *web
+        description: This multi kit consist of a an avatar, a status, a caption, a body text, and a time stamp. All which can be optional.
+  - name: navigation
+    description: 
     components:
+      - name: "bread_crumbs"
+        platforms: *web
+        description: BreadCrumbs can be used for keeping a user aware of their route location.
       - name: "nav"
         platforms: *web
-  - name: "pagination"
-    components:
+        description: The nav is a grouped set of links that take the user to another page, or tab through parts of a page. It comes in horizontal or vertical with several different variants.
       - name: "pagination"
         platforms: *rails_only
-  - name: "popover"
+        description:
+  - name: state_and_progress_indicators
+    description: 
     components:
-      - name: "popover"
+      - name: "loading_inline"
         platforms: *web
-  - name: "progress"
-    components:
+        description: The loading kit is used to indicate to users that a page is still loading, or an action is still being processed.
       - name: "progress_pills"
         platforms: *web
+        description: Progress pills indicate a specific point in time of a series of sequential steps. They are used to track progress of something over time.
       - name: "progress_simple"
         platforms: *web
+        description: Displays the current progress of an operation flow. User understanding increases when paired with labels or numbers.
       - name: "progress_step"
         platforms: *web
-  - name: "section_separator"
-    components:
-      - name: "section_separator"
-        platforms: *web
-  - name: "star_rating"
-    components:
-      - name: "star_rating"
+        description: "Progress step kit is used to show the progress of a process. There are three types of steps in this kit: completed, active, and inactive."
+      - name: "walkthrough"
         platforms: *web
-  - name: "table"
-    components:
-      - name: "table"
+        description:
+      - name: "timeline"
         platforms: *web
-  - name: "tags"
+        description: The timeline kit can use two different line styles in the same timeline - solid and dotted line styles.
+  - name: tags
+    description: 
     components:
-      - name: "tags"
-        platforms: *web
       - name: "badge"
         platforms: *web
-      - name: "hashtag"
-        platforms: *web
+        description: Badges can be used for notification, tags, and status. They are used for count and numbers.
       - name: "pill"
         platforms: *all
-  - name: "timeline"
-    components:
-      - name: "timeline"
-        platforms: *web
-  - name: "time_and_date"
-    components:
-      - name: "date"
-        platforms: *web
-      - name: "date_range_inline"
-        platforms: *web
-      - name: "date_range_stacked"
-        platforms: *web
-      - name: "date_stacked"
-        platforms: *web
-      - name: "date_time"
-        platforms: *web
-      - name: "date_time_stacked"
-        platforms: *web
-      - name: "date_year_stacked"
-        platforms: *web
-      - name: "time"
-        platforms: *web
-      - name: "time_range_inline"
-        platforms: *web
-      - name: "time_stacked"
-        platforms: *web
-      - name: "timestamp"
-        platforms: *all
-      - name: "weekday_stacked"
-        platforms: *web
-  - name: "tooltip"
-    components:
-      - name: "tooltip"
+        description: A pill uses both a keyword and a specific color to categorize an item. 
+      - name: "hashtag"
         platforms: *web
-  - name: "typography"
+        description: Hashtag is used to display home, project and other forms of IDs. They can be used as a link.
+  - name: typography
+    description: ""
     components:
       - name: "body"
         platforms: *web
+        description: Default text style for paragraphs. Follow hiearchy when using "light" or "lighter" variants to deemphasize text — default style should be followed by "light" followed by "lighter".
       - name: "caption"
         platforms: *web
+        description: Use to provide supplementary context. Default size is best when providing supplementary context to a small section (i.e. label for a text input, label for a paragraph). Use large caption when supplementary text covers more content.
       - name: "detail"
         platforms: *web
+        description: Used for tables or designs with large amounts of data or text.
       - name: "title"
         platforms: *web
-  - name: "typography_patterns"
+        description: Typically used as headers. Follow semantic hierarchy — Title 1s should be followed by Title 2s followed by Title 3s and so on, without skipping any levels.
+  - name: user
+    description: 
     components:
-      - name: "contact"
-        platforms: *web
-      - name: "currency"
-        platforms: *web
-      - name: "dashboard_value"
-        platforms: *web
-      - name: "home_address_street"
-        platforms: *web
-      - name: "label_pill"
-        platforms: *web
-      - name: "label_value"
-        platforms: *web
-      - name: "message"
-        platforms: *web
-      - name: "person"
-        platforms: *web
-      - name: "person_contact"
-        platforms: *web
-      - name: "source"
-        platforms: *web
-      - name: "stat_change"
-        platforms: *web
-      - name: "stat_value"
-        platforms: *web
-      - name: "title_count"
+      - name: "avatar"
+        platforms: *all
+        description: Avatar displays a user's picture. This helps aid easy recognition of the user. This kit is normally not used by itself, but rather used within other kits. The only time Avatar should be used instead of the User kit is when you are not going to display the user's name.
+      - name: "avatar_action_button"
         platforms: *web
-      - name: "title_detail"
+        description: 
+      - name: "multiple_users"
         platforms: *web
-  - name: "user_badge"
-    components:
-      - name: "user_badge"
+        description: The multiple users kit is used to show that more than one user is associated to an action or item.
+      - name: "multiple_users_stacked"
         platforms: *web
-  - name: "walkthrough"
-    components:
-      - name: "walkthrough"
+        description: Multiple users stacked is used in tight spaces, where we need to indicate that multiple users are associated to a specific action or item.
+      - name: "user"
         platforms: *web
+        description: This kit was created for having a systematic way of displaying users with avatar, titles, name and territory. This is a versatile kit with features than can be added to display more info.