@volvo-cars/ced-os-react-components

Onboarding and Support Components

Following atomic design, this repository contains reusable react components based on VCCUI that are used to build onboarding, support and education web interfaces, sites and applications.

The components can be viewed in this Storybook

Development

Getting Started

• npm install
• npm run dev to run storybook
• npm test to run tests

Publish

The library is automatically published to Github packages and NPM when a new tag in the format v.X.X.X is pushed to Github.

The steps to publish are:

1. build
2. bump version. se npm version mayor|minor|patch to bump version

Use npm version mayor|minor|patch to bump version an

Usage

The library is published as an NPM package and also a Github package.

Install from NPM package registry

Run npm install @volvo-cars/ced-os-react-components.

Install from Github package registry

To be able to install the package from the Github registry some configuration and Github authentication is needed.

Add a file called .npmrc to your project and paste the lines below into it to configure NPM to load @volvo-cars packages from the Github registry. The second line references an environment variable on your machine: VCC_GITHUB_PACKAGES_TOKEN.

@volvo-cars:registry=https://npm.pkg.github.com/
//npm.pkg.github.com/:_authToken=${VCC_GITHUB_PACKAGES_TOKEN}

The value of VCC_GITHUB_PACKAGES_TOKEN should be a Github Personal Access token with at least "read:packages" permissions.

If you use the dotenv package in your project it's also possible to define the variable in the .env file. In which case you need to do dotenv npm install

Example usage

// ...
import { JSONArticle } from '@volvo-cars/ced-os-react-components';

const Article = ({ articleId, content }) => {
    return (
        <View paddingTop={[3, 6]} paddingBottom={[3, 6]}>
            <JSONArticle data-article-id={articleId} data={content} />
        </View>
);
};