Merge pull request #5 from fhlavac/layout

Set up DataView layout

Author: fhlavac

.gitignore

@@ -1,133 +1,38 @@
-# Logs
-logs
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-lerna-debug.log*
-.pnpm-debug.log*
-
-# Diagnostic reports (https://nodejs.org/api/report.html)
-report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
-
-# Runtime data
-pids
-*.pid
-*.seed
-*.pid.lock
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
+# Javascript builds
+node_modules
+dist
+tsc_out
+.out
+.changelog
+.DS_Store
 coverage
-*.lcov
-
-# nyc test coverage
-.nyc_output
-
-# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# Bower dependency directory (https://bower.io/)
-bower_components
-
-# node-waf configuration
-.lock-wscript
-
-# Compiled binary addons (https://nodejs.org/api/addons.html)
-build/Release
-
-# Dependency directories
-node_modules/
-jspm_packages/
-
-# Snowpack dependency directory (https://snowpack.dev/)
-web_modules/
-
-# TypeScript cache
-*.tsbuildinfo
-
-# Optional npm cache directory
-.npm
-
-# Optional eslint cache
+.cache
+results
+.tmp
 .eslintcache
+generated
 
 # Cypress cache
 .cypress-cache
 
-# Optional stylelint cache
-.stylelintcache
-
-# Microbundle cache
-.rpt2_cache/
-.rts2_cache_cjs/
-.rts2_cache_es/
-.rts2_cache_umd/
-
-# Optional REPL history
-.node_repl_history
-
-# Output of 'npm pack'
-*.tgz
-
-# Yarn Integrity file
-.yarn-integrity
-
-# dotenv environment variable files
-.env
-.env.development.local
-.env.test.local
-.env.production.local
-.env.local
-
-# parcel-bundler cache (https://parceljs.org/)
-.cache
-.parcel-cache
-
-# Next.js build output
-.next
-out
-
-# Nuxt.js build / generate output
-.nuxt
-dist
-
-# Gatsby files
-.cache/
-# Comment in the public line in if your project uses Gatsby and not Next.js
-# https://nextjs.org/blog/next-9-1#public-directory-support
-# public
-
-# vuepress build output
-.vuepress/dist
-
-# vuepress v2.x temp and cache directory
-.temp
-.cache
-
-# Docusaurus cache and generated files
-.docusaurus
-
-# Serverless directories
-.serverless/
-
-# FuseBox cache
-.fusebox/
-
-# DynamoDB Local files
-.dynamodb/
-
-# TernJS port file
-.tern-port
-
-# Stores VSCode versions used for testing VSCode extensions
-.vscode-test
-
-# yarn v2
-.yarn/cache
-.yarn/unplugged
-.yarn/build-state.yml
-.yarn/install-state.gz
-.pnp.*
+# package managers
+lerna-debug.log
+
+# IDEs and editors
+.idea
+.project
+.classpath
+.c9
+*.launch
+.settings
+*.sublime-workspace
+.history
+.vscode
+.yo-rc.json
+
+# IDE - VSCode
+.vscode
+# For vim
+*.swp
+
+public

cypress/component/DataView.cy.tsx

@@ -1,9 +1,29 @@
 import React from 'react';
+import { Pagination } from '@patternfly/react-core';
+import DataView from '../../packages/module/dist/dynamic/DataView';
+import DataViewToolbar from '../../packages/module/dist/esm/DataViewToolbar';
+
+const PAGINATION = {
+  page: 1,
+  perPage: 1
+}
 
 describe('DataView', () => {
-  it('renders data view', () => {
-    cy.mount(<div id="test">Some text</div>);
+  it('renders the data view layout', () => {
+    cy.mount(<DataView><>Data view content</></DataView>)
+    cy.get('[data-ouia-component-id="DataView-stack-item-0"]').contains('Data view content');
+  });
 
-    cy.get('[id="test"]').should('contain', 'Some text');
-  })
-})
+  it('renders the data view with toolbar, data section and footer', () => {
+    cy.mount(
+      <DataView>
+        <DataViewToolbar pagination={<Pagination {...PAGINATION} ouiaId="DataViewToolbar-pagination" />} />
+        <>Data section</>
+        <DataViewToolbar pagination={<Pagination isCompact {...PAGINATION} ouiaId="DataViewFooter-pagination" />} ouiaId="DataViewFooter" />
+      </DataView>
+    );
+    cy.get('[data-ouia-component-id="DataViewToolbar-pagination"]').should('exist');
+    cy.get('[data-ouia-component-id="DataView-stack-item-1"]').contains('Data section');
+    cy.get('[data-ouia-component-id="DataViewFooter-pagination"]').should('exist');
+  });
+});

cypress/component/DataViewToolbar.cy.tsx

@@ -0,0 +1,11 @@
+import React from 'react';
+import { Pagination } from '@patternfly/react-core';
+import DataViewToolbar from '../../packages/module/dist/dynamic/DataViewToolbar';
+
+describe('DataViewToolbar', () => {
+  it('renders the data view toolbar', () => {
+    cy.mount(<DataViewToolbar pagination={<Pagination page={1} perPage={10} ouiaId="DataViewToolbar-pagination" />} />)
+    cy.get('[data-ouia-component-id="DataViewToolbar"]').should('exist');
+    cy.get('[data-ouia-component-id="DataViewToolbar-pagination"]').should('exist');
+  });
+});

cypress/e2e/DataView.spec.cy.ts

@@ -1,6 +1,6 @@
 describe('Test the Data view docs page', () => {
 
-  it('renders the docs', () => {
+  it.skip('renders the docs', () => {
     cy.visit('http://localhost:8006/extensions/data-view/data-view');
   })
 })

package-lock.json

@@ -20,7 +20,8 @@ async function generateIndex(files) {
 
     files.forEach(file => {
       const name = file.replace('/index.ts', '').split('/').pop();
-      stream.write(`\nexport { default as ${name} } from './${name}';\n`);
+      // do not generate default exports for Hooks/
+      name !== 'Hooks' && stream.write(`\nexport { default as ${name} } from './${name}';\n`);
       stream.write(`export * from './${name}';\n`);
     });
     stream.end();

packages/module/generate-index.js

@@ -31,8 +31,9 @@
     "tag": "prerelease"
   },
   "dependencies": {
-    "@patternfly/react-core": "^6.0.0-alpha.50",
+    "@patternfly/react-core": "^6.0.0-alpha.55",
     "@patternfly/react-icons": "^6.0.0-alpha.20",
+    "@patternfly/react-table": "^6.0.0-alpha.55",
     "react-jss": "^10.10.0",
     "clsx": "^2.1.1"
   },

packages/module/package.json

@@ -22,7 +22,8 @@ module.exports = {
     'color-contrast',
     'landmark-no-duplicate-main',
     'landmark-main-is-top-level',
-    'scrollable-region-focusable'
+    'scrollable-region-focusable',
+    'link-in-text-block',
   ].join(','),
   ignoreIncomplete: true
 };

packages/module/patternfly-a11y.config.js

@@ -5,23 +5,32 @@ section: extensions
 subsection: Data view
 # Sidenav secondary level section
 # should be the same for all markdown files
-id: Data view
+id: Data view layout
 # Tab (react | react-demos | html | html-demos | design-guidelines | accessibility)
 source: react
 # If you use typescript, the name of the interface to display props for
 # These are found through the sourceProps function provided in patternfly-docs.source.js
 propComponents: ['DataView']
 sourceLink: https://github.com/patternfly/react-data-view/blob/main/packages/module/patternfly-docs/content/extensions/data-view/examples/DataView/DataView.md
 ---
-
+import { Pagination } from '@patternfly/react-core';
 import DataView from '@patternfly/react-data-view/dist/dynamic/DataView';
+import DataViewToolbar from '@patternfly/react-data-view/dist/dynamic/DataViewToolbar';
 
 The **data view** component renders record data in a configured layout.
 
-### Basic example
+### Layout example
+
+Data view is expected to consist of header, data part and footer stacked below each other and passed as `children`.
+
+```js file="./DataViewLayoutExample.tsx"
+
+```
+
+### Predefined layout components
 
-A blank example of the data view layout.
+You can make use of the predefined layout components to display a default header and footer. See [data view toolbar](/data-view/data-view-toolbar) for more information 
 
-```js file="./DataViewExample.tsx"
+```js file="./DataViewPredefinedLayoutExample.tsx"
 
 ```