# @helloinspire/melodic-react

> Melodic React components library

Latest version **2.5.7** (published 2022-01-25) · ISC license · 0 weekly downloads

## Install

```sh
npm install @helloinspire/melodic-react
pnpm add @helloinspire/melodic-react
yarn add @helloinspire/melodic-react
bun add @helloinspire/melodic-react
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.5.7 |
| Published | 2022-01-25 |
| First published | 2020-05-06 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 4 |
| Unpacked size | 1.3 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | donaldwasserman, matthewrossanderson, tmarren, ankittrehan2000, aaron-nussbaum |

## Links

- npm: https://www.npmjs.com/package/@helloinspire/melodic-react
- npm.io page: https://npm.io/package/@helloinspire/melodic-react

## Dependencies (4)

- [react-bootstrap](https://npm.io/package/react-bootstrap.md) ^1.4.3
- [react-hook-form](https://npm.io/package/react-hook-form.md) ^6.15.1
- [react-animated-css](https://npm.io/package/react-animated-css.md) ^1.2.1
- [@helloinspire/melodic](https://npm.io/package/@helloinspire/melodic.md) ^2.0.0-alpha.7

## Recent versions

- 2.5.7 (latest) — 2022-01-25
- 1.0.0-alpha.0 (alpha) — 2020-07-17
- 2.5.6 — 2022-01-25
- 2.5.5 — 2021-09-20
- 2.5.4 — 2021-06-14
- 2.5.3 — 2021-05-17
- 2.5.2 — 2021-05-06
- 2.5.1 — 2021-05-06
- 2.5.0 — 2021-04-30
- 2.4.1 — 2021-04-21
- 2.4.0 — 2021-04-06
- 2.3.0 — 2021-02-09
- 2.2.2 — 2021-01-26
- 2.2.1 — 2021-01-26
- 2.2.0 — 2021-01-26
- … 33 more at https://npm.io/package/@helloinspire/melodic-react/versions

## README

# Melodic for React

[Storybook](https://dwpholdings.github.io/melodic-react)

[Melodic documentation](https://melodic.helloinspire.com/)

### Link package for local development

[yarn link docs](https://classic.yarnpkg.com/en/docs/cli/link/)

1. Link the melodic-react package locally

`cd melodic-react && yarn link`

2. If working with melodic Components that use Hooks (stateful components), you'll have to link the version of React in your project to `melodic-react`. [Explanation](https://reactjs.org/warnings/invalid-hook-call-warning.html#duplicate-react)

`yarn link ../<myapp>/node_modules/react`

2. Link the melodic-react package to the project you want to use your local melodic-react

`cd <myapp> && yarn link @helloinspire/melodic-react`

3. When you make changes to melodic-react locally, run `yarn build` and the changes will be reflected in your project

\*\* To reverse this process, simply use `yarn unlink` or `yarn unlink @helloinspire/melodic-react`

### Development scripts

#### `yarn start`

> Run the component library locally to make changes

#### `yarn deploy`

> Builds and deploys to Github pages hosted [here](https://dwpholdings.github.io/melodic-react)

#### `yarn push`

> Runs the build step, publishes the package to npm, and deploys to Github pages

#### `yarn build`

> Compile library from Typescript to Javascript and output to the `/build` folder using [Rollup](https://rollupjs.org/guide/en/#introduction)

#### `yarn test`

> Run Jest tests

#### `yarn build-storybook`

> Builds the Storybook stories and outputs them to the `/.out` folder

### Global Styles: StyledApp Component

By default the components come with minimal default styles. To get the fully fleshed out component as it was intended you will need to wrap the components with the StyledApp parent component to bring in a scoped version of melodic-web. We recommend placing this as the highest parent component in the host application, normally in App.tsx or related display layer.

```
<StyledApp className='inspire-app'>
  <MainNav />
    <ReactMelodicComponent { ...props } />
    <Switch location={location}>
      {routeComponents}
    </Switch>
  <MainFooter />
</StyledApp>
```

---
_Source: https://npm.io/package/@helloinspire/melodic-react · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
