@redhat-cloud-services/frontend-components-utilities

RedHat Cloud Services frontend components - utils

This package exports common functions to be used in other packages.

Installation

With NPM

npm i -S @redhat-cloud-services/frontend-components-utilities

With yarn

yarn add @redhat-cloud-services/frontend-components-utilities

This package is dependent on @redhat-cloud-services/frontend-components it will automatically installed trough direct dependencies.

Migration guide

v2 -> v3

Import path change

Assets are no longer under /files directory but directly at the root of the build directory.

// v2
import { getRegistry } from '@redhat-cloud-services/frontend-components-utilities/Registry';

// v3
import { getRegistry } from '@redhat-cloud-services/frontend-components-utilities/Registry';

No UMD build

Utils package no longer provides UMD version of the build.

RowLoader

RowLoader component is no longer a part of helpers file but is now a stand-alone component. Import path has changed.

// v2
import { RowLoader } from '@redhat-cloud-services/frontend-components-utilities/helpers'
// v3
import RowLoader from '@redhat-cloud-services/frontend-components-utilities/RowLoader'

SCSS files

SCSS files are now under styles directory.

/** v2 */
@import '~@redhat-cloud-services/frontend-components-utilities/styles/all';
/** v3 */
@import '~@redhat-cloud-services/frontend-components-utilities/styles/all''

inventoryDependencies

This module is now deprecated. Use a new Inventory component compatible with chrome 2.0.

parseCvssScore

Function parseCvssScore has been moved to a stand-alone file. Import path has changed.

// v2
import { parseCvssScore } from '@redhat-cloud-services/frontend-components-utilities/helpers'
// v3
import parseCvssScore from '@redhat-cloud-services/frontend-components-utilities/parseCvssScore'

Documentation Links

• Utils
  • redux
  • routerParams
  • debounce
  • cypress
  • RBAC

Additionaly it exports these utilities

• AsyncComponent - class to load component via async calls
• helpers - custom helper functions
• MiddlewareListener - redux listener on actions, they can fire additional action or be cancelled
• Registry - reducer registry
• RouterParams - maps route to props
• interceptors - to be used with axios clients
• Styles - custom style functions in sass