HODS - Status message

An indication to the user that something has changed.

Using this package

First install the package into your project:

npm install -S @hods/status-message

Then use it in your code as follows:

import React, { createElement as h } from 'react';
import StatusMessage from '@hods/status-message';

export const MyComponent = props => (
  <StatusMessage
    status="On hold"
    actions={<A href="#">Review</A>}
  >
    due for review 10 March 2018
  </StatusMessage>
);

export default MyComponent;

Examples of use

Some basic examples of this component can be seen in the main docs for the monorepo.

Working on this package

Before working on this package you must install its dependencies using the following command:

pnpm install

Testing

Unit tests can be run in the usual manner:

npm test

For visual checks of the fully rendered and styled component, run storybook:

npm run storybook

Once storybook is running, open the Status Message page in your browser.

Building

npm run build

Clean-up

npm run clean