@copart/data-grid
v0.1.67
Published
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
Downloads
582
Maintainers
Keywords
Readme
N.B.
Install homebrew, and ASDF for Node versioning.
install:asdf
install:asdf-node
asdf list all nodejs
(To list all versions of Node available.)asdf install
to install the version of Node, mentioned in.tool-versions
file.
Copart MUI Data Grid
Introduction
MUI Data Grid Pro built using React for Copart applications
Props
| Name | Type | Required | Default | Description |
| ----------------------------------------- | ------------------------------------------------ | -------- | ----------- | ------------------------------------------------------------------------------------------------------ |
| columnMetadata | Array | Yes | [] | Column metadata used for the data grid |
| results | Array | Yes | [] | Array of results to be shown in the data grid |
| rowCount | Number | Yes | 0 | Total row count value |
| apiRef | { current: object } | No | {} | The ref object that allows grid manipulation. |
| Can be instantiated with useGridApiRef(). |
| rowHeight | Number | No | 52 | Sets the height in pixel of a row in the grid. |
| checkboxSelection | Boolean | No | false | If true, the grid get a first column with a checkbox |
| that allows to select rows. |
| onRowClick | Function | No | () => {} | Callback fired when a row is clicked. |
| disableRowSelectionOnClick | Boolean | No | false | If true, the selection on click on a row or cell is |
| disabled. |
| density | ('comfortable' | 'compact' | 'standard') | No | standard | Set the density of the grid. |
| loading | boolean | No | false | If true, a loading overlay is displayed. |
| placeholderSearchText | String | No | Search | Placeholder text for the search field |
| onSearch | Function | No | () => {} | Callback fired when the value of search field changes. |
| showToolbar | Boolean | No | false | If true, the toolbar on top of the grid will be shown. |
| hideFooter | Boolean | No | false | If true, the footer component is hidden. |
| pagination | Boolean | No | false | If true, pagination is enabled. |
| pageNumber | Number | No | 0 | Page Number of the current grid data. |
| pageSize | Number | No | 20 | Size of the page (Rows per page) of the current data grid. |
| sortModel | Array<{ field: string, sort?: 'asc' | 'desc' }> | No | [] | Set the sort model of the grid. |
| onSortColumn | Function | No | () => {} | Callback fired when a column is sorted. |
| onPaginationChange | Function | No | () => {} | Callback fired when the pagination model has changed. |
| footerActionsContainer | Function | No | () => <></> | Function that returns a React element for the Footer Actions container (without the pagination). |
| toolbarCustomComponent | Function | No | () => {} | Function that returns a React element for the Toolbar container (without the search field and counts). |
| persistSelectedResults | Boolean | No | false | If true, we will able to persist the selected results across pages and different views and also we can access the list of all the selected results.
| keepNonExistentRowsSelected | Boolean | No | false | If true, the selection model will retain selected rows that do not exist
This is a Next.js project bootstrapped with create-next-app
.
Getting Started
First, run the development server:
npm run start
# or
yarn start
# or
pnpm start
Open http://localhost:5001 with your browser to see the result.
You can start editing the page by modifying pages/index.tsx
. The page auto-updates as you edit the file.
API routes can be accessed on http://localhost:3000/api/hello. This endpoint can be edited in pages/api/hello.ts
.
The pages/api
directory is mapped to /api/*
. Files in this directory are treated as API routes instead of React pages.
This project uses next/font
to automatically optimize and load Inter, a custom Google Font.
Learn More
To learn more about Next.js, take a look at the following resources:
- Next.js Documentation - learn about Next.js features and API.
- Learn Next.js - an interactive Next.js tutorial.
You can check out the Next.js GitHub repository - your feedback and contributions are welcome!
Deploy on Vercel
The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.
Check out our Next.js deployment documentation for more details.