@patternfly/documentation-framework 2.0.0-alpha.3 → 2.0.0-alpha.31

package/CHANGELOG.md

@@ -3,6 +3,272 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# 2.0.0-alpha.31 (2023-05-01)
+
+
+### Bug Fixes
+
+* update Text component summary to fix build ([64b3590](https://github.com/patternfly/patternfly-org/commit/64b359029fa14be143ddec212fdf89a3033145d5))
+
+
+
+
+
+# 2.0.0-alpha.30 (2023-04-27)
+
+
+### Bug Fixes
+
+* white space change to test CI ([e9e7ed3](https://github.com/patternfly/patternfly-org/commit/e9e7ed3cf6007fcf022dd7693bfed12bdf9d7e9a))
+
+
+
+
+
+# 2.0.0-alpha.29 (2023-04-26)
+
+
+### Bug Fixes
+
+* sidebar open by default ([#3506](https://github.com/patternfly/patternfly-org/issues/3506)) ([fb5f086](https://github.com/patternfly/patternfly-org/commit/fb5f08611d3edde80a559635b39dab7138f06d1d))
+
+
+
+
+
+# 2.0.0-alpha.28 (2023-04-26)
+
+**Note:** Version bump only for package @patternfly/documentation-framework
+
+
+
+
+
+# 2.0.0-alpha.27 (2023-04-25)
+
+
+### Bug Fixes
+
+* **docs:** Update static dir and fix null loading ([#3505](https://github.com/patternfly/patternfly-org/issues/3505)) ([e65a1b2](https://github.com/patternfly/patternfly-org/commit/e65a1b21ae7671322adcbcef1ada69436fd07802))
+
+
+
+
+
+# 2.0.0-alpha.26 (2023-04-21)
+
+**Note:** Version bump only for package @patternfly/documentation-framework
+
+
+
+
+
+# 2.0.0-alpha.25 (2023-04-19)
+
+**Note:** Version bump only for package @patternfly/documentation-framework
+
+
+
+
+
+# 2.0.0-alpha.24 (2023-04-17)
+
+**Note:** Version bump only for package @patternfly/documentation-framework
+
+
+
+
+
+# 2.0.0-alpha.23 (2023-04-17)
+
+
+### Features
+
+* **docs-framework:** add support for exposing function documentation ([#3485](https://github.com/patternfly/patternfly-org/issues/3485)) ([2f19ded](https://github.com/patternfly/patternfly-org/commit/2f19deda84c75042df1870c0950bb173eb2c3d84))
+
+
+
+
+
+# 2.0.0-alpha.22 (2023-04-17)
+
+**Note:** Version bump only for package @patternfly/documentation-framework
+
+
+
+
+
+# 2.0.0-alpha.21 (2023-04-15)
+
+
+### Bug Fixes
+
+* clean up references to katacoda ([#3491](https://github.com/patternfly/patternfly-org/issues/3491)) ([5de986b](https://github.com/patternfly/patternfly-org/commit/5de986b917ee7edf9c476bb2df2f2ee4d454a7e1))
+
+
+
+
+
+# 2.0.0-alpha.20 (2023-04-14)
+
+**Note:** Version bump only for package @patternfly/documentation-framework
+
+
+
+
+
+# 2.0.0-alpha.19 (2023-04-12)
+
+**Note:** Version bump only for package @patternfly/documentation-framework
+
+
+
+
+
+# 2.0.0-alpha.18 (2023-04-11)
+
+
+### Bug Fixes
+
+* **cssVariables:** Update expandId ([b9b0a6e](https://github.com/patternfly/patternfly-org/commit/b9b0a6edcc103c442f24caae086b68558415be57))
+
+
+
+
+
+# 2.0.0-alpha.17 (2023-04-11)
+
+
+### Bug Fixes
+
+* **docs:** fixes display & search bugs on icons page ([#3483](https://github.com/patternfly/patternfly-org/issues/3483)) ([39b225c](https://github.com/patternfly/patternfly-org/commit/39b225cdcbdc4c01c5002750600708eab6427f60))
+
+
+
+
+
+# 2.0.0-alpha.16 (2023-04-11)
+
+
+### Features
+
+* **tables:** update tables, context selector ([#3474](https://github.com/patternfly/patternfly-org/issues/3474)) ([cd82c35](https://github.com/patternfly/patternfly-org/commit/cd82c356f568f3368bc22319d614fde8dd74fb38))
+
+
+
+
+
+# 2.0.0-alpha.15 (2023-04-06)
+
+**Note:** Version bump only for package @patternfly/documentation-framework
+
+
+
+
+
+# 2.0.0-alpha.14 (2023-04-03)
+
+
+### Bug Fixes
+
+* **Tables:** temporarily comment out tables so Table can be deprecated ([#3468](https://github.com/patternfly/patternfly-org/issues/3468)) ([f4aa5ed](https://github.com/patternfly/patternfly-org/commit/f4aa5ed791161851cdc92d02d0c752eef4028306))
+
+
+
+
+
+# 2.0.0-alpha.13 (2023-03-31)
+
+**Note:** Version bump only for package @patternfly/documentation-framework
+
+
+
+
+
+# 2.0.0-alpha.12 (2023-03-30)
+
+**Note:** Version bump only for package @patternfly/documentation-framework
+
+
+
+
+
+# 2.0.0-alpha.11 (2023-03-29)
+
+**Note:** Version bump only for package @patternfly/documentation-framework
+
+
+
+
+
+# 2.0.0-alpha.10 (2023-03-15)
+
+**Note:** Version bump only for package @patternfly/documentation-framework
+
+
+
+
+
+# 2.0.0-alpha.9 (2023-03-09)
+
+
+### Bug Fixes
+
+* **versions:** fix typo ([a9b8fe2](https://github.com/patternfly/patternfly-org/commit/a9b8fe296a9c28bdd9ada01a80b1653810802ddf))
+
+
+
+
+
+# 2.0.0-alpha.8 (2023-03-03)
+
+
+### Features
+
+* **docs-framework:** add legacy ssl cli option ([#3433](https://github.com/patternfly/patternfly-org/issues/3433)) ([ccb56fb](https://github.com/patternfly/patternfly-org/commit/ccb56fb27026ebe4be5f5166a86cf3c2f995a872))
+
+
+
+
+
+# 2.0.0-alpha.7 (2023-03-01)
+
+**Note:** Version bump only for package @patternfly/documentation-framework
+
+
+
+
+
+# 2.0.0-alpha.6 (2023-03-01)
+
+**Note:** Version bump only for package @patternfly/documentation-framework
+
+
+
+
+
+# 2.0.0-alpha.5 (2023-03-01)
+
+
+### Bug Fixes
+
+* **404 Page:** Removed CardHeaderMain ([#3429](https://github.com/patternfly/patternfly-org/issues/3429)) ([6169fed](https://github.com/patternfly/patternfly-org/commit/6169fedd3dc57b9c206197c498d6cebc559e2a93))
+
+
+
+
+
+# 2.0.0-alpha.4 (2023-02-27)
+
+
+### Bug Fixes
+
+* **README:** small wording change to test build ([45ede1b](https://github.com/patternfly/patternfly-org/commit/45ede1b356392df6982fd5cbf3b3a4d976f54e06))
+
+
+
+
+
 # 2.0.0-alpha.3 (2023-02-13)
 
 

package/app.js

@@ -1,5 +1,5 @@
 import React from 'react';
-import ReactDOM from 'react-dom';
+import { createRoot, hydrateRoot } from 'react-dom/client';
 import { Router, useLocation } from '@reach/router';
 import 'client-styles'; // Webpack replaces this import: patternfly-docs.css.js
 import { SideNavLayout } from '@patternfly/documentation-framework/layouts';
@@ -16,10 +16,10 @@ import './components/sideNav/sideNav.css';
 import './components/topNav/topNav.css';
 import './layouts/sideNavLayout/sideNavLayout.css';
 
-const AppRoute = ({ child, katacodaLayout, title, path }) => {
+const AppRoute = ({ child, title, path }) => {
   const pathname = useLocation().pathname;
   if (typeof window !== 'undefined' && window.gtag) {
-    gtag('config', 'UA-47523816-6', {
+    gtag('config', process.env.googleAnalyticsID, {
       'page_path': pathname,
       'page_title': (title || pathname)
     });
@@ -31,7 +31,7 @@ const AppRoute = ({ child, katacodaLayout, title, path }) => {
   return (
     <React.Fragment>
       {child}
-      {!katacodaLayout && process.env.hasFooter && <Footer />}
+      {process.env.hasFooter && <Footer />}
     </React.Fragment>
   );
 }
@@ -39,18 +39,16 @@ const AppRoute = ({ child, katacodaLayout, title, path }) => {
 const SideNavRouter = () => {
   const pathname = useLocation().pathname.replace(process.env.pathPrefix, '');
   const componentsData = process?.env?.componentsData;
-  const navOpen = !routes[pathname] || !routes[pathname].katacodaLayout;
   return (
-    <SideNavLayout groupedRoutes={groupedRoutes} navOpen={navOpen} >
+    <SideNavLayout groupedRoutes={groupedRoutes} navOpen={true} >
       <Router id="ws-page-content-router">
         {Object.entries(routes)
-          .map(([path, { Component, title, sources, katacodaLayout, id }]) => Component
+          .map(([path, { Component, title, sources, id }]) => Component
             ? <AppRoute
                 key={path}
                 path={path}
                 default={path === '/404'}
                 child={<Component />}
-                katacodaLayout={katacodaLayout}
                 title={title}
               />
             : <AppRoute
@@ -65,7 +63,6 @@ const SideNavRouter = () => {
                     componentsData={componentsData}
                   />
                 }
-                katacodaLayout={katacodaLayout}
                 title={title}
               />
           )
@@ -107,8 +104,12 @@ const isPrerender = process.env.PRERENDER;
 // Don't use ReactDOM in SSR
 if (!isPrerender) {
   function render() {
-    const renderFn = isProd ? ReactDOM.hydrate : ReactDOM.render;
-    renderFn(<App />, document.getElementById('root'));
+    const container = document.getElementById('root');
+    if (isProd) {
+        hydrateRoot(container, <App />);
+    } else {
+        createRoot(container).render(<App />);
+    }
   }
   // On first load, await promise for the current page to avoid flashing a "Loading..." state
   const Component = getAsyncComponent(null);

package/components/cssVariables/cssSearch.js

@@ -1,5 +1,5 @@
 import React from "react";
-import { TextInput } from "@patternfly/react-core";
+import { SearchInput } from "@patternfly/react-core";
 
 export class CSSSearch extends React.Component {
   constructor(props) {
@@ -9,7 +9,7 @@ export class CSSSearch extends React.Component {
     };
   }
 
-  onFilterChange = (_change, event) => {
+  onFilterChange = (event) => {
     this.setState(
       {
         filterValue: event.target.value
@@ -20,8 +20,7 @@ export class CSSSearch extends React.Component {
 
   render() {
     return (
-      <TextInput
-        type="text"
+      <SearchInput
         aria-label="Filter CSS Variables"
         placeholder="Filter CSS Variables"
         value={this.state.filterValue}

package/components/cssVariables/cssVariables.js

@@ -2,11 +2,11 @@ import React from "react";
 import { debounce } from "@patternfly/react-core";
 import {
   Table,
-  TableHeader,
-  TableBody,
-  sortable,
-  SortByDirection,
-  expandable
+  Thead,
+  Th,
+  Tr,
+  Tbody,
+  Td
 } from "@patternfly/react-table";
 import * as tokensModule from "@patternfly/react-tokens/dist/esm/componentIndex";
 import global_spacer_md from "@patternfly/react-tokens/dist/esm/global_spacer_md";
@@ -77,23 +77,10 @@ export class CSSVariables extends React.Component {
 
     this.flatList = flattenList(applicableFiles);
 
-    this.columns = [
-      ...props.hideSelectorColumn ? [] : [{
-         title: "Selector",
-         transforms: [sortable],
-         cellFormatters: [expandable]
-      }],
-      { title: "Variable", transforms: [sortable] },
-      { title: "Value", transforms: [sortable] }
-    ]
-
     this.state = {
       searchRE: '',
       rows: this.getFilteredRows(),
-      sortBy: {
-        index: 0,
-        direction: "asc" // a-z
-      }
+      allRowsExpanded: true
     };
   }
 
@@ -140,20 +127,16 @@ export class CSSVariables extends React.Component {
         ];
         filteredRows.push({
           isOpen: values ? false : undefined,
-          cells
+          cells,
+          details: values ? {
+            parent: rowNumber,
+            fullWidth: true,
+            data: mappingAsList(property, values)
+          } : undefined
         });
         rowNumber += 1;
         if (values) {
-          filteredRows.push({
-            parent: rowNumber,
-            fullWidth: true,
-            cells: [
-              {
-                title: mappingAsList(property, values)
-              }
-            ]
-          });
-          rowNumber += 1;
+          rowNumber += 1
         }
       }
     });
@@ -170,9 +153,10 @@ export class CSSVariables extends React.Component {
     } else {
       newRows[rowKey] = { ...newRows[rowKey], isOpen };
     }
-    this.setState({
+    this.setState(prevState => ({
       rows: newRows,
-    });
+      ...(collapseAll && {allRowsExpanded: !prevState.allRowsExpanded})
+    }));
   };
 
   getDebouncedFilteredRows = debounce(value => {
@@ -183,29 +167,6 @@ export class CSSVariables extends React.Component {
     });
   }, 500);
 
-  onSort = (_event, index, direction) => {
-    this.flatList = this.flatList.sort((a, b) => {
-      const indexToColMap = {
-        '1': 'selector',
-        '2': 'property',
-        '3': 'value'
-      };
-      const column = indexToColMap[index];
-      if (direction === SortByDirection.asc) {
-        return a[column] < b[column] ? -1 : a[column] > b[column] ? 1 : 0;
-      } else {
-        return a[column] > b[column] ? -1 : a[column] < b[column] ? 1 : 0;
-      }
-    });
-    this.setState({
-      sortBy: {
-        index,
-        direction
-      },
-      rows: this.getFilteredRows(this.state.searchRE)
-    });
-  };
-
   render() {
     return (
       <React.Fragment>
@@ -213,19 +174,60 @@ export class CSSVariables extends React.Component {
         <Table
           variant="compact"
           aria-label={`CSS Variables for prefixes ${this.prefix.join(" ")}`}
-          sortBy={this.state.sortBy}
-          onSort={this.onSort}
-          cells={this.columns}
-          rows={this.state.rows}
-          onCollapse={this.onCollapse}
-          canCollapseAll={true}
-          collapseAllAriaLabel="expand all css variables"
-          gridBreakPoint="grid-lg"
-          contentId="css-variables-content"
-          expandId="css-variables-toggle"
         >
-          <TableHeader />
-          <TableBody />
+          <Thead>
+            <Tr>
+              {!this.props.hideSelectorColumn && (
+                <React.Fragment>
+                  <Th expand={{
+                    areAllExpanded: this.state.allRowsExpanded,
+                    collapseAllAriaLabel: "Expand or collapse all CSS variables",
+                    onToggle: this.onCollapse
+                  }}/>
+                  <Th>Selector</Th>
+                </React.Fragment>
+              )}
+              <Th>Variable</Th>
+              <Th>Value</Th>
+            </Tr>
+          </Thead>
+          {!this.props.hideSelectorColumn ? (
+            this.state.rows.map((row, rowIndex) => (
+              <Tbody key={rowIndex} isExpanded={row.isOpen}>
+                <Tr>
+                  <Td
+                    expand={
+                      row.details
+                        ? {
+                          rowIndex,
+                          isExpanded: row.isOpen,
+                          onToggle: this.onCollapse,
+                          expandId: 'css-vars-expandable-toggle'
+                        }
+                        : undefined
+                    }
+                  />
+                  <Td dataLabel="Selector">{row.cells[0]}</Td>
+                  <Td dataLabel="Variable">{row.cells[1]}</Td>
+                  <Td dataLabel="Value">{row.cells[2]}</Td>
+                </Tr>
+                {row.details ? (
+                  <Tr isExpanded={row.isOpen}>
+                    {!row.details.fullWidth ? <Td /> : null}
+                    <Td dataLabel="Selector" colSpan={5}>{row.details.data}</Td>
+                  </Tr>
+                ) : null}
+              </Tbody>
+            ))) : (
+              <Tbody>
+                {this.state.rows.map((row, rowIndex) => (
+                  <Tr key={rowIndex}>
+                    <Td dataLabel="Variable">{row.cells[0]}</Td>
+                    <Td dataLabel="Value">{row.cells[1]}</Td>
+                  </Tr>
+                ))}
+              </Tbody>
+          )}
         </Table>
       </React.Fragment>
     );

package/components/functionsTable/functionsTable.js

@@ -0,0 +1,57 @@
+import React from "react";
+import {
+  Table,
+  Caption,
+  Thead,
+  Tr,
+  Th,
+  Tbody,
+  Td,
+} from "@patternfly/react-table";
+
+export const FunctionsTable = ({ functionDescriptions }) => {
+  const columnNames = {
+    name: "Function name",
+    description: "Description",
+    signature: "Type signature",
+    defaultValues: "Default parameter values",
+  };
+
+  const formatDefaultValues = (parameters) =>
+    parameters.map((param) => `${param.name}: ${param.default}; `);
+
+  return (
+    <Table
+      aria-label="Function documentation table"
+      variant="compact"
+    >
+      <Caption>Table showing documentation for relevant functions</Caption>
+      <Thead>
+        <Tr>
+          <Th>{columnNames.name}</Th>
+          <Th>{columnNames.signature}</Th>
+          <Th>{columnNames.defaultValues}</Th>
+          <Th>{columnNames.description}</Th>
+        </Tr>
+      </Thead>
+      <Tbody>
+        {functionDescriptions.map((functionDescription) => (
+          <Tr key={functionDescription.functionName}>
+            <Td dataLabel={columnNames.name}>
+              {functionDescription.functionName}
+            </Td>
+            <Td dataLabel={columnNames.signature}>
+              {functionDescription.type}
+            </Td>
+            <Td dataLabel={columnNames.defaultValues}>
+              {formatDefaultValues(functionDescription.params)}
+            </Td>
+            <Td dataLabel={columnNames.description}>
+              {functionDescription.description}
+            </Td>
+          </Tr>
+        ))}
+      </Tbody>
+    </Table>
+  );
+};