@hods/status-message

HODS - Status message
=====================

An indication to the user that something has changed.

Using this package
------------------

First install the package into your project:

``shell
npm install -S @hods/status-message
`

Then use it in your code as follows:

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

export const MyComponent = props => (
status="On hold"
actions={Review}
>
due for review 10 March 2018

);

export default MyComponent;
`

$3

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:

`shell
pnpm install
`

$3

Unit tests can be run in the usual manner:
`shell
npm test
`

For visual checks of the fully rendered and styled component, run storybook:
`shell
npm run storybook
`
Once storybook is running, open the [Status Message page] in your browser.

$3

`shell
npm run build
`

$3

`shell
npm run clean
``

[basic examples]: https://hods-poc.netlify.app/components?name=Status%20message
[main docs]: https://hods-poc.netlify.app/
[Status Message page]: http://localhost:9009/?path=/docs/status-message--status-message