Developers

    Installation

    The package is hosted via github packages. To install the package you need to setup a few things.

    1. Override the registry for the @pxwlab-scope by creating a .npmrc file in your package with the following content:
    @pixelwerte:registry=https://npm.pkg.github.com
    1. Login into the github registry with your npm cli. Provide the github username as user, and the github token as password.
    npm login --scope=@pixelwerte --auth-type=legacy --registry=https://npm.pkg.github.com
    1. After that you can use yarn/npm etc. to install the actual package:
    yarn add @pixelwerte/eys-ui

# or

npm install --save @pixelwerte/eys-ui

    Make sure to also install all necessary peer dependencies:

    yarn add react react-dom @carbon/icons-react

# or

npm install --save react react-dom @carbon/icons-react

    Package Structure

    The package consists of the following files and directories:

    • dist/assets
      • all static assets like background-images, fonts and favicons live here
    • dist/style.css
      • the main stylesheet
    • dist/components.js
      • the react component library, in ESM format
    • dist/components.cjs
      • the react component library, in CommonJS format