@privacybydesign/irma-web

v0.3.2

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

NPM

README

GitHub

Website

MIT

Latest version published 2 months ago

    npm install @privacybydesign/irma-web

We couldn't find any similar packages Browse all packages

Package Health Score

63 / 100

Popularity
Limited
Maintenance
Sustainable
Security
No known security issues
Community
Limited

Make sure the open source you're using is safe to use

Secure my Project

Popularity

Limited

Weekly Downloads (117)

Dependents: 1
GitHub Stars: 3
Forks: 4
Contributors

The npm package @privacybydesign/irma-web receives a total of 117 downloads a week. As such, we scored @privacybydesign/irma-web popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package @privacybydesign/irma-web, we found that it has been starred 3 times, and that 1 other projects in the ecosystem are dependent on it.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Security

No known security issues

Security and license risk for significant versions

All Versions

Direct Vulnerabilities

0.1.2

0.3.2

Indirect Vulnerabilities

0.1.2

0.3.2

License Risks

0.1.2

0.3.2

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

MIT

Security Policy

We found a way for you to contribute to the project! Looks like @privacybydesign/irma-web is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

    # Install the Snyk CLI and test your project
npm i snyk && snyk test @privacybydesign/irma-web

Keep your project free of vulnerabilities with Snyk

Maintenance

Sustainable

Commit Frequency

Open Issues: 2
Merged PR: 20
Open PR: 2
Last Commit: 16 days ago

Further analysis of the maintenance status of @privacybydesign/irma-web based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that @privacybydesign/irma-web demonstrates a positive version release cadence with at least one new version released in the past 3 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Community

Limited

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 0
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like @privacybydesign/irma-web is missing a Code of Conduct.

Embed Package Health Score Badge

Package

Node.js Compatibility: not defined

Age: 12 months
Dependencies: 2 Direct
Versions: 12
Install Size: 13.4 kB
Dist-tags: 1
# of Files: 6
Maintainers: 4
TS Typings: No

@privacybydesign/irma-web has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

IRMA web

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

It is designed to be used with 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 instead for ease of use, or take a look at the irma-web example for a more hands-on implementation example.

Usage

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.

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.

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.

showHelper

The option showHelper is a boolean that determines if the irma-css helper should be shown or not. Default is false.

Note: the helper is supposed to be able to get triggered during the IRMA flow. This is not possible yet. This makes it pretty useless right now. PRs and ideas welcome.