# @privacybydesign/irma-web

> A front-end to IRMA flows for in the web browser

Latest version **0.4.3** (published 2021-10-01) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @privacybydesign/irma-web
pnpm add @privacybydesign/irma-web
yarn add @privacybydesign/irma-web
bun add @privacybydesign/irma-web
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.4.3 |
| Published | 2021-10-01 |
| First published | 2020-03-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 19.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Maintainers | sringers, confiks, timendus, ivard |

## Links

- npm: https://www.npmjs.com/package/@privacybydesign/irma-web
- Repository: https://github.com/privacybydesign/irma-frontend-packages
- Homepage: https://github.com/privacybydesign/irma-frontend-packages#readme
- Issues: https://github.com/privacybydesign/irma-frontend-packages/issues
- npm.io page: https://npm.io/package/@privacybydesign/irma-web

## Dependencies (2)

- [qrcode](https://npm.io/package/qrcode.md) ^1.4.2
- [deepmerge](https://npm.io/package/deepmerge.md) ^4.2.2

## Recent versions

- 0.4.3 (latest) — 2021-10-01
- 0.4.2 — 2021-08-25
- 0.4.1 — 2021-07-28
- 0.4.0 — 2021-07-28
- 0.3.3 — 2021-03-25
- 0.3.2 — 2021-01-15
- 0.1.2 — 2020-11-03
- 0.1.1 — 2020-10-12
- 0.1.1-rc.7 — 2020-10-05
- 0.1.1-rc.6 — 2020-09-18
- 0.1.1-rc.5 — 2020-07-22
- 0.1.1-rc.4 — 2020-07-02
- 0.1.1-rc.3 — 2020-06-19
- 0.1.1-rc.2 — 2020-06-03
- 0.1.1-rc.1 — 2020-05-26
- … 1 more at https://npm.io/package/@privacybydesign/irma-web/versions

## README

# IRMA web

This plugin contains a front-end for IRMA flows in the web browser.

It is designed to be used with
[`irma-css`](https://github.com/privacybydesign/irma-frontend-packages/tree/master/plugins/irma-css). 
`irma-css` is not a dependency of this package by design. This means that the CSS must be imported
separately. How to do this, you can check in the README of `irma-css`. In this way you can also
adapt `irma-css` to your own design and import this custom style instead.

If you *do* want to use `irma-css` (which is recommended), you may also consider using
[the `irma-frontend` package](https://github.com/privacybydesign/irma-frontend-packages/tree/master/irma-frontend)
instead for ease of use, or take a look at
[the `irma-web` example](https://github.com/privacybydesign/irma-frontend-packages/tree/master/examples/browser/irma-web)
for a more hands-on implementation example.

## Usage

```javascript
const IrmaCore = require('@privacybydesign/irma-core');
const Web      = require('@privacybydesign/irma-web');

require('@privacybydesign/irma-css');

const irma = new IrmaCore({
  element: '#irma-web-form'
});

irma.use(Web);
irma.start();
```

## Options

### element

The `element` option should contain a selector that points to an element in
which to render the IRMA form. This is a required option.

### language

You can set the interface language by setting the `language` option. Currently
supported values: `en` and `nl`. Default is `nl`.

### fallbackDelay

You can set the delay in milliseconds that should be waited before the helper
message is shown as fallback. This only involves the mobile flow on Android.
This delay is measured from the point that the user presses the button to open
the IRMA app. A recommended value here is to double the polling interval.
Default is `1000` ms.

### translations

If you have more specific translation requirements, or if your use-case is not
logging a user in, you can override any of the strings in the interface using
the `translations` option. It is good practice to be specific in these texts to
avoid unnecessary confusion for your users.

```javascript
const irma = new IrmaCore({
  translations: {
    header:  'Sign the agreement with <i class="irma-web-logo">IRMA</i>',
    loading: 'Finding your agreement...'
  }
});
```

You can find the default values [in the translation files](https://github.com/privacybydesign/irma-frontend-packages/tree/master/plugins/irma-web/translations).

### showHelper

The option `showHelper` is a boolean that determines if the
[`irma-css` helper](https://privacybydesign.github.io/irma-frontend-packages/styleguide/section-examples.html#kssref-examples-helpers)
should be shown or not. Default is false.

_Note: the helper is also triggered during the mobile flow on Android. In that case, the helper
becomes visible when the user presses the button to open the IRMA app, and the app fails to open.
So, when `showHelper` is set to false, the helper is only visible as fallback and disappears
again as soon as the happy flow continues. When `showHelper` is set to true, the helper will
be visible unconditionally._

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