playbook_ui_docs 14.23.0.pre.alpha.play23129273 → 14.23.0.pre.rc.0

data/app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_with_custom_header_multi_header.jsx

@@ -1,107 +0,0 @@
-import React from "react"
-import AdvancedTable from '../../pb_advanced_table/_advanced_table'
-import Icon from "../../pb_icon/_icon"
-import Flex from "../../pb_flex/_flex"
-import Caption from "../../pb_caption/_caption"
-import Tooltip from "../../pb_tooltip/_tooltip"
-import MOCK_DATA from "./advanced_table_mock_data.json"
-
-const AdvancedTableWithCustomHeaderMultiHeader = (props) => {
-
-const columnDefinitions = [
-    {
-      accessor: "year",
-      label: "Year",
-      id: "year",
-      cellAccessors: ["quarter", "month", "day"],
-    },
-    {
-      label: "Enrollment Data",
-      id: "enrollmentData",
-      header: () => (
-        <Flex alignItems="center" 
-            justifyContent="center"
-        >
-          <Caption marginRight="xs">Enrollments Data</Caption>
-          <Tooltip placement="top" 
-              text="Whoa. I'm a Tooltip" 
-              zIndex={10}
-          >
-            <Icon cursor="pointer" 
-                icon="info"
-                size="xs" 
-            />
-          </Tooltip>
-        </Flex>
-      ),
-      columns: [
-        {
-          label: "Enrollment Stats",
-          id: "enrollmentStats",
-          columns: [
-            {
-              accessor: "newEnrollments",
-              id: "newEnrollments",
-              label: "New Enrollments",
-            },
-            {
-              accessor: "scheduledMeetings",
-              id: "scheduledMeetings",
-              label: "Scheduled Meetings",
-            },
-          ],
-        },
-      ],
-    },
-    {
-      label: "Performance Data",
-      id: "performanceData",
-      columns: [
-        {
-          label: "Completion Metrics",
-          id: "completionMetrics",
-          columns: [
-            {
-              accessor: "completedClasses",
-              label: "Completed Classes",
-              id: "completedClasses",
-            },
-            {
-              accessor: "classCompletionRate",
-              label: "Class Completion Rate",
-              id: "classCompletionRate",
-            },
-          ],
-        },
-        {
-          label: "Attendance",
-          id: "attendance",
-          columns: [
-            {
-              accessor: "attendanceRate",
-              label: "Attendance Rate",
-              id: "attendanceRate",
-            },
-            {
-              accessor: "scheduledMeetings",
-              label: "Scheduled Meetings",
-              id: "scheduledMeetings",
-            },
-          ],
-        },
-      ],
-    },
-  ];
-
-  return (
-    <div>
-      <AdvancedTable
-          columnDefinitions={columnDefinitions}
-          tableData={MOCK_DATA}
-          {...props}
-      />
-    </div>
-  )
-}
-
-export default AdvancedTableWithCustomHeaderMultiHeader;

data/app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_with_custom_header_multi_header.md

@@ -1 +0,0 @@
-The optional `header` key/value pair within `columnDefinitions` can also be used with multi headers as seen here. 

data/app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_with_custom_header_rails.html.erb

@@ -1,51 +0,0 @@
-<%
-  column_definitions = [
-    {
-      accessor: "year",
-      label: "Year",
-      cellAccessors: ["quarter", "month", "day"],
-    },
-    {
-      accessor: "newEnrollments",
-      label: "New Enrollments",
-      header: ->(cell, label) {
-        capture do
-          pb_rails("flex", props: { align_items: "center", justify_content: "center" }) do
-            pb_rails("caption", props: { margin_right: "xs", text: "New Enrollments" }) +
-            pb_rails("icon", props: { id: "tooltip-interact", icon: "info", size: "xs" }) +
-            pb_rails("tooltip", props: {
-              trigger_element_id: "tooltip-interact",
-              tooltip_id: "example-custom-tooltip",
-              position: "top",
-              z_index: "10"
-            }) do
-              "Whoa. I'm a Tooltip"
-            end
-          end
-        end
-      }
-    },
-    {
-      accessor: "scheduledMeetings",
-      label: "Scheduled Meetings",
-    },
-    {
-      accessor: "attendanceRate",
-      label: "Attendance Rate",
-    },
-    {
-      accessor: "completedClasses",
-      label: "Completed Classes",
-    },
-    {
-      accessor: "classCompletionRate",
-      label: "Class Completion Rate",
-    },
-    {
-      accessor: "graduatedStudents",
-      label: "Graduated Students",
-    }
-  ]
-%>
-
-<%= pb_rails("advanced_table", props: { id: "custom_header_table", table_data: @table_data, column_definitions: column_definitions }) %>

data/app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_with_custom_header_rails.md

@@ -1 +0,0 @@
-The optional `header` item can be used within `column_definitions` to render a custom header. This example shows an Icon and Tooltip being used but other kits can be used as well.

data/app/pb_kits/playbook/pb_bar_graph/docs/_bar_graph_height.md

@@ -1,3 +0,0 @@
-By default, Highcharts have a height of 400px, but this can be customized. You can override the default by specifying either a percentage or a fixed pixel value.
-
-Using a percentage maintains a consistent aspect ratio across different responsive sizes. For example, setting the height to 50% makes the chart’s height half of its width.

data/app/pb_kits/playbook/pb_body/docs/_body_truncate_react.md

@@ -1,4 +0,0 @@
-##### Prop
-`truncate` | **Type**: Enum | **Values**: 1 | 2 | 3 | 4 | 5
-
-The `truncate` prop truncates overflowing text up to a maximum of five rows and adds an ellipsis at the end.

data/app/pb_kits/playbook/pb_circle_chart/docs/_circle_chart_colors_react.md

@@ -1,2 +0,0 @@
-Custom data colors allow for color customization to match the needs of business requirements. 
-Import the colors from Playbook's tokens, then set custom colors in the plotOptions.pie.colors array using the desired color variables. Hex colors are also available `eg: #CA0095`.

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

@@ -1 +0,0 @@
-**Important Note for the React Kit**: In order to leverage this kit, you must install `highcharts` and `highcharts-react-official` into your project as shown below. To then apply Playbook styles to your Highchart, import circleChartTheme.ts from playbook-ui and merge it with your Highchart options. Then, pass the merged value to the options prop. Playbook’s styling will be applied automatically. See the examples in the documentation below.

data/app/pb_kits/playbook/pb_dropdown/docs/_dropdown_with_custom_active_style_options.jsx

@@ -1,90 +0,0 @@
-import React from 'react'
-import Dropdown from '../_dropdown'
-
-const DropdownCustomActiveStyleOptions = (props) => {
-
-
-  const options = [
-    {
-      label: "United States",
-      value: "unitedStates",
-      id: "us"
-    },
-    {
-      label: "Canada",
-      value: "canada",
-      id: "ca"
-    },
-    {
-      label: "Pakistan",
-      value: "pakistan",
-      id: "pk"
-    }
-  ];  
-
-
-  return (
-  <div>
-    <Dropdown
-        activeStyle={{
-          backgroundColor: "bg_light",
-          fontColor: "primary",
-        }}
-        label="Background Color: bg_light; Font Color: primary"
-        marginBottom="sm"
-        options={options}
-        {...props}
-    >
-      <Dropdown.Trigger/>
-      <Dropdown.Container>
-        {options.map((option) => (
-          <Dropdown.Option key={option.id} 
-              option={option}
-          />
-        ))}
-      </Dropdown.Container>
-    </Dropdown>
-    <Dropdown
-        activeStyle={{
-          backgroundColor: "white",
-          fontColor: "primary",
-        }}
-        label="Background Color: white; Font Color: primary"
-        marginBottom="sm"
-        options={options}
-        {...props}
-    />
-    <Dropdown
-        activeStyle={{
-          backgroundColor: "bg_light",
-          fontColor: "text_lt_default",
-        }}
-        autocomplete
-        label="Background Color: bg_light; Font Color: text_lt_default"
-        marginBottom="sm"
-        options={options}
-        {...props}
-    />
-    <Dropdown
-        activeStyle={{
-          fontColor: "text_lt_lighter",
-        }}
-        label="Font Color: text_lt_lighter"
-        marginBottom="sm"
-        options={options}
-        {...props}
-    >
-      <Dropdown.Trigger/>
-      <Dropdown.Container>
-        {options.map((option) => (
-          <Dropdown.Option key={option.id} 
-              option={option}
-          />
-        ))}
-      </Dropdown.Container>
-    </Dropdown>
-  </div>
-  )
-}
-
-export default  DropdownCustomActiveStyleOptions

data/app/pb_kits/playbook/pb_dropdown/docs/_dropdown_with_custom_active_style_options_react.md

@@ -1,4 +0,0 @@
-The `activeStyle` prop can be used to customize the appearance of the dropdown selection indicator. It accepts an object with the following keys: `backgroundColor` sets the background color of the selected item (and its hover state); `fontColor` sets the font color of the selected item.
-
-`backgroundColor` **Type**: String | **Values**: bg_light | white | **Default**: (no selection) is primary
-`fontColor` **Type**: String | **Values**: primary | all [Playbook Text Colors](https://playbook.powerapp.cloud/visual_guidelines/colors) | **Default**: (no selection) is white

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

@@ -1 +0,0 @@
-**Important Note for the React Kit**: In order to leverage this kit, you must install `highcharts` and `highcharts-react-official` into your project as shown below. To then apply Playbook styles to your Highchart, import gaugeTheme.ts from playbook-ui and merge it with your Highchart options. Then, pass the merged value to the options prop. Playbook’s styling will be applied automatically. See the examples in the documentation below.

data/app/pb_kits/playbook/pb_gauge/docs/_gauge_colors_react.md

@@ -1,2 +0,0 @@
-Custom data colors allow for color customization to match the needs of business requirements.
-Pass the prop `plotOptions.solidgauge.borderColor` with a Playbook token like `colors.` + `data_1 | data_2 | data_3 | data_4 | data_5 | data_6 | data_7 | data_8`. Hex colors are also available `eg: #CA0095`

data/app/pb_kits/playbook/pb_gauge/docs/_gauge_complex_react.md

@@ -1 +0,0 @@
-We are able to wrap the Highcharts Gauge kit within Playbook kits (such as Flex and Card components).

data/app/pb_kits/playbook/pb_gauge/docs/_gauge_units_react.md

@@ -1 +0,0 @@
-Use custom CSS with classes or inline styles (as shown in these docs) to customize the appearance of prefix and suffix units.

data/app/pb_kits/playbook/pb_line_graph/docs/_line_graph_colors_react.md

@@ -1,3 +0,0 @@
-
-Custom data colors allow for color customization to match the needs of business requirements. 
-Import the colors from Playbook's tokens, then set custom colors in the colors array using the desired color variables. Hex colors are also available `eg: #CA0095`.

data/app/pb_kits/playbook/pb_line_graph/docs/_line_graph_height.md

@@ -1,3 +0,0 @@
-By default, Highcharts have a height of 400px, but this can be customized. You can override the default by specifying either a percentage or a fixed pixel value.
-
-Using a percentage maintains a consistent aspect ratio across different responsive sizes. For example, setting the height to 50% makes the chart’s height half of its width.

data/app/pb_kits/playbook/pb_phone_number_input/docs/_phone_number_input_strict_mode.html.erb

@@ -1,10 +0,0 @@
-<%= pb_rails("phone_number_input", props: {
-    strict_mode: true,
-}) %>
-
-<%= pb_rails("body", props: { text: "With format_as_you_type" }) %>
-
-<%= pb_rails("phone_number_input", props: {
-    strict_mode: true,
-    format_as_you_type: true,
-}) %>

data/app/pb_kits/playbook/pb_phone_number_input/docs/_phone_number_input_strict_mode.jsx

@@ -1,26 +0,0 @@
-import React from "react";
-
-import Body from '../../pb_body/_body'
-import PhoneNumberInput from '../../pb_phone_number_input/_phone_number_input'
-
-const PhoneNumberInputStrictMode = (props) => {
-
-    return (
-        <>
-            <PhoneNumberInput
-                id="strict"
-                strictMode
-                {...props}
-            />
-            <Body>With formatAsYouType</Body>
-            <PhoneNumberInput
-                formatAsYouType
-                id="strict"
-                strictMode
-                {...props}
-            />
-        </>
-    );
-};
-
-export default PhoneNumberInputStrictMode;

data/app/pb_kits/playbook/pb_phone_number_input/docs/_phone_number_input_strict_mode.md

@@ -1,3 +0,0 @@
-Ignore any irrelevant characters and cap the length at the maximum valid number length.
-
-This can be combined with `format_as_you_type` / `formatAsYouType`. 

data/app/pb_kits/playbook/pb_title/docs/_title_truncate_react.md

@@ -1,4 +0,0 @@
-##### Prop
-`truncate` | **Type**: Enum | **Values**: 1 | 2 | 3 | 4 | 5
-
-The `truncate` prop truncates overflowing text up to a maximum of five rows and adds an ellipsis at the end.

data/app/pb_kits/playbook/pb_tooltip/docs/_tooltip_click_open.html.erb

@@ -1,14 +0,0 @@
-<%= pb_rails("button", props: { 
-  text: "Click to Open",
-  id: "click-tooltip-trigger-1",
-  variant: "primary"
-}) %>
-
-<%= pb_rails("tooltip", props: {
-  trigger_element_selector: "#click-tooltip-trigger-1",
-  tooltip_id: "click-tooltip-1",
-  position: "top",
-  use_click_to_open: true
-}) do %>
-  Tooltip opened by click! Click trigger again to close.
-<% end %>

data/app/pb_kits/playbook/pb_tooltip/docs/_tooltip_click_open_rails.md

@@ -1 +0,0 @@
-Set the prop `use_click_to_open` as `true` so that the tooltip will only appear when an item is clicked rather than hovered over.