# @financial-times/spark-push-notification

> Spark Push Notification component

Latest version **2.3.0** (published 2022-09-15) · ISC license · 0 weekly downloads

## Install

```sh
npm install @financial-times/spark-push-notification
pnpm add @financial-times/spark-push-notification
yarn add @financial-times/spark-push-notification
bun add @financial-times/spark-push-notification
```

## 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.3.0 |
| Published | 2022-09-15 |
| First published | 2020-07-27 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 14 |
| Unpacked size | 583.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | robgodfrey, hamza.samih, nikita.lohia, notlee, efinlay24, emmalewis, aendra, the-ft, rowanmanning, chee, alexwilson |

## Links

- npm: https://www.npmjs.com/package/@financial-times/spark-push-notification
- Repository: https://github.com/financial-times/spark
- Homepage: https://github.com/Financial-Times/spark-components#readme
- Issues: https://github.com/Financial-Times/spark-components/issues
- npm.io page: https://npm.io/package/@financial-times/spark-push-notification

## Dependencies (14)

- [bunyan](https://npm.io/package/bunyan.md) ^1.8.15
- [@babel/preset-env](https://npm.io/package/@babel/preset-env.md) ^7.16.5
- [@babel/preset-react](https://npm.io/package/@babel/preset-react.md) ^7.16.5
- [@financial-times/o-icons](https://npm.io/package/@financial-times/o-icons.md) ^5.11.2
- [@financial-times/o-table](https://npm.io/package/@financial-times/o-table.md) ^7.4.1
- [@financial-times/o-colors](https://npm.io/package/@financial-times/o-colors.md) ^4.10.3
- [@financial-times/o-message](https://npm.io/package/@financial-times/o-message.md) ^3.1.4
- [@babel/plugin-transform-react-jsx](https://npm.io/package/@babel/plugin-transform-react-jsx.md) ^7.12.17
- [@financial-times/editorial-config](https://npm.io/package/@financial-times/editorial-config.md) ^1.0.2
- [@financial-times/editorial-o-forms](https://npm.io/package/@financial-times/editorial-o-forms.md) ^1.0.2
- [@financial-times/editorial-o-button](https://npm.io/package/@financial-times/editorial-o-button.md) ^1.0.2
- [@financial-times/editorial-o-loading](https://npm.io/package/@financial-times/editorial-o-loading.md) ^1.0.2
- [@financial-times/editorial-o-overlay](https://npm.io/package/@financial-times/editorial-o-overlay.md) ^1.0.2
- [@financial-times/editorial-o-typography](https://npm.io/package/@financial-times/editorial-o-typography.md) ^1.0.2

## Recent versions

- 2.3.0 (latest) — 2022-09-15
- 2.2.0 — 2022-04-12
- 2.2.0-rc.0 — 2022-04-11
- 2.1.0 — 2022-04-07
- 2.0.3 — 2021-05-19
- 2.0.0 — 2021-05-14
- 1.0.17 — 2021-01-18
- 1.0.13 — 2020-12-11
- 1.0.12 — 2020-12-11
- 1.0.6 — 2020-11-06
- 1.0.2 — 2020-08-20
- 1.0.0 — 2020-08-06
- 0.0.2-alpha.5 — 2020-07-29
- 0.0.2-alpha.4 — 2020-07-29
- 0.0.2-alpha.3 — 2020-07-29
- … 2 more at https://npm.io/package/@financial-times/spark-push-notification/versions

## README

# spark-push-notification

This repo abstract away the code required for spark push notification so that functionality can be shared across the spark estate

This repo has a storybook. To run it locally you can run `yarn workspace @financial-time/spark-push-notification storybook`

### How to use

```
yarn add @financial-times/spark-push-notification // with yarn
npm i @financial-times/spark-push-notification // with npm
```

and use it like:

```
import { PushButtonWithOverlay, PushButton } from @financial-times/spark-push-notification

<PushButtonWithOverlay articleId={articleStore.articleId}>
			<Button data-trackable="send-push">
				Send push
			</Button>
</PushButtonWithOverlay>
```

## Development

This repo uses [lerna](https://lerna.js.org/) under the hood for the publication flows. It also uses [yarn workspaces](https://classic.yarnpkg.com/en/docs/workspaces/) to manage packages internally.

### How to publish
1. Make changes to the source
2. Test changes in Spark - they'll be shown in your development site
3. Increment the version number in package.json
4. When a pull request containing your changes is merged, CircleCI will automatically publish your packages

---
_Source: https://npm.io/package/@financial-times/spark-push-notification · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._