Members

# constant filtersSerialiser

Takes an AsyncTableToolsTable state and transforms it into a Compliance scoped search filter parameter

Tutorials:

Using the Compliance `filterSerialiser`

View Source PresentationalComponents/ComplianceTable/serialisers.js, line 51

# constant sortSerialiser

Returns a string consumable by the Compliance API as a "sort_by" parameter for a given column and direction For columns to be sortable they need to have a "sortable" prop, which corresponds to the field name in the Compliance API

View Source PresentationalComponents/ComplianceTable/serialisers.js, line 93

Example

Example of a column with an sortable property

 const columns = [
    {
      title: 'Name',
      sortable: 'name' // Corresponds to the attribute/field to sort by in the API
    }
 ];

Methods

# AsyncTableToolsTable(props) → {React.ReactElement}

This component is a wrapper around the Patternfly Table component(s), the FEC PrimaryToolbar and combines them with the useAsyncTableTools hook

Parameters:

Name	Type	Attributes	Description
`props`	`object`		Component Props
`items`	`Array`		An array or (async) function that returns an array of items to render or an async function to call with the tableState and serialised table state
`columns`	`Array`		An array of column objects to render items with
`filters`	`Array`	<optional>	an array of filters
`total`	`Array`	<optional>	Number of total items available
`loading`	`boolean`	<optional>	Custom loading condition
`options`	`object`	<optional>	An object of options that will be passed along to the `useAsyncTableTools` hook
`toolbarProps`	`object`	<optional>	Props to be passed on the `PrimaryToolbar` component
`tableHeaderProps`	`object`	<optional>	Props to be passed on the TableHeader component
`tableBodyProps`	`object`	<optional>	Props to be passed on the TableBody component
`tableToolbarProps`	`object`	<optional>	Props to be passed on the TableToolbar (bottom toolbar) component
`paginationProps`	`object`	<optional>	Props to be passed on the Pagination component

Tutorials:

Using Async Table Tools

View Source Frameworks/AsyncTableTools/components/AsyncTableToolsTable/AsyncTableToolsTable.js, line 37

Returns:

Returns a PrimaryToolbar component, a Patternfly (v4) Table component and a TableToolbarComponent wrapped together

Type: React.ReactElement

# ComplianceRoute(props) → {React.ReactElement}

This is component renders "routes" in Routes.js

Parameters:

Name	Type	Description
`props`	`object`	Component props
`component`	`React.ReactElement`	Component to render
`title`	`string`	Title to set as browser title
`path`	`string`	Path of the route
`requiredPermissions`	`Array`	An array of RBAC permissions required to render the component
`props`	`object`	Props for the component to render

View Source PresentationalComponents/ComplianceRoute/ComplianceRoute.js, line 23

Returns:

Returns the component for this route

Type: React.ReactElement

# ComplianceTable(props) → {React.ReactElement}

This component serves as a place to either use the non-async TableTools or the AsyncTableTools And allow preparing the AsyncTableToolsTable props/options common across tables in Compliance

Parameters:

Name	Type	Description
`props`	`object`	Component props

View Source PresentationalComponents/ComplianceTable/ComplianceTable.js, line 21

Returns:

Returns either a Async table

Type: React.ReactElement

# DeleteReport() → {React.Element}

DeleteReport Component

Renders the modal for deleting a report. It provides buttons for confirming or canceling the deletion.

View Source SmartComponents/DeleteReport/DeleteReport.js, line 17

Returns:

The rendered DeleteReport component.

Type: React.Element

# LinkWithPermission(props) → {React.ReactElement}

Component to render a InsightsLink if required permissions are met or render a disabled link with tooltip if not.

Parameters:

Name	Type	Attributes	Description
`props`	`object`		Component props
`to`	`string` \| `object`		ReactRouter to prop, which will be used to determine the required permissions for this path
`Component`	`React.ReactElement`	<optional>	Alternative "Link" component to render
`componentProps`	`object`	<optional>	Additional props for the Link component
`children`	`React.ReactElement`		Component children

View Source PresentationalComponents/LinkWithPermission/LinkWithPermission.js, line 27

Returns:

Component

Type: React.ReactElement

# RulesTable(propsopt) → {React.ReactElement}

A component to show rules of a policy or test result.

Parameters:

Name	Type	Attributes	Description
`props`	`object`	<optional>	React component props
`columns`	`Array`		A set of RulesTable columns
`rules`	`Array`	<optional>	A set of rules (for the current page to show)
`total`	`number`	<optional>	The overall total number of rules available to go through
`ruleTree`	`object`	<optional>	A table tree to show the rules in. If provided it will enable the "table view" toggle
`policyId`	`string`	<optional>	A policy ID used for remediations and as profile for rules
`policyName`	`string`	<optional>	A policy name used in the profile of rule items
`reportTestResult`	`object`	<optional>	A report test result used for the remediatons button
`remediationsEnabled`	`boolean`	<optional>	Enables the "RemediationButton"
`ansibleSupportFilter`	`boolean`	<optional>	Enables the ansible filter
`selectedFilter`	`boolean`	<optional>	Enables the "Selected Only" filter
`selectedRules`	`Array`	<optional>	An array of rule IDs currently selected
`preselected`	`Array`	<optional>	An array of rule IDs set as initial selection
`hidePassed`	`boolean`	<optional>	Enables a default filter to only show failed rules.
`options`	`object`	<optional>	AsyncTableTools options
`activeFiltersPassed`	`boolean`	<optional>	Enable Default filter
`activeFilters`	`string`	<optional>	Default filter
`ruleValues`	`object`	<optional>	An object of values to show for certain rule values
`valueDefinitions`	`Array`	<optional>	An array of value definitons available for rules in the table
`skipValueDefinitions`	`boolean`	<optional>	TODO
`onRuleValueReset`	`function`	<optional>	A function called when a rule value is reset
`DedicatedAction`	`React.ReactElement`	<optional>	A dedicated action to show in the table
`valueOverrides`	`object`	<optional>	An object of rule values // TODO we should make the name of this more consistent
`onValueOverrideSave`	`function`	<optional>	A funciton called when a value is saved
`onSelect`	`function`	<optional>	A function called when a selection action is performed
`defaultTableView`	`string`	<optional>	A table view to show by default ("row" or "tree") // TODO we should use the table options directly

View Source PresentationalComponents/RulesTable/RulesTable.js, line 46

Returns:

Type: React.ReactElement

# TableStateProvider(propsopt) → {React.ReactElement}

This component provides a context for components/hooks that want to use async tables and access it's state to perform API requests

Parameters:

Name	Type	Attributes	Description
`props`	`object`	<optional>	Component Props
`children`	`React.ReactElement`	<optional>	Child components to render within

Tutorials:

Using Async Table Tools

View Source Frameworks/AsyncTableTools/components/TableStateProvider/TableStateProvider.js, line 19

Returns:

The passed in component wrapped in a TableContext provider

Type: React.ReactElement

# TailoringTab(propsopt) → {React.ReactElement}

This component is used to show either the tailorings with rules of a specific policy, or the rules of a specific security guide and it's rules for a set of minor OS versions

Parameters:

Name	Type	Attributes	Description
`props`	`object`	<optional>	React component props
`policy`	`object`	<optional>	A policy object from the API
`policy.id`	`string`	<optional>	The id used to fetch
`tailoring`	`object`	<optional>	A tailoring object from the API
`tailoring.id`	`string`	<optional>	A tailorings ID used to fetch the associated rules, rule groups, and value definitions for
`securityGuideId`	`string`	<optional>	The ID for a security guide that the profile should be queried with
`profileId`	`string`	<optional>	The ID for a specific profile the rules should fetched for
`osMajorVersion`	`string`	<optional>	A specific major OS version the profile should be queried with
`osMinorVersion`	`string`	<optional>	A specific minor OS versions that the profile should be for
`columns`	`Array`	<optional>	A set of RulesTable columns the table should show
`enableSecurityGuideRulesToggle`	`boolean`	<optional>	This enabled the "Selected Only" toggle to appear and allows fetching the security guide rule set for the matching profile
`systemCount`		<optional>
`rulesPageLink`		<optional>
`rulesTableProps`	`object`		React component props to be passed on to the RulesTable component in the tab
`resetLink`
`setRuleValues`	`function`	<optional>	A callback called when a custom rule value is saved
`onRuleValueReset`	`function`	<optional>	A callback called when values for a rule are reset
`onValueOverrideSave`	`function`	<optional>	deprecated We should be using setRuleValues instead
`onSelect`	`function`	<optional>	A callback called when a selection is made
`selected`	`object`	<optional>	An array of currently selected IDs
`preselected`	`object`	<optional>	An array of rule IDs to select
`skipProfile`	`string`	<optional>
`additionalRules`		<optional>
`valueOverrides`		<optional>
`showResetButton`		<optional>	Enables reset rules button

Tutorials:

How to use Tailorings

View Source PresentationalComponents/Tailorings/components/TailoringTab.js, line 50

Returns:

Type: React.ReactElement

# Tailorings(propsopt) → {React.ReactElement}

This component is used to show either a specific policy an it's tailorings, or a specific security guide and specific profiles, or a specific policy with it's existing tailorings and the default ruleset from the security guide for a specified set of minor OS versions.

Parameters:

Name	Type	Attributes	Description
`props`	`object`	<optional>	React component props
`policy`	`object`	<optional>	A policy object from the API
`policy.id`	`string`	<optional>	The id used to fetch the tailorings associated with it
`profiles`	`string`	<optional>	An array of objects containing osMajorVersion, osMinorVersion, securityGuideId, profileId props for showing additional tabs.
`defaultTab`	`string`	<optional>	TODO
`columns`	`Array`	<optional>	An array of RulesTable columns
`level`	`number`	<optional>	Sets the level of the tab in the URL anchor
`ouiaId`	`string`	<optional>	OuiaId to pass to the PatternFly Table
`onValueOverrideSave`	`function`	<optional>	Callback function called when a value of a rule is saved
`onSelect`	`function`	<optional>	Callback function called when any selection is made
`selected`	`object`	<optional>
`preselected`	`object`	<optional>	An object containing the preselection of rules for each tab
`enableSecurityGuideRulesToggle`	`boolean`	<optional>	Will enable the "Only Selected" toggle. When a policy with tailorings is shown and the toggle is enabled it will request rule data from the tailoring, with it disabled it will load rule data from the security guide. If a profile is provided it will load rules either from the profile, if the toggle is enabled, otherwise from the security guide.
`selectedVersionCounts`	`object`	<optional>	An object containing minor version as a key and count as a value. Helps to render the system count badge in tab headers.
`valueOverrides`	`object`	<optional>
`rulesPageLink`		<optional>
`skipProfile`
`additionalRules`
`showResetButton`		<optional>	Enables reset rules button

Tutorials:

How to use Tailorings

View Source PresentationalComponents/Tailorings/Tailorings.js, line 49

Returns:

Type: React.ReactElement

# WithPermission(props) → {React.ReactElement}

Wrapper component to either render a component if required permissions are met, Show the NotAuthorized page, or do not render the component at all

Parameters:

Name	Type	Description
`props`	`object`	Component props
`children`	`React.ReactElement`	Component to render
`requiredPermissions`	`Array`	An array of RBAC permissions required to render the component
`hide`	`boolean`	Boolean to set wether or not to hide the component if required permissions are NOT met

View Source PresentationalComponents/WithPermission/WithPermission.js, line 21

Returns:

Returns the component for this route

Type: React.ReactElement

# indexRunner() → {function}

This function is used to assign the correct rowIndex for rows and for their details rows' parent prop

View Source Frameworks/AsyncTableTools/hooks/useTableView/views/helpers.js, line 41

Returns:

A function to call whenever a row is added, it returns an integer that can optionally be used.

Type: function

# rowsBuilder(items, columns, optionsopt) → {object}

A function to compile a list of items and passed columns into rows for the Patternfly (v4) Table component within a tableProps object.

Parameters:

Name	Type	Attributes	Description
`items`	`Array`		An array of items to render
`columns`	`Array`		An array of columns to render the rows with
`options`	`object`	<optional>	Options for rendering rows
`emptyRows`	`object`	<optional>	A component to render when no items are to render. (`.length === 0`)

View Source Frameworks/AsyncTableTools/hooks/useTableView/views/rowsBuilder.js, line 18

Returns:

A object containing tableProps

Type: object

# useAsyncTableTools(items, columns, optionsopt) → {useAsyncTableToolsReturn}

This hook combines several "Table hooks" and returns props for Patternfly (v4) Table components and the FEC PrimaryToolbar

Parameters:

Name	Type	Attributes	Description
`items`	`Array` \| `function`		An array or (async) function that returns an array of items to render or an async function to call with the tableState and serialised table state
`columns`	`object`		An array of columns to render the items/rows with
`options`	`object`	<optional>	AsyncTableTools options

View Source Frameworks/AsyncTableTools/hooks/useAsyncTableTools/useAsyncTableTools.js, line 35

Returns:

An object of props meant to be used in the AsyncTableToolsTable

Type: useAsyncTableToolsReturn

# useBulkSelect(optionsopt) → {useBulkSelectReturn}

Provides properties for a Pattternfly (based) Table and Toolbar component to implement bulk selection

Parameters:

Name	Type	Attributes	Description
`options`	`object`	<optional>	AsyncTableTools options
`total`	`number`	<optional>	Number to show as total count
`onSelect`	`function`	<optional>	function to call when a selection is made
`selected`	`Array`	<optional>	Array of itemIds that should be currently selected. If it changes, the current selection will change
`preselected`	`Array`	<optional>	Array of itemIds that should be selected when initialising
`itemIdsInTable`	`function`	<optional>	Function to call to retrieve IDs when "Select All" is chosen
`itemIdsOnPage`	`Array`	<optional>	Array of item ids visible on the page
`identifier`	`string`	<optional>	Property of the items that should be used as ID to select them

View Source Frameworks/AsyncTableTools/hooks/useBulkSelect/useBulkSelect.js, line 40

Returns:

Functions and props to use for setting up bulk selection

Type: useBulkSelectReturn

# useColumnManager(columns, optionsopt) → {useColumnManagerReturn}

Provides columns for a Patternfly table, a (Primary)Toolbar action and a ColumnManager component

Parameters:

Name	Type	Attributes	Description
`columns`	`Array`		Columns for a table to be managed
`options`	`object`	<optional>	AsyncTableTools options
`columnManagerSelectProp`	`string`	<optional>	Property to use for the selection manager to identify columns
`manageColumnLabel`	`string`	<optional>	Label for the action item to show

View Source Frameworks/AsyncTableTools/hooks/useColumnManager/useColumnManager.js, line 27

Returns:

Props and function to integrate the column manager

Type: useColumnManagerReturn

# useComplianceApi(endpointopt) → {object|function}

Hook to get a Compliance javascript-client or specific endpoint function

Parameters:

Name	Type	Attributes	Description
`endpoint`	`string`	<optional>	String of the javascript-clients export for the needed endpoint

View Source Utilities/hooks/useComplianceQuery/hooks/useComplianceApi.js, line 19

Returns:

Compliance javascript-client or specific endpoint function

Type: object | function

# useComplianceQuery(endpoint, optionsopt) → {useComplianceQueryReturn}

Hook to use a Compliance REST API v2 endpoint with useQuery. Optionally support for using the serialised table state if a <TableStateProvider/> is available.

Parameters:

Name	Type	Attributes	Description
`endpoint`	`function`		String of the javascript-clients export for the needed endpoint
`options`	`object`	<optional>	Options for useComplianceQuery & useQuery
`params`	`useComplianceQueryParams`	<optional>	API endpoint params
`useTableState`	`boolean`	<optional>	Use the serialised table state
`batched`	`boolean`	<optional>	Wether or not requests should be batched
`skip`	`boolean`	<optional>	Wether or not to skip the request
`batch`	`object`	<optional>	Options to be passed to the useFetchTotalBatched
`onlyTotal`	`boolean`	<optional>	Enables a predefined "compileResult" function for the useQuery to only return the meta.total as the `data`
`requiredParams`	`Array` \| `string`	<optional>	Parameters required for the endpoint. The request will be "skipped" until all parameters are provided.

View Source Utilities/hooks/useComplianceQuery/useComplianceQuery.js, line 88

Returns:

An object containing a data, loading and error state, as well as a fetch and fetchBatched function.

Type: useComplianceQueryReturn

Example

// Will return a `useQuery` result with data, loading, error
const { data, loading, error } = useComplianceQuery('policies')

// Will return a `useQuery` result with a filter passed to the API
const reportsApi = useComplianceQuery('reports', {
 params: { filter: 'name NOT null'}
})

// Will return a `useQuery` result using the sort, pagination and filter state from a TableStateProvider passed as params to the API
const reportsApi = useComplianceQuery('reports', {
 useTableState: true
})

// Will do the same as above, but additionally add a default filter to the tables filter
const reportsApi = useComplianceQuery('reports', {
 params: { filter: 'name NOT null' },
 useTableState: true
})

// Will use the table state for pagination and filters, but always use the 'name:asc' for every request
const reportsApi = useComplianceQuery('reports', {
 params: { sortBy: 'name:asc' },
 useTableState: true
})

# useExpandable(optionsopt) → {useExpandableReturn}

Provides props for a Patternfly table to manage expandable items/rows.

Parameters:

Name	Type	Attributes	Description
`options`	`object`	<optional>	AsyncTableTools options
`detailsComponent`	`object`	<optional>	A component that should be rendered as a details row

View Source Frameworks/AsyncTableTools/hooks/useExpandable/useExpandable.js, line 26

Returns:

An object of props meant to be used in the AsyncTableToolsTable

Type: useExpandableReturn

# useFetchTotalBatched(fetchFnopt, optionsopt) → {useFetchTotalBatchedReturn}

This hook allows to provide a fetch function that can be called to perform "batched" requests. In short it means it will make as many requests/calls with the function to fill a total. This "total" is taken from the meta.total or the first response. Responses or returns of the function are expected to contain at least a "data" and a "meta" property The "data" property must be an array, to be able to merge the results. The "meta" property must at least (in the first response/return) contain the total property.

Parameters:

Name	Type	Attributes	Description
`fetchFn`	`function`	<optional>	An async function that accepts an offset, a limit and a params argument
`options`	`object`	<optional>	Hook options
`batchSize`	`number`	<optional>	The limit or items to be requested per request (Default: 50)
`skip`	`boolean`	<optional>	Wether or not to skip (all) requests (Default: false)
`params`	`object`	<optional>	Parameters passed to all calls

View Source Utilities/hooks/useFetchTotalBatched.js, line 37

Returns:

An object to use

Type: useFetchTotalBatchedReturn

# useFilterConfig(optionsopt) → {FilterConfig}

Provides PrimaryToolbar props for the ConditionalFilter component filter configuration.

Parameters:

Name	Type	Attributes	Description
`options`	`object`	<optional>	AsyncTableTools options
`filters.filterConfig`	`object`	<optional>	An object containing filter definition
`filters.activeFilters`	`object`	<optional>	An object containing an initial active filters state
`serialisers.filters`	`object`	<optional>	A function to serialise the filter table state

View Source Frameworks/AsyncTableTools/hooks/useFilterConfig/useFilterConfig.js, line 31

Returns:

props for PrimaryToolbar/ConditionalFilter component

Type: FilterConfig

# useFullTableState() → {object}

Hook to access both the "raw" and the serialised table state

View Source Frameworks/AsyncTableTools/hooks/useTableState/hooks/useFullTableState.js, line 13

Returns:

table state

Type: object

# useItems(itemsProp) → {Array}

This hook handles either just returning a provided array of items or calls a provided async (fetch) function to load an array of items

Parameters:

Name	Type	Description
`itemsProp`	`Array` \| `function`	An array or (async) function that returns an array of items to render or an async function to call with the tableState and serialised table state

View Source Frameworks/AsyncTableTools/hooks/useItems/useItems.js, line 23

Returns:

An array of items from the itemsProp passed in or a return from it as a function

Type: Array

# usePagination(optionsopt) → {object}

Provides pagination props and functionality for a (Primary)Toolbar

Parameters:

Name	Type	Attributes	Description
`options`	`object`	<optional>	AsyncTableTools options
`numberOfItems`	`number`		The total number of items (required).
`perPage`	`number`	<optional>	A number that will dictate the amount of items shown per page.
`serialisers.pagination`	`function`	<optional>	A function to provide a serialiser for the table state

View Source Frameworks/AsyncTableTools/hooks/usePagination/usePagination.js, line 18

Returns:

An object of props meant to be used in the AsyncTableToolsTable

Type: object

# useQuery(fn, optionsopt) → {useQueryReturn}

Custom hook to execute a query function with parameters and optional skip condition

Parameters:

Name	Type	Attributes	Description
`fn`	`function`		Function to execute
`options`	`object`	<optional>	Includes options like params and skip
`params`	`Array` \| `object`	<optional>	Parameters passed to the request to make. If an array is passed it will be spread as arguments!
`convertToArray`	`boolean`	<optional>	A function to use to convert a params object into an arguments array to pass to the fetch function
`compileResult`	`boolean`	<optional>	A function to use to convert the request response
`skip`	`boolean`	<optional>	Wether or not to skip the request

View Source Utilities/hooks/useQuery/useQuery.js, line 39

Returns:

An object containing a data, loading and error state, as well as a fetch and refetch function.

Type: useQueryReturn

Examples

// Query is skipped if conditions are met
const query = useQuery(apiInstance.systems, {params: ["param1", "param2"], skip: number > 5})

const query = useQuery(apiInstance.systems)

const query = useQuery(apiInstance.system, {params: ["id"]})

# useRawTableState() → {object}

Hook to access the "raw" table state

View Source Frameworks/AsyncTableTools/hooks/useTableState/hooks/useRawTableState.js, line 13

Returns:

raw table state

Type: object

# useSelectionManager(preselected, optionsopt, handleSelect) → {object}

Provides a generic API to manage selection stats of one (default) or multiple groups of selections.

Parameters:

Name	Type	Attributes	Description
`preselected`	`Array`		Array of items initially selected
`options`	`object`	<optional>	function to call when a selection is made
`handleSelect`	`function`		function to call when a selection is made

View Source Frameworks/AsyncTableTools/hooks/useSelectionManager/useSelectionManager.js, line 16

Returns:

Object containing the current selection state and functions to manipulate it

Type: object

# useSerialisedTableState() → {object}

Hook to access the serialised table state

View Source Frameworks/AsyncTableTools/hooks/useTableState/hooks/useSerialisedTableState.js, line 13

Returns:

serialised table state

Type: object

# useTableSort(columns, optionsopt) → {useTableSortReturn}

Provides columns with the sortable transform mixed in for a Patternfly table.

Parameters:

Name	Type	Attributes	Description
`columns`	`Array`		Columns for a table, with a "sortable" prop
`options`	`object`	<optional>	AsyncTableTools options
`sortBy`	`object`	<optional>	An initial sortBy state like `{index: 1, direction: 'desc'}`
`onSort`	`object`	<optional>	A function to call after setting a new sort state.
`serialisers.sort`	`object`	<optional>	A function to provide a serialiser for the table state

View Source Frameworks/AsyncTableTools/hooks/useTableSort/useTableSort.js, line 36

Returns:

Props for a Patternfly table to integrate sorting

Type: useTableSortReturn

Example

const columns = [{ title: 'Name', sortable: true }]
const tableSort = useTableSort(columns)

# useTableState(namespace, initialStateopt, optionsopt) → {Array}

Provides an interface for hooks to store their states name-spaced into the tableState in the TableContext

Parameters:

Name	Type	Attributes	Description
`namespace`	`object`		A key to namespace the state under (e.g. 'filters', 'sort')
`initialState`	`object`	<optional>	Initial state to put into the table state
`options`	`object`	<optional>	Options for the state
`serialiser`	`object`	<optional>	A function to serialise the table state and allow access it via the useSerialisedTableState hook
`observers`	`object`	<optional>	An object with properties of an other state namespace and an object or function returning an object with an desired state should the other state change
`callbacks`	`object`	<optional>	An object with callbacks

View Source Frameworks/AsyncTableTools/hooks/useTableState/useTableState.js, line 26

Returns:

An array with the first item being the tableState, the second a function to set the state and a third optional item with the serialised state if a serialiser was provided

Type: Array

# useTableView(items, columns, optionsopt) → {object}

A hook that manages "views" for a Patternfly (v4) Table component, like a simple "row" view or a "tree" view

Parameters:

Name	Type	Attributes	Description
`items`	`Array`		An array of items to render
`columns`	`Array`		An array of columns to render items with
`options`	`object`	<optional>	AsyncTableTools options
`tableTree`	`object`	<optional>
`showViewToggle`	`boolean`	<optional>
`defaultTableView`	`string`	<optional>

View Source Frameworks/AsyncTableTools/hooks/useTableView/useTableView.js, line 22

Returns:

TODO

Type: object

# withExport(optionsopt) → {withExportReturn}

Provides an exportConfig prop for a (Primary)Toolbar action

Parameters:

Name	Type	Attributes	Description
`options`	`object`	<optional>	AsyncTableTools options
`exporter`	`function`	<optional>	Function to return an array of items to be exported
`columns`	`Array`	<optional>	columns for the export
`isDisabled`	`boolean`	<optional>	Wether or not export is enabled
`onStart`	`function`	<optional>	Function to call before the export
`onComplete`	`function`	<optional>	Function to call when the export succeeded
`onError`	`function`	<optional>	Function to call when there was an error exporting

View Source Frameworks/AsyncTableTools/utils/withExport/withExport.js, line 28

Returns:

Props for PrimaryToolbar component

Type: withExportReturn

Type Definitions

Type: object

# FilterConfig

Properties:

Name	Type	Description
`toolbarProps`	`object`	Object containing PrimaryToolbar props
`filterConfig`	`object`	Object containing the filterConfig prop for the PrimaryToolbar
`activeFiltersConfig`	`object`	Object containing the activeFiltersConfigs prop for the PrimaryToolbar

View Source Frameworks/AsyncTableTools/hooks/useFilterConfig/useFilterConfig.js, line 9

Type: object

# useAsyncTableToolsReturn

Properties:

Name	Type	Description
`toolbarProps`	`object`	Object containing PrimaryToolbar props
`tableProps`	`object`	Object containing Patternfly (deprecated) Table props

View Source Frameworks/AsyncTableTools/hooks/useAsyncTableTools/useAsyncTableTools.js, line 15

Type: object

# useBulkSelectReturn

Properties:

Name	Type	Attributes	Description
`markRowSelected`	`function`	<optional>	"Transformer" function to be passed to the rowsBuilder
`toolbarProps`	`object`	<optional>	Object containing PrimaryToolbar props
`tableProps`	`object`	<optional>	Object containing Patternfly (v4) Table props

View Source Frameworks/AsyncTableTools/hooks/useBulkSelect/useBulkSelect.js, line 13

Type: object

# useColumnManagerReturn

Properties:

Name	Type	Attributes	Description
`columns`	`Array`		Patternfly table columns
`columnManagerAction`	`function`	<optional>	Action props for a Toolbar action
`ColumnManager`	`object`	<optional>	ColumnManager modal component to be shown to manage columns

View Source Frameworks/AsyncTableTools/hooks/useColumnManager/useColumnManager.js, line 5

Type: object

# useComplianceQueryParams

Properties:

Name	Type	Attributes	Description
`filter`	`string`	<optional>	Scoped search filter string for the endpoint
`pagination`	`object`	<optional>	API pagination params
`offset`	`object`	<optional>	Pagination offset
`limit`	`object`	<optional>	Pagination limit (maximum 100)
`sortBy`	`object`	<optional>	SortBy string for the API (usually 'attribute:desc')

View Source Utilities/hooks/useComplianceQuery/useComplianceQuery.js, line 15

Type: object

# useComplianceQueryReturn

Properties:

Name	Type	Description
`data`	`object`	Property that contains the request response
`error`	`object`	Property that contains the request error
`loading`	`boolean`	Wether or not the requests are currently loading
`fetch`	`function`	Fetch function to call fetches on demand
`fetchBatched`	`function`	Fetch function to call batched fetches on demand
`fetchQueue`	`function`	Function that can be called with a "queue"/array of params object or an object with key paramsObject pairs to call fetch with
`fetchBatchedQueue`	`function`	Function that can be called with a "queue"/array of params object or an object with key paramsObject pairs to call fetchBatched with
`fetchAllIds`	`function`	Fetch function to call a batched fetch of all ids (with the idsOnly param) on demand
`exporter`	`function`	Fetch function to call a batched fetch of all data and return the objects on demand (can be passed as exporter to Table Tools)

View Source Utilities/hooks/useComplianceQuery/useComplianceQuery.js, line 26

Type: object | undefined

# useExpandableReturn

Properties:

Name	Type	Attributes	Description
`openItem`	`function`	<optional>	"Transformer" function to be passed to the `rowsBuilder`
`tableProps`	`object`	<optional>	Object containing Patternfly (deprecated) Table props

View Source Frameworks/AsyncTableTools/hooks/useExpandable/useExpandable.js, line 6

Type: object

# useFetchTotalBatchedReturn

Properties:

Name	Type	Description
`loading`	`boolean`	Wether or not data is loaded
`data`	`object`	Combined result of all requests
`fetch`	`function`	Function to call the batched requests on demand that additional parameters for all requests

View Source Utilities/hooks/useFetchTotalBatched.js, line 8

Type: object

# useQueryReturn

Properties:

Name	Type	Attributes	Description
`data`	`any`	<optional>	Data loaded from the response of the request
`error`	`Error`	<optional>	An error if the request failed
`loading`	`boolean`	<optional>	Boolean of wether or not data is being requested
`refetch`	`function`	<optional>	A function to re-trigger a request with params coming from the options
`fetch`	`function`	<optional>	A function to make a request on demand. It takes to arguments, a params object or array, and a boolean to control wether or not to set the "data" state or return the results directly. In case the params argument is an array any params from the options will be ignored!

View Source Utilities/hooks/useQuery/useQuery.js, line 5

Type: object

# useTableSortReturn

Properties:

Name	Type	Attributes	Description
`tableProps`	`object`	<optional>	Props for a Patternfly table
`onSort`	`function`	<optional>	Callback function for column headers in a Patternfly table
`cells`	`Array`	<optional>	Array containing columns for a Patternfly table with the sortable transform applied
`sortBy`	`object`	<optional>	Object containing the current sortBy state

View Source Frameworks/AsyncTableTools/hooks/useTableSort/useTableSort.js, line 6

Type: object

# withExportReturn

Properties:

Name	Type	Description
`toolbarProps`	`object`	Object containing PrimaryToolbar props
`exportConfig`	`object`	Object containing the exportConfig prop for the PrimaryToolbar

View Source Frameworks/AsyncTableTools/utils/withExport/withExport.js, line 4

Compliance Docs

Members

# constant filtersSerialiser

# constant sortSerialiser

Example

Methods

# AsyncTableToolsTable(props) → {React.ReactElement}

Parameters:

# ComplianceRoute(props) → {React.ReactElement}

Parameters:

# ComplianceTable(props) → {React.ReactElement}

Parameters:

# DeleteReport() → {React.Element}

# LinkWithPermission(props) → {React.ReactElement}

Parameters:

# RulesTable(propsopt) → {React.ReactElement}

Parameters:

# TableStateProvider(propsopt) → {React.ReactElement}

Parameters:

# TailoringTab(propsopt) → {React.ReactElement}

Parameters:

# Tailorings(propsopt) → {React.ReactElement}

Parameters:

# WithPermission(props) → {React.ReactElement}

Parameters:

# indexRunner() → {function}

# rowsBuilder(items, columns, optionsopt) → {object}

Parameters:

# useAsyncTableTools(items, columns, optionsopt) → {useAsyncTableToolsReturn}

Parameters:

# useBulkSelect(optionsopt) → {useBulkSelectReturn}

Parameters:

# useColumnManager(columns, optionsopt) → {useColumnManagerReturn}

Parameters:

# useComplianceApi(endpointopt) → {object|function}

Parameters:

# useComplianceQuery(endpoint, optionsopt) → {useComplianceQueryReturn}

Parameters:

Example

# useExpandable(optionsopt) → {useExpandableReturn}

Parameters:

# useFetchTotalBatched(fetchFnopt, optionsopt) → {useFetchTotalBatchedReturn}

Parameters:

# useFilterConfig(optionsopt) → {FilterConfig}

Parameters:

# useFullTableState() → {object}

# useItems(itemsProp) → {Array}

Parameters:

# usePagination(optionsopt) → {object}

Parameters:

# useQuery(fn, optionsopt) → {useQueryReturn}

Parameters:

Examples

# useRawTableState() → {object}

# useSelectionManager(preselected, optionsopt, handleSelect) → {object}

Parameters:

# useSerialisedTableState() → {object}

# useTableSort(columns, optionsopt) → {useTableSortReturn}

Parameters:

Example

# useTableState(namespace, initialStateopt, optionsopt) → {Array}

Parameters:

# useTableView(items, columns, optionsopt) → {object}

Parameters:

# withExport(optionsopt) → {withExportReturn}

Parameters:

Type Definitions

# FilterConfig

Properties:

# useAsyncTableToolsReturn

Properties:

# useBulkSelectReturn

Properties:

# useColumnManagerReturn

Properties:

# useComplianceQueryParams

Properties:

# useComplianceQueryReturn

Properties:

# useExpandableReturn