@patternfly/react-table 5.0.0-prerelease.7 → 5.0.0-prerelease.9

package/README.md

@@ -1,18 +1,18 @@
 # @patternfly/react-table
 
-This package provides Table PatternFly components based on [PatternFly 4][patternfly-4]
+This package provides Table PatternFly components based on [PatternFly][patternfly]
 
 ### Prerequisite
 
-#### Node Environment
+#### Node environment
 
 This project currently supports Node [Active LTS](https://github.com/nodejs/Release#release-schedule) releases. Please stay current with Node Active LTS when developing patternfly-react.
 
-For example, to develop with Node 8, use the following:
+For example, to develop with Node 18, use the following:
 
 ```
-nvm install 8
-nvm use 8
+nvm install 18
+nvm use 18
 ```
 
 This project also requires a Yarn version of >=1.6.0. The latest version can be installed [here](https://yarnpkg.com/).
@@ -31,40 +31,50 @@ npm install @patternfly/react-table --save
 
 ## Usage
 
-It's strongly advised to use the PatternFly Base CSS in your whole project, or some components may diverge in appearance:
+It's strongly advised to use the PatternFly base CSS in your whole project, or some components may diverge in appearance:
 
 ```js
 import '@patternfly/react-core/dist/styles/base.css';
 ```
 
-#### Example Component Usage
+#### Example component usage
 
 ```js
-import { Table, TableHeader, TableBody } from '@patternfly/react-table';
-
-class SimpleTable extends React.Component {
-  constructor(props) {
-    super(props);
-    this.state = {
-      columns: [
-        { title: 'Repositories', props: null },
-        'Branches',
-        { title: 'Pull requests', props: null },
-        'Workspaces',
-        'Last Commit'
-      ],
-      rows: [['one', 'two', 'three', 'four', 'five']]
-    };
-  }
-  render() {
-    const { columns, rows } = this.state;
-    return (
-      <Table caption="Simple Table" rows={rows} cells={columns}>
-        <TableHeader />
-        <TableBody />
-      </Table>
-    );
-  }
+import { Table, Thead, Tr, Th, Td, Tbody } from '@patternfly/react-table';
+
+export const ComposableTableBasic = () => {
+  const repositories = [
+    { name: 'one', branches: 'two', prs: 'three' },
+    { name: 'one - 2', branches: null, prs: null },
+    { name: 'one - 3', branches: 'two - 3', prs: 'three - 3' }
+  ];
+
+  const columnNames = {
+    name: 'Repositories',
+    branches: 'Branches',
+    prs: 'Pull requests'
+  };
+  
+  return (
+    <Table>
+      <Thead>
+        <Tr>
+          <Th>{columnNames.name}</Th>
+          <Th>{columnNames.branches}</Th>
+          <Th>{columnNames.prs}</Th>
+        </Tr>
+      </Thead>
+      <Tbody>
+        {repositories.map(repo => (
+          <Tr key={repo.name}>
+            <Td dataLabel={columnNames.name}>{repo.name}</Td>
+            <Td dataLabel={columnNames.branches}>{repo.branches}</Td>
+            <Td dataLabel={columnNames.prs}>{repo.prs}</Td>
+          </Tr>
+        ))}
+      </Tbody>
+    </Table>
+  );
 }
 export default SimpleTable;
 ```
@@ -73,68 +83,19 @@ export default SimpleTable;
 
 This library makes use of the babel plugin from [@patternfly/react-styles](../react-styles/README.md) to enable providing the CSS alongside the components. This removes the need for consumers to use (style|css|sass)-loaders. For an example of using CSS from core you can reference [Button.js](./src/components/Button/Button.js). For any CSS not provided by core please use the `StyleSheet.create` utility from [@patternfly/react-styles](../react-styles/README.md). This will prevent collisions with any consumers, and allow the CSS to be bundled with the component.
 
-### Custom transformators
-
-If you want to add custom transformators to show some special column (collapsible, checkbox) you have to include `isVisible` there as well so cellRenderer knows which cells to render (main purpose is for colSpan).
-
-Example of such transformator can be:
-
-```jsx
-function someTransform(value) {
-  return {
-    isVisible: true,
-    children: <div>cell</div>
-  }
-}
-```
-
-If you want to add this transformer as default cell (first, last, any,...) for each row you also want to change function `calculateColumns`in [HeaderUtils.js](src/components/Table/utils/HeaderUtils.js).
-
-Notice: Any data provided as cell will be visible by default, no need to add `isVisible` if you want to change how data are displayed.
-
 ### Documentation
 
-This project uses Gatsby. For an overview of the project structure please refer to the [Gatsby documentation - Building with Components](https://www.gatsbyjs.org/docs/building-with-components/).
-
-A comprehensive list of components and detailed usage of each can be found on the [PatternFly React Docs][docs] website
-You can also find how each component is meant to be used from a design perspective on the [PatternFly 4 Core][patternfly-4] website.
+A comprehensive list of components and detailed usage of each can be found on the [PatternFly react docs][docs] website
+You can also find how each component is meant to be used from a design perspective on the [PatternFly core][patternfly] website.
 
 Note: All commands below assume you are on the root directory in this repository.
 
-### Install
+### Install & run locally
 
-Run to install all the dependencies
+Run to install all the dependencies, build and run the site locally.
 
 ```sh
-yarn && yarn bootstrap && yarn build && yarn build:docs
-```
-
-### Building
-
-```sh
-yarn bootstrap && yarn build && yarn build:docs
-```
-
-### Running
-
-To start the site locally.
-
-```sh
-yarn build && yarn start:pf4
-```
-
-### Building
-
-To build the site.
-
-```sh
-yarn build:docs
-```
-
-### Building
-
-```
-yarn build
+yarn install && yarn start
 ```
 
 ### Testing
@@ -145,5 +106,5 @@ Testing is done at the root of this repo. To only run the @patternfly/react-tabl
 yarn test packages/react-table
 ```
 
-[patternfly-4]: https://github.com/patternfly/patternfly-next
+[patternfly]: https://github.com/patternfly/patternfly
 [docs]: https://patternfly-react-main.surge.sh

package/components/package.json

@@ -1 +1 @@
-{"name":"@patternfly/react-table-components-esm","main":"index.js","module":"./components/index.js","typings":"index.d.ts","version":"5.0.0-prerelease.6"}
+{"name":"@patternfly/react-table-components","main":"../dist/js/components/index.js","module":"../dist/esm/components/index.js","typings":"../dist/esm/components/index.d.ts","version":"5.0.0-prerelease.8"}

package/deprecated/package.json

@@ -1 +1 @@
-{"name":"@patternfly/react-table-deprecated-deprecated-esm","main":"index.js","module":"./deprecated/index.js","typings":"index.d.ts","version":"5.0.0-prerelease.6"}
+{"name":"@patternfly/react-table-deprecated","main":"../dist/js/deprecated/index.js","module":"../dist/esm/deprecated/index.js","typings":"../dist/esm/deprecated/index.d.ts","version":"5.0.0-prerelease.8"}

package/dist/js/components/Table/package.json

@@ -1 +1 @@
-{"name":"@patternfly/react-table-table-cjs","main":"index.js","module":"./dist/js/components/Table/index.js","typings":"index.d.ts","version":"5.0.0-prerelease.6"}
+{"name":"@patternfly/react-table-table-cjs","main":"index.js","module":"./dist/js/components/Table/index.js","typings":"index.d.ts","version":"5.0.0-prerelease.8"}

package/dist/js/components/Table/utils/decorators/package.json

@@ -1 +1 @@
-{"name":"@patternfly/react-table-decorators-cjs","main":"index.js","module":"./dist/js/components/Table/utils/decorators/index.js","typings":"index.d.ts","version":"5.0.0-prerelease.6"}
+{"name":"@patternfly/react-table-decorators-cjs","main":"index.js","module":"./dist/js/components/Table/utils/decorators/index.js","typings":"index.d.ts","version":"5.0.0-prerelease.8"}

package/dist/js/components/Table/utils/package.json

@@ -1 +1 @@
-{"name":"@patternfly/react-table-utils-cjs","main":"index.js","module":"./dist/js/components/Table/utils/index.js","typings":"index.d.ts","version":"5.0.0-prerelease.6"}
+{"name":"@patternfly/react-table-utils-cjs","main":"index.js","module":"./dist/js/components/Table/utils/index.js","typings":"index.d.ts","version":"5.0.0-prerelease.8"}

package/dist/js/components/package.json

@@ -1 +1 @@
-{"name":"@patternfly/react-table-components-cjs","main":"index.js","module":"./dist/js/components/index.js","typings":"index.d.ts","version":"5.0.0-prerelease.6"}
+{"name":"@patternfly/react-table-components-cjs","main":"index.js","module":"./dist/js/components/index.js","typings":"index.d.ts","version":"5.0.0-prerelease.8"}

package/dist/js/deprecated/components/Table/base/package.json

@@ -1 +1 @@
-{"name":"@patternfly/react-table-base-deprecated-cjs","main":"index.js","module":"./dist/js/deprecated/components/Table/base/index.js","typings":"index.d.ts","version":"5.0.0-prerelease.6"}
+{"name":"@patternfly/react-table-base-deprecated-cjs","main":"index.js","module":"./dist/js/deprecated/components/Table/base/index.js","typings":"index.d.ts","version":"5.0.0-prerelease.8"}

package/dist/js/deprecated/components/Table/package.json

@@ -1 +1 @@
-{"name":"@patternfly/react-table-table-deprecated-cjs","main":"index.js","module":"./dist/js/deprecated/components/Table/index.js","typings":"index.d.ts","version":"5.0.0-prerelease.6"}
+{"name":"@patternfly/react-table-table-deprecated-cjs","main":"index.js","module":"./dist/js/deprecated/components/Table/index.js","typings":"index.d.ts","version":"5.0.0-prerelease.8"}

package/dist/js/deprecated/components/package.json

@@ -1 +1 @@
-{"name":"@patternfly/react-table-components-deprecated-cjs","main":"index.js","module":"./dist/js/deprecated/components/index.js","typings":"index.d.ts","version":"5.0.0-prerelease.6"}
+{"name":"@patternfly/react-table-components-deprecated-cjs","main":"index.js","module":"./dist/js/deprecated/components/index.js","typings":"index.d.ts","version":"5.0.0-prerelease.8"}

package/dist/js/deprecated/package.json

@@ -1 +1 @@
-{"name":"@patternfly/react-table-deprecated-deprecated-cjs","main":"index.js","module":"./dist/js/deprecated/index.js","typings":"index.d.ts","version":"5.0.0-prerelease.6"}
+{"name":"@patternfly/react-table-deprecated-deprecated-cjs","main":"index.js","module":"./dist/js/deprecated/index.js","typings":"index.d.ts","version":"5.0.0-prerelease.8"}

package/dist/js/package.json

@@ -1 +1 @@
-{"name":"@patternfly/react-table-js-cjs","main":"index.js","module":"./dist/js/index.js","typings":"index.d.ts","version":"5.0.0-prerelease.6"}
+{"name":"@patternfly/react-table-js-cjs","main":"index.js","module":"./dist/js/index.js","typings":"index.d.ts","version":"5.0.0-prerelease.8"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@patternfly/react-table",
-  "version": "5.0.0-prerelease.7",
+  "version": "5.0.0-prerelease.9",
   "description": "This library provides a set of React table components for use with the PatternFly 4",
   "main": "dist/js/index.js",
   "module": "dist/esm/index.js",
@@ -36,14 +36,14 @@
   "scripts": {
     "build:umd": "rollup -c --environment IS_PRODUCTION",
     "build:single:packages": "node ../../scripts/build-single-packages.js --config single-packages.config.json",
-    "clean": "rimraf dist",
-    "subpaths": "node scripts/createSubpaths.js"
+    "clean": "rimraf dist components deprecated",
+    "subpaths": "node ../../scripts/exportSubpaths.js --config subpaths.config.json"
   },
   "dependencies": {
-    "@patternfly/react-core": "^5.0.0-prerelease.7",
-    "@patternfly/react-icons": "^5.0.0-prerelease.3",
-    "@patternfly/react-styles": "^5.0.0-prerelease.2",
-    "@patternfly/react-tokens": "^5.0.0-prerelease.2",
+    "@patternfly/react-core": "^5.0.0-prerelease.9",
+    "@patternfly/react-icons": "^5.0.0-prerelease.4",
+    "@patternfly/react-styles": "^5.0.0-prerelease.3",
+    "@patternfly/react-tokens": "^5.0.0-prerelease.3",
     "lodash": "^4.17.19",
     "tslib": "^2.5.0"
   },
@@ -55,5 +55,5 @@
     "react": "^17 || ^18",
     "react-dom": "^17 || ^18"
   },
-  "gitHead": "2af9b12f0dac6c5d71dcdadafcbf535da8d3c68b"
+  "gitHead": "719eebba5d65e5bc2c7075a4ff5057276c62f0c0"
 }

package/src/deprecated/components/Table/examples/Table.md

@@ -4,6 +4,7 @@ cssPrefix: pf-c-table
 section: components
 propComponents: ['Table', 'TableHeader', 'TableBody', 'ISortBy']
 ouia: true
+deprecated: true
 ---
 
 Note: Table lives in its own package at [@patternfly/react-table](https://www.npmjs.com/package/@patternfly/react-table)!

package/subpaths.config.json

@@ -0,0 +1,4 @@
+{
+  "packageName": "@patternfly/react-table",
+  "paths": ["deprecated", "components"]
+}

package/components/index.d.ts

@@ -1,2 +0,0 @@
-export * from '../dist/esm/components/Table';
-//# sourceMappingURL=index.d.ts.map

package/components/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/components/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC"}

package/components/index.js

@@ -1,2 +0,0 @@
-export * from '../dist/esm/components/Table';
-//# sourceMappingURL=index.js.map

package/components/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/components/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC"}

package/deprecated/index.d.ts

@@ -1,2 +0,0 @@
-export * from '../dist/esm/deprecated/components';
-//# sourceMappingURL=index.d.ts.map

package/deprecated/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/deprecated/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC"}

package/deprecated/index.js

@@ -1,2 +0,0 @@
-export * from '../dist/esm/deprecated/components';
-//# sourceMappingURL=index.js.map

package/deprecated/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/deprecated/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC"}

package/scripts/createSubpaths.js

@@ -1,32 +0,0 @@
-/**
- * Re-export subpath modules into the package root directory for ease of access.
- */
-const { readdirSync, readFileSync, writeFileSync, mkdirSync } = require('fs');
-const { resolve, join } = require('path');
-
-const isIndex = (fileName) => fileName.match(/^index\./);
-
-const updatePaths = (filePath, subPathName) => {
-  const contents = readFileSync(filePath, { encoding: 'utf8' });
-  if (filePath.includes('.map')) {
-    return contents.replaceAll('../../../', `../`);
-  } else {
-    return contents.replaceAll('./', `../dist/esm/${subPathName}/`);
-  }
-};
-
-['deprecated', 'components'].forEach((subPathName) => {
-  const distPath = resolve(__dirname, `../dist/esm/${subPathName}`);
-  const distFileNames = readdirSync(distPath);
-  const distIndexFileNames = distFileNames.filter((fileName) => isIndex(fileName));
-  
-  const destinationDir = resolve(__dirname, `../${subPathName}`);
-  mkdirSync(destinationDir, { recursive: true });
-
-  distIndexFileNames.forEach((fileName) => {
-    const filePath = join(__dirname, '../dist/esm', subPathName, fileName);
-    const newFileContent = updatePaths(filePath, subPathName);
-    const fileDestination = join(destinationDir, fileName);
-    writeFileSync(fileDestination, newFileContent);
-  });
-});