# uport-web-ui

> A collection of ui elements useful for working with uPort identities

Latest version **0.1.0-alpha.1** (published 2019-01-25) · ISC license · 0 weekly downloads

## Install

```sh
npm install uport-web-ui
pnpm add uport-web-ui
yarn add uport-web-ui
bun add uport-web-ui
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0-alpha.1 |
| Published | 2019-01-25 |
| First published | 2019-01-24 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 123.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Rob Whitaker |
| Maintainers | rmw2 |
| Keywords | identity, components, uport |

## Links

- npm: https://www.npmjs.com/package/uport-web-ui
- Repository: https://github.com/uport-project/uport-ui
- Homepage: https://github.com/uport-project/uport-ui#readme
- Issues: https://github.com/uport-project/uport-ui/issues
- npm.io page: https://npm.io/package/uport-web-ui

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 0.1.0-alpha.1 (latest) — 2019-01-25
- 0.1.0-alpha.0 — 2019-01-24

## README

# uPort Web UI
_A collection of ui elements for building uport-enabled web applications._



All of the following functions are exported at the top level by uport-web-ui, and create or modify an HTML modal which is injected into the DOM.  Elements are identified by classes and IDs prefixed with `uport__`, and styled by a custom stylesheet, bundled with the elements. *TODO: Allow styles to be overwritten*.


| Function | Description | Image |
|----------|-------------|-------|
|`open(dataUri: String, cancel: Function, modalText: String)`| Open a modal and display the image provided as a data uri in the first argument. | |
|`success(timeout: Number)` | Display a success modal which will self-dismiss after `timeout` milliseconds | |
|`failure(retry: Function)` | Display a failure modal which includes a link to retry to failed action, using the provided `retry` function. | |
|`notifyPushSent(fallback: Function)`| Display a modal informing the user that a push notification has been sent, providing a button to retry or attempt a different delivery method bound to the `fallback` argument.| |
|`close()`   | Close any open uPort Modal by removing the elements from the DOM | |

---
_Source: https://npm.io/package/uport-web-ui · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._