@mulekick/ocr-data-table-plugin
v0.3.0
Published
'Convert a jQuery Library to React' - OpenClassRooms project : design a reusable React plugin
Downloads
7
Readme
How to use the plugin in your react app :
- Install the plugin
npm install --save @mulekick/ocr-data-table-plugin
- Import the component in your react app :
import {DataTable} from "@mulekick/ocr-data-table-plugin";`
- Create the table columns definitions array :
const
// valid column definitions for the table are objects with the following signature :
sampleColumnDefinition = {
// string value that displays as a header for the column :
header: `My column name`,
// data type for values that the column will display, either :
// `string` -> string primitives
// `date` -> Date objects
// `select` -> select input values, ie. objects with the signature { value<string>, label<string>}
dataType: `string`,
// field name (actually object key) of the value that the column will display :
fieldName: `myColumnValue`
},
// the table will be passed an array of column definitions so it displays multiple columns
tableColumnsDefinitions = [
{header: `My Sample Column 1`, dataType: `string`, fieldName: `fieldString`},
{header: `My Sample Column 2`, dataType: `date`, fieldName: `fieldDate`},
{header: `My Sample Column 3`, dataType: `select`, fieldName: `fieldSelect`}
];
- Create the table rows data array :
const
// each entry in the rows data array must match the column definitions to display without errors
tableRowsData = [
{fieldString: `sample value 1`, fieldDate: new Date(`01/01/2022`), fieldSelect: {value: `val1`, label: `select value 1`}},
{fieldString: `sample value 2`, fieldDate: new Date(`01/01/2023`), fieldSelect: {value: `val2`, label: `select value 2`}}
];
- Pass the table columns definitions array and the table rows data array to the component as props :
<DataTable colDefs={tableColumnsDefinitions} data={tableRowsData} />
- Component props :
| Name | Description | Remarks | |---------| ------------------------------------------------ | -------------------------- | | colDefs | array of columns definitions objects (see above) | length must not be zero | | data | array of rows data objects (see above) | length must not be zero |
Create React App customizations :
- use the standard template for create-react-app
npx create-react-app ocr-data-table-plugin
- remove useless dependencies
npm uninstall --save @testing-library/jest-dom @testing-library/react @testing-library/user-event web-vitals react-scripts
- install project dev dependencies
npm install --save-dev @babel/cli @babel/core @babel/preset-env @babel/preset-react @mulekick/eslint-config-muleslint babel-plugin-macros react-scripts sass
- install project dependencies
npm install --save @fortawesome/fontawesome-svg-core @fortawesome/free-solid-svg-icons @fortawesome/react-fontawesome @tanstack/react-table react-select
- update package.json :
- add custom package.json scripts
- remove
eslintConfig
key - remove
browserslist
key - switch to ESM modules use :
"type": "module"
- add informational entries
- add custom
.eslintrc.json
file - add custom
.browserslistrc
file - add babel-related config files (
babel.config.json
and.babel-plugin-macrosrc.json
) - file system cleanup
rm src/setupTests.js src/reportWebVitals.js src/logo.svg src/index.css src/App.test.js src/App.css public/logo* public/manifest.json public/robots.txt
Getting Started with Create React App
This project was bootstrapped with Create React App.
Available Scripts
In the project directory, you can run:
npm start
Runs the app in the development mode.
Open http://localhost:3000 to view it in your browser.
The page will reload when you make changes.
You may also see any lint errors in the console.
npm test
Launches the test runner in the interactive watch mode.
See the section about running tests for more information.
npm run build
Builds the app for production to the build
folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
See the section about deployment for more information.
npm run eject
Note: this is a one-way operation. Once you eject
, you can't go back!
If you aren't satisfied with the build tool and configuration choices, you can eject
at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject
will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.
You don't have to ever use eject
. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.
Learn More
You can learn more in the Create React App documentation.
To learn React, check out the React documentation.
Code Splitting
This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting
Analyzing the Bundle Size
This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size
Making a Progressive Web App
This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app
Advanced Configuration
This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration
Deployment
This section has moved here: https://facebook.github.io/create-react-app/docs/deployment
npm run build
fails to minify
This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify