Methods
# inner ActionWrapper(props) → {React.ReactElement}
This is a wrapper call inside the renderCell function for the action column
Parameters:
| Name | Type | Description |
|---|---|---|
props |
object
|
|
actions |
Array.<ActionItem>
|
The actions to render |
params |
object
|
The params from the grid |
muiGridColumn |
object
|
The column used by the MUIGrid component |
React.ReactElement
# inner addActionButtonRendering(muiGridColumn, actionData)
This takes a mui column and adds formatting to it to handle action button fields
Parameters:
| Name | Type | Description |
|---|---|---|
muiGridColumn |
object
|
The column used by the MUIGrid component |
actionData |
ActionData
|
The action data from the layout |
# inner addExpandableRendering(muiGridColumn)
Wraps the value in a component which determines if a tooltip should be displayed
Parameters:
| Name | Type | Description |
|---|---|---|
muiGridColumn |
object
|
The column used by the MUIGrid component |
# inner addExternalLinkRendering(muiGridColumn) → {React.ReactElement}
This is our default renderer function for external links
Parameters:
| Name | Type | Description |
|---|---|---|
muiGridColumn |
Object
|
The column to render |
React.ReactElement
# inner getBaseAction(action) → {Object}
Returns a base action object
Parameters:
| Name | Type | Description |
|---|---|---|
action |
Object
|
the action |
label |
string
|
the label for the action |
actionList |
Array.<ActionItem>
|
the list of actions |
- the base action object
Object
# inner GridActions(props) → {React.ReactElement}
This is our default renderer function for grid actions
Parameters:
| Name | Type | Description |
|---|---|---|
props |
Object
|
|
actions |
Array.<ActionItem>
|
The actions to render |
params |
Object
|
The params from the grid |
themeGroup |
Object
|
The theme group to use for the grid actions |
useTypeVariant |
Boolean
|
If true then use the type to determine the variant |
React.ReactElement
# inner GridLink(props) → {React.ReactElement}
Parameters:
| Name | Type | Description |
|---|---|---|
props |
object
|
The props |
params |
GridLinkParams
|
The params from the grid |
muiGridColumn |
object
|
The column used by the MUIGrid component |
- The link cell wrapper
React.ReactElement
# inner LinkCellWrapper(props) → {React.ReactElement}
This takes a mui column and adds formatting to it to handle external link fields
Parameters:
| Name | Type | Description |
|---|---|---|
props |
object
|
The props |
params |
object
|
The params from the grid |
muiGridColumn |
object
|
The column used by the MUIGrid component |
- The link cell wrapper
React.ReactElement
# inner PamLayoutGrid(props)
Primary UI component for user interaction
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
props |
Object
|
The props for the component | |
data |
Object
|
The data for the grid | |
layout |
Object
|
The layout for the grid | |
initialSortColumn |
String
|
<optional> |
The initial sort column for the grid |
initialSortDirection |
String
|
<optional> |
The initial sort direction for the grid |
showToolbar |
Boolean
|
<optional> |
Whether to show the toolbar |
extraGridProps |
Object
|
<optional> |
Any extra props to pass to the grid. Ideal for tinkering with toolbar options |
actions |
Array
|
<optional> |
The actions column for the grid |
themeGroup |
Object
|
<optional> |
The theme group for the grid use this to override the default theme group found in "pamGrid" of muiTheme.js |
actionsComponent |
Object
|
<optional> |
The component to use for the actions column |
linkComponent |
Object
|
<optional> |
The component to use for the link column |
useTypeVariant |
Boolean
|
<optional> |
Whether to use the type variant for the grid |
initialRowCount |
Number
|
<optional> |
The initial row count for the grid |
rowsPerPageOptions |
Array
|
<optional> |
The rows per page options for the grid |
Type Definitions
Object
# ActionData
Properties:
| Name | Type | Description |
|---|---|---|
actionList |
Array.<ActionItem>
|
The list of actions |
Object
# ActionItem
Properties:
| Name | Type | Description |
|---|---|---|
label |
string
|
The label for the action |
type |
string
|
The type of action |
cssClass |
string
|
The css class to add to the action |
order |
number
|
The order to display the action |
clickHandler |
function
|
The click handler for the action |
actionProps |
object
|
Any extra props to pass to the action component |
# GridLinkParams
Properties:
| Name | Type | Description |
|---|---|---|
value |
string
|
object
|
the value of the cell |
url |
string
|
the url of the cell |
label |
string
|
the label of the cell |