playbook_ui_docs 14.10.0.pre.alpha.play16825301 → 14.10.0.pre.rc.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: playbook_ui_docs
 version: !ruby/object:Gem::Version
-  version: 14.10.0.pre.alpha.play16825301
+  version: 14.10.0.pre.rc.0
 platform: ruby
 authors:
 - Power UX
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-01-08 00:00:00.000000000 Z
+date: 2024-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: playbook_ui
@@ -41,14 +41,6 @@ files:
 - app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_beta_subrow_headers.md
 - app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_collapsible_trail.jsx
 - app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_collapsible_trail.md
-- app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_collapsible_trail_rails.html.erb
-- app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_collapsible_trail_rails.md
-- app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_column_headers.html.erb
-- app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_column_headers.jsx
-- app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_column_headers.md
-- app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_column_headers_multiple.html.erb
-- app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_column_headers_multiple.jsx
-- app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_column_headers_multiple.md
 - app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_custom_cell.jsx
 - app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_custom_cell.md
 - app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_custom_cell_rails.html.erb
@@ -61,10 +53,6 @@ files:
 - app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_inline_row_loading.md
 - app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_loading.jsx
 - app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_loading.md
-- app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_pagination.jsx
-- app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_pagination.md
-- app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_pagination_with_props.jsx
-- app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_pagination_with_props.md
 - app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_responsive.jsx
 - app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_responsive.md
 - app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_sort.jsx
@@ -79,7 +67,6 @@ files:
 - app/pb_kits/playbook/pb_advanced_table/docs/_advanced_table_table_props.md
 - app/pb_kits/playbook/pb_advanced_table/docs/_mock_data_inline_loading.js
 - app/pb_kits/playbook/pb_advanced_table/docs/advanced_table_mock_data.json
-- app/pb_kits/playbook/pb_advanced_table/docs/advanced_table_pagination_mock_data.json
 - app/pb_kits/playbook/pb_advanced_table/docs/example.yml
 - app/pb_kits/playbook/pb_advanced_table/docs/index.js
 - app/pb_kits/playbook/pb_avatar/docs/_avatar_badge_component_overlay.html.erb
@@ -370,7 +357,6 @@ files:
 - app/pb_kits/playbook/pb_circle_icon_button/docs/_circle_icon_button_default.jsx
 - app/pb_kits/playbook/pb_circle_icon_button/docs/_circle_icon_button_link.html.erb
 - app/pb_kits/playbook/pb_circle_icon_button/docs/_circle_icon_button_link.jsx
-- app/pb_kits/playbook/pb_circle_icon_button/docs/_circle_icon_button_link.md
 - app/pb_kits/playbook/pb_circle_icon_button/docs/_circle_icon_button_loading.html.erb
 - app/pb_kits/playbook/pb_circle_icon_button/docs/_circle_icon_button_loading.jsx
 - app/pb_kits/playbook/pb_circle_icon_button/docs/_description.md
@@ -1537,9 +1523,6 @@ files:
 - app/pb_kits/playbook/pb_section_separator/docs/_section_separator_children.jsx
 - app/pb_kits/playbook/pb_section_separator/docs/_section_separator_children.md
 - app/pb_kits/playbook/pb_section_separator/docs/_section_separator_children_swift.md
-- app/pb_kits/playbook/pb_section_separator/docs/_section_separator_color.html.erb
-- app/pb_kits/playbook/pb_section_separator/docs/_section_separator_color.jsx
-- app/pb_kits/playbook/pb_section_separator/docs/_section_separator_color.md
 - app/pb_kits/playbook/pb_section_separator/docs/_section_separator_dashed.html.erb
 - app/pb_kits/playbook/pb_section_separator/docs/_section_separator_dashed.jsx
 - app/pb_kits/playbook/pb_section_separator/docs/_section_separator_dashed_swift.md
@@ -1637,27 +1620,16 @@ files:
 - app/pb_kits/playbook/pb_selectable_list/docs/_selectable_list_radio.jsx
 - app/pb_kits/playbook/pb_selectable_list/docs/example.yml
 - app/pb_kits/playbook/pb_selectable_list/docs/index.js
-- app/pb_kits/playbook/pb_skeleton_loading/docs/_description.md
-- app/pb_kits/playbook/pb_skeleton_loading/docs/_skeleton_loading_border_radius.html.erb
 - app/pb_kits/playbook/pb_skeleton_loading/docs/_skeleton_loading_border_radius.jsx
-- app/pb_kits/playbook/pb_skeleton_loading/docs/_skeleton_loading_border_radius_rails.md
-- app/pb_kits/playbook/pb_skeleton_loading/docs/_skeleton_loading_border_radius_react.md
-- app/pb_kits/playbook/pb_skeleton_loading/docs/_skeleton_loading_color.html.erb
+- app/pb_kits/playbook/pb_skeleton_loading/docs/_skeleton_loading_border_radius.md
 - app/pb_kits/playbook/pb_skeleton_loading/docs/_skeleton_loading_color.jsx
 - app/pb_kits/playbook/pb_skeleton_loading/docs/_skeleton_loading_color.md
 - app/pb_kits/playbook/pb_skeleton_loading/docs/_skeleton_loading_default.html.erb
 - app/pb_kits/playbook/pb_skeleton_loading/docs/_skeleton_loading_default.jsx
-- app/pb_kits/playbook/pb_skeleton_loading/docs/_skeleton_loading_filter.html.erb
-- app/pb_kits/playbook/pb_skeleton_loading/docs/_skeleton_loading_filter.jsx
-- app/pb_kits/playbook/pb_skeleton_loading/docs/_skeleton_loading_height_width.html.erb
 - app/pb_kits/playbook/pb_skeleton_loading/docs/_skeleton_loading_height_width.jsx
-- app/pb_kits/playbook/pb_skeleton_loading/docs/_skeleton_loading_height_width_rails.md
-- app/pb_kits/playbook/pb_skeleton_loading/docs/_skeleton_loading_height_width_react.md
-- app/pb_kits/playbook/pb_skeleton_loading/docs/_skeleton_loading_layout.html.erb
+- app/pb_kits/playbook/pb_skeleton_loading/docs/_skeleton_loading_height_width.md
 - app/pb_kits/playbook/pb_skeleton_loading/docs/_skeleton_loading_layout.jsx
 - app/pb_kits/playbook/pb_skeleton_loading/docs/_skeleton_loading_layout.md
-- app/pb_kits/playbook/pb_skeleton_loading/docs/_skeleton_loading_user.html.erb
-- app/pb_kits/playbook/pb_skeleton_loading/docs/_skeleton_loading_user.jsx
 - app/pb_kits/playbook/pb_skeleton_loading/docs/example.yml
 - app/pb_kits/playbook/pb_skeleton_loading/docs/index.js
 - app/pb_kits/playbook/pb_source/docs/_description.md
@@ -1769,14 +1741,8 @@ files:
 - app/pb_kits/playbook/pb_table/docs/_table_sticky.html.erb
 - app/pb_kits/playbook/pb_table/docs/_table_sticky.jsx
 - app/pb_kits/playbook/pb_table/docs/_table_sticky.md
-- app/pb_kits/playbook/pb_table/docs/_table_sticky_columns.jsx
-- app/pb_kits/playbook/pb_table/docs/_table_sticky_columns_react.md
-- app/pb_kits/playbook/pb_table/docs/_table_sticky_left_columns.html.erb
 - app/pb_kits/playbook/pb_table/docs/_table_sticky_left_columns.jsx
-- app/pb_kits/playbook/pb_table/docs/_table_sticky_left_columns_rails.md
 - app/pb_kits/playbook/pb_table/docs/_table_sticky_left_columns_react.md
-- app/pb_kits/playbook/pb_table/docs/_table_sticky_right_columns.jsx
-- app/pb_kits/playbook/pb_table/docs/_table_sticky_right_columns_react.md
 - app/pb_kits/playbook/pb_table/docs/_table_striped.html.erb
 - app/pb_kits/playbook/pb_table/docs/_table_striped.jsx
 - app/pb_kits/playbook/pb_table/docs/_table_striped.md
@@ -1790,16 +1756,6 @@ files:
 - app/pb_kits/playbook/pb_table/docs/_table_vertical_border.jsx
 - app/pb_kits/playbook/pb_table/docs/_table_with_background_kit.html.erb
 - app/pb_kits/playbook/pb_table/docs/_table_with_background_kit.jsx
-- app/pb_kits/playbook/pb_table/docs/_table_with_collapsible.jsx
-- app/pb_kits/playbook/pb_table/docs/_table_with_collapsible.md
-- app/pb_kits/playbook/pb_table/docs/_table_with_collapsible_with_custom_click.jsx
-- app/pb_kits/playbook/pb_table/docs/_table_with_collapsible_with_custom_click.md
-- app/pb_kits/playbook/pb_table/docs/_table_with_collapsible_with_custom_content.jsx
-- app/pb_kits/playbook/pb_table/docs/_table_with_collapsible_with_custom_content.md
-- app/pb_kits/playbook/pb_table/docs/_table_with_collapsible_with_nested_rows.jsx
-- app/pb_kits/playbook/pb_table/docs/_table_with_collapsible_with_nested_rows.md
-- app/pb_kits/playbook/pb_table/docs/_table_with_collapsible_with_nested_table.jsx
-- app/pb_kits/playbook/pb_table/docs/_table_with_collapsible_with_nested_table.md
 - app/pb_kits/playbook/pb_table/docs/_table_with_subcomponents.jsx
 - app/pb_kits/playbook/pb_table/docs/_table_with_subcomponents.md
 - app/pb_kits/playbook/pb_table/docs/_table_with_subcomponents_as_divs.html.erb
@@ -1828,7 +1784,6 @@ files:
 - app/pb_kits/playbook/pb_text_input/docs/_text_input_error_swift.md
 - app/pb_kits/playbook/pb_text_input/docs/_text_input_inline.html.erb
 - app/pb_kits/playbook/pb_text_input/docs/_text_input_inline.jsx
-- app/pb_kits/playbook/pb_text_input/docs/_text_input_mask.jsx
 - app/pb_kits/playbook/pb_text_input/docs/_text_input_no_label.html.erb
 - app/pb_kits/playbook/pb_text_input/docs/_text_input_no_label.jsx
 - app/pb_kits/playbook/pb_text_input/docs/_text_input_options.html.erb

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

@@ -1,36 +0,0 @@
-<% column_definitions = [
-    {
-      accessor: "year",
-      label: "Year",
-      cellAccessors: ["quarter", "month", "day"],
-    },
-    {
-      accessor: "newEnrollments",
-      label: "New Enrollments",
-    },
-    {
-      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: "collapsible_trail", table_data: @table_data, column_definitions: column_definitions }) do %>
-  <%= pb_rails("advanced_table/table_header", props: { column_definitions: column_definitions }) %>
-  <%= pb_rails("advanced_table/table_body", props: { table_data: @table_data, column_definitions: column_definitions, collapsible_trail: false }) %>
-<% end %>

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

@@ -1 +0,0 @@
-`collapsible_trail` is an optional prop that is set to 'true' by default. If set to 'false', it will remove the trail on the left of the rows when subRows are toggled open.

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

@@ -1,43 +0,0 @@
-<% column_definitions = [
-  {
-    accessor: "year",
-    label: "Year",
-    cellAccessors: ["quarter", "month", "day"],
-  },
-  {
-    label: "Enrollment Data",
-    columns: [
-      {
-        accessor: "newEnrollments",
-        label: "New Enrollments",
-      },
-      {
-        accessor: "scheduledMeetings",
-        label: "Scheduled Meetings",
-      },
-    ],
-  },
-  {
-    label: "Performance Data",
-    columns: [
-      {
-        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: "beta_table_with_headers", table_data: @table_data, column_definitions: column_definitions }) %>

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

@@ -1,60 +0,0 @@
-import React from "react"
-import { AdvancedTable } from "playbook-ui"
-import MOCK_DATA from "./advanced_table_mock_data.json"
-
-const AdvancedTableColumnHeaders = (props) => {
-  const columnDefinitions = [
-    {
-      accessor: "year",
-      label: "Year",
-      cellAccessors: ["quarter", "month", "day"],
-    },
-    {
-      label: "Enrollment Data",
-      columns: [
-        {
-          accessor: "newEnrollments",
-          label: "New Enrollments",
-        },
-        {
-          accessor: "scheduledMeetings",
-          label: "Scheduled Meetings",
-        },
-      ],
-    },
-    {
-      label: "Performance Data",
-      columns: [
-        {
-          accessor: "attendanceRate",
-          label: "Attendance Rate",
-        },
-        {
-          accessor: "completedClasses",
-          label: "Completed Classes",
-        },
-        {
-          accessor: "classCompletionRate",
-          label: "Class Completion Rate",
-        },
-        {
-          accessor: "graduatedStudents",
-          label: "Graduated Students",
-        },
-      ],
-    },
-  ];
-  
-
-  return (
-    <>
-      <AdvancedTable
-          columnDefinitions={columnDefinitions}
-          tableData={MOCK_DATA}
-          {...props}
-      />
-    </>
-  )
-}
-
-export default AdvancedTableColumnHeaders

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

@@ -1 +0,0 @@
-Use a nested `columns` array in your columnDefinitions to create multiple header rows. Any column with `columns` is treated as a grouped header, and its child columns are displayed beneath it.

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

@@ -1,58 +0,0 @@
-<% column_definitions = [
-  {
-    accessor: "year",
-    label: "Year",
-    cellAccessors: ["quarter", "month", "day"],
-  },
-  {
-    label: "Enrollment Data",
-    columns: [
-      {
-        label: "Enrollment Stats",
-        columns: [
-          {
-            accessor: "newEnrollments",
-            label: "New Enrollments",
-          },
-          {
-            accessor: "scheduledMeetings",
-            label: "Scheduled Meetings",
-          },
-        ],
-      },
-    ],
-  },
-  {
-    label: "Performance Data",
-    columns: [
-      {
-        label: "Completion Metrics",
-        columns: [
-          {
-            accessor: "completedClasses",
-            label: "Completed Classes",
-          },
-          {
-            accessor: "classCompletionRate",
-            label: "Class Completion Rate",
-          },
-        ],
-      },
-      {
-        label: "Attendance",
-        columns: [
-          {
-            accessor: "attendanceRate",
-            label: "Attendance Rate",
-          },
-          {
-            accessor: "scheduledMeetings",
-            label: "Scheduled Meetings",
-          },
-        ],
-      },
-    ],
-  },
-] %>
-
-<%= pb_rails("advanced_table", props: { id: "beta_table_with_muilti_headers", table_data: @table_data, column_definitions: column_definitions }) %>

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

@@ -1,74 +0,0 @@
-import React from "react";
-import { AdvancedTable } from "playbook-ui";
-import MOCK_DATA from "./advanced_table_mock_data.json";
-
-const AdvancedTableColumnHeadersMultiple = (props) => {
-  const columnDefinitions = [
-    {
-      accessor: "year",
-      label: "Year",
-      cellAccessors: ["quarter", "month", "day"],
-    },
-    {
-      label: "Enrollment Data",
-      columns: [
-        {
-          label: "Enrollment Stats",
-          columns: [
-            {
-              accessor: "newEnrollments",
-              label: "New Enrollments",
-            },
-            {
-              accessor: "scheduledMeetings",
-              label: "Scheduled Meetings",
-            },
-          ],
-        },
-      ],
-    },
-    {
-      label: "Performance Data",
-      columns: [
-        {
-          label: "Completion Metrics",
-          columns: [
-            {
-              accessor: "completedClasses",
-              label: "Completed Classes",
-            },
-            {
-              accessor: "classCompletionRate",
-              label: "Class Completion Rate",
-            },
-          ],
-        },
-        {
-          label: "Attendance",
-          columns: [
-            {
-              accessor: "attendanceRate",
-              label: "Attendance Rate",
-            },
-            {
-              accessor: "scheduledMeetings",
-              label: "Scheduled Meetings",
-            },
-          ],
-        },
-      ],
-    },
-  ];
-
-  return (
-    <>
-      <AdvancedTable
-          columnDefinitions={columnDefinitions}
-          tableData={MOCK_DATA}
-          {...props}
-      />
-    </>
-  );
-};
-
-export default AdvancedTableColumnHeadersMultiple;

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

@@ -1 +0,0 @@
-Multiple levels of column headers can also be rendered as seen here.

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

@@ -1,50 +0,0 @@
-import React from "react"
-import { AdvancedTable } from "playbook-ui"
-import PAGINATION_MOCK_DATA from "./advanced_table_pagination_mock_data.json"
-
-const AdvancedTablePagination = (props) => {
-  const columnDefinitions = [
-    {
-      accessor: "year",
-      label: "Year",
-      cellAccessors: ["quarter", "month", "day"],
-    },
-    {
-      accessor: "newEnrollments",
-      label: "New Enrollments",
-    },
-    {
-      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",
-    },
-  ]
-
-  return (
-    <>
-      <AdvancedTable
-          columnDefinitions={columnDefinitions}
-          pagination
-          tableData={PAGINATION_MOCK_DATA}
-          {...props}
-      />
-    </>
-  )
-}
-
-export default AdvancedTablePagination

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

@@ -1 +0,0 @@
-`pagination` is an optional prop that can be used to add pagination to the AdvancedTable. If present, it will add pagination with default values for pageSize, etc. To customize pagination, you can also use `paginationProps` shown in the next example.

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

@@ -1,57 +0,0 @@
-import React from "react"
-import { AdvancedTable } from "playbook-ui"
-import PAGINATION_MOCK_DATA from "./advanced_table_pagination_mock_data.json"
-
-const AdvancedTablePaginationWithProps = (props) => {
-  const columnDefinitions = [
-    {
-      accessor: "year",
-      label: "Year",
-      cellAccessors: ["quarter", "month", "day"],
-    },
-    {
-      accessor: "newEnrollments",
-      label: "New Enrollments",
-    },
-    {
-      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",
-    },
-  ]
-
-  const paginationProps = {
-    pageIndex: 1,
-    pageSize: 10,
-    range: 2
-  }
-  
-  return (
-    <>
-      <AdvancedTable
-          columnDefinitions={columnDefinitions}
-          pagination
-          paginationProps={paginationProps}
-          tableData={PAGINATION_MOCK_DATA}
-          {...props}
-      />
-    </>
-  )
-}
-
-export default AdvancedTablePaginationWithProps

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

@@ -1,5 +0,0 @@
-`paginationProps` is an optional prop that can be used to further customize pagination for the AdvancedTable. This prop is an object with 2 optional items:
-
-- `pageIndex`: An optional prop to set which page is set to open on initial load. Default is '0'
-- `pageSize`: An optional prop to set total number of rows for each page before the Table paginates. Default is '20'
-- `range`: The range prop determines how many pages to display in the Pagination component. Regardless of this value, the first two and last two pages are always visible to facilitate navigation to the beginning and end of the pagination. If these always-visible pages fall within the specified range, they are included in the display. If they fall outside the range, the pagination will show additional pages up to the number defined by the range prop. See [here for more details](https://playbook.powerapp.cloud/kits/pagination/react#default). Default is set to '5'