Skip to content

IPG-Automotive-UK/react-ui

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

@ipguk/react-ui

React UI component library for IPG web applications

Storybook NPM JavaScript Style Guide Build Status

Install

pnpm install --save @ipguk/react-ui

Usage

For a list of supported components run storybook. The basic syntax for usage is shown below for a generic "Component".

import React from "react";

import { Component } from "@ipguk/react-ui";

function Example() {
  return <Component>Here we go</Component>;
}

Documentation

Run storybook to explore all of the components and documentation.

pnpm run storybook

Release

To release a new version, follow these steps.

  1. Check that all tests pass

    pnpm test
  2. Up version the package using

    pnpm version major|minor|patch|prerelease
    
  3. Push the release and tag to Git

    git push
    
    git push --tags
    
  4. Run the publish command

    Note: If publishing for the first time you will need to login to npm

    pnpm login
    
    pnpm publish --access=public

    Note: If publishing a prerelease ensure that it is tagged as next rather than latest

    pnpm publish --access=public --tag=next
    
  5. Publish the release on GitHub

License

MIT © IPG Automotive