1.0.1 • Published 12 months ago
lts-packages v1.0.1
LTS Packages
Installation
You can install LTS Packages using npm:
npm install lts-packages
yarn add lts-packages
Usage
import React from 'react';
import {CustomTable} from 'lts-packages';
const columns = [
{ field: 'id', headerName: 'ID', width: 70 },
{ field: 'firstName', headerName: 'First name', width: 130 },
{ field: 'lastName', headerName: 'Last name', width: 130 },
{ field: 'age', headerName: 'Age', type: 'number', width: 90 },
...
];
const rows = [
{ id: 1, firstName: 'John', lastName: 'Doe', age: 35, ... },
{ id: 2, firstName: 'Jane', lastName: 'Doe', age: 45, ... },
...
];
export default function MyDataGrid() {
return (
<div>
<CustomTable
rows={rows}
columns={columns}
pageSize={5}
checkboxSelection
/>
</div>
);
}
API
Here is a list of available props for the CustomTable
component:
Prop name | Type | Default value | Description |
---|---|---|---|
columns | object[] | - | An array of column definitions for the data grid. |
rows | object[] | - | An array of data rows to display in the data grid. |
pageSize | number | 10 | The number of rows to display on each page. |
checkboxSelection | bool | false | Enables checkbox selection to each row. |
autoHeight | bool | true | value indicating whether the height of the table should be adjusted automatically based on its content. |
disableExport | bool | false | value indicating whether exporting functionality should be disabled. |
density | string | compact | A string indicating the density of the table ("compact", "standard", or "comfortable"). |
tableHeader | string | null | A string value representing the header of the table. |
getRowId | function | undefined | A function that returns a string or number used as the row identifier. |
isRowSelectable | function | undefined | A function that takes GridRowParams and returns a boolean indicating whether the row can be selected. |
columnVisibilityModel | { id: string: boolean } | boolean | A dictionary representing the visibility of the columns. |
onSelectionModelChange | function | undefined | A function that is called when the selection model changes. |
onPageSizeChange | function | undefined | A function that is called when the page size changes. |
showMoreActions | boolean | false | A boolean value indicating whether to show more actions. |
selectionModel | array | - | A GridRowSelectionModel array representing the selected rows in the table. |
hiddenFields | array | - | An array of strings representing the filteration fields that should be hidden. |
ActionBarComponent | component | - | A component to render the action bar . |
Troubleshooting
will be added soon :)