Members
# constant InventoryList
Component that consumes active filters and passes them down to component.
# constant InventoryTable
This component is used to combine all essential components together: EntityTableToolbar - to control top toolbar. InventoryList - to allow consumers to change data from outside and contains actual inventory table. Pagination - bottom pagination. It also calculates pagination and sortBy from props or from store if consumer passed items or not.
# constant buildOSFilterConfig
TODO: Deprecated, remove once no longer exposed through fed modules
# constant getSelectedOsFilterVersions
Extracts enabled OS filter values from ConditionalFilter-like object
# constant inventoryCache
A helper function to store props and to always return the latest state. For example, EntityTableToolbar wraps OnRefreshData in a callback, so we need this to get the latest props and not the props at the time of when the function is being wrapped in callback.
# constant toGroupSelection
Takes an array of object versions value and returns an object in the format
required by ConditionalFilter component (group filter);
# constant toGroupSelectionValue
TODO: Deprecated, remove once no longer exposed through fed modules
# constant updateURLSearchParams
This module exports functions to work with the URL search parameters. The functions require window.location and window.history to be available.
Methods
# AppInfo(props) → {React.ReactElement}
Small component that just renders active detail with some specific class.
This component detail is accessed from redux if no component found missing component is displayed.
Parameters:
| Name | Type | Description |
|---|---|---|
props |
object
|
Component Props |
componentMapper |
object
|
Enables passing different components list |
activeApp |
object
|
Identifies the active app |
Returns the app information for the active app
React.ReactElement
# AppInfoCmp(props) → {React.ReactElement}
Parameters:
| Name | Type | Description |
|---|---|---|
props |
object
|
Component Props |
- Deprecated:
- Remove once all apps send `componentMapper` and `activeApp` and use directly AppInfo
Returns the app information for the active app
React.ReactElement
# AppInfoWrapper(props) → {React.ReactElement}
Parameters:
| Name | Type | Description |
|---|---|---|
props |
object
|
Component Props |
componentMapper |
object
|
Enables passing different components list |
activeApp |
object
|
Identifies the active app |
- Deprecated:
- This component can be removed once all apps migrate to componentMapper and activeApp
Returns the app information for the active app
React.ReactElement
# ApplicationDetails(props)
Component that renders tabs for each application detail and handles clicking on each item.
Parameters:
| Name | Type | Description |
|---|---|---|
props |
*
|
onTabSelect can be used to notify parent component that detail has been selected. |
# ContextInventoryList(props)
Component that works as a side channel for consumers to notify inventory of new data changes.
Parameters:
| Name | Type | Description |
|---|---|---|
props |
||
showHealth |
||
onRefreshData |
||
ignoreRefresh |
# EntityTable(props)
The actual (PF)table component. It calculates each cell and every table property.
It uses rows, columns and loaded from redux to show correct data.
When row is selected selectEntity is dispatched.
Parameters:
| Name | Type | Description |
|---|---|---|
props |
*
|
all props used in this component. |
# EntityTableToolbar(props)
Table toolbar used at top of inventory table. It uses couple of filters and acces redux data along side all passed props.
Parameters:
| Name | Type | Description |
|---|---|---|
props |
*
|
used in this component. |
# FactsInfo(props)
Basic information about system. UUID and last seen.
Parameters:
| Name | Type | Description |
|---|---|---|
props |
*
|
entity and if entity is loaded. |
# FooterPagination(props)
Bottom pagination used in table. It can remember what page user is on if user entered the page number in input.
Parameters:
| Name | Type | Description |
|---|---|---|
props |
||
total |
||
page |
||
perPage |
||
direction |
||
isFull |
||
hasAccess |
||
paginationProps |
||
onRefreshData |
||
loaded |
||
ouiaId |
# InventoryDetail(props)
Composit component which tangles together Topbar, facts, tags, app details and if system is found or not.
This component is connected to redux and reads loaded and entity.
Parameters:
| Name | Type | Description |
|---|---|---|
props |
*
|
additional features from parent component. |
# NoEntitiesFound(props)
Empty state stable when no systems (or other entities) are found.
Parameters:
| Name | Type | Description |
|---|---|---|
props |
||
entities |
||
onClearAll |
||
showIcon |
# SystemNotFound(props)
Empty state when system was not found in inventory.
Parameters:
| Name | Type | Description |
|---|---|---|
props |
*
|
inventoryId and onBackToListClick. |
# TitleColumn(children, id, item, props)
Helper component to generate first cell in plain inventory either with clickable detail or just data from attribut.
This is later on used in redux in renderFunc.
Parameters:
| Name | Type | Description |
|---|---|---|
children |
React.node
|
React node with information that will be shown to user as column title. |
id |
string
|
inventory UUID, used to navigate to correct URL. |
item |
*
|
row data, holds every information from redux store for currecnt row. |
props |
*
|
additional props passed from |
# TopBar(props)
Top inventory bar with title, buttons (namely remove from inventory and inventory detail button) and actions. Remove from inventory button requires remove modal, which is included at bottom of this component.
Parameters:
| Name | Type | Description |
|---|---|---|
props |
*
|
namely entity and if entity is loaded. |
# groupOSVersions(versions)
TODO: Deprecated, remove once no longer exposed through fed modules
Parameters:
| Name | Type | Description |
|---|---|---|
versions |
# onRowClick(event, key, props, id)
Helper function to proprly calculate what to do when user clicks on first cell.
Either full redirect if used with ctrl button or onRowClick from props is used.
Parameters:
| Name | Type | Description |
|---|---|---|
event |
*
|
html event, to find out if meta key was clicked. |
key |
*
|
inventory UUID. |
props |
*
|
additional props from |
id |
# useExportDownloadCheck(optionsopt) → {function}
A hook to periodically check for an available download for an export
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
options |
object
|
<optional> |
Options |
onDownloadAvailable |
object
|
<optional> |
Callback function, called when the requested export is available to download |
onError |
object
|
<optional> |
Callback function, called when the requested export failed or an error occured |
Function to set an export ID to check for
function
# useInventoryExport(optionsopt) → {object|function}
A hook encapsulating functionality to provide an export configuration for the InventoryTable to request an export.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
options |
object
|
<optional> |
Options |
filters |
object
|
<optional> |
(unused) Filters currently active in the InventoryTable and passed along to the export request |
[exportConfig] An object to pass to exportConfig
object
[exportConfig.onSelect] onSelect callback for the exportConfig called when a export format is selected
function