npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@privacybydesign/yivi-web

v0.1.3

Published

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

Downloads

672

Readme

Yivi web

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

It is designed to be used with yivi-css. yivi-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 yivi-css. In this way you can also adapt yivi-css to your own design and import this custom style instead.

If you do want to use yivi-css (which is recommended), you may also consider using the yivi-frontend package instead for ease of use, or take a look at the yivi-web example for a more hands-on implementation example.

Usage

const YiviCore = require('@privacybydesign/yivi-core');
const Web      = require('@privacybydesign/yivi-web');

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

const yivi = new YiviCore({
  element: '#yivi-web-form'
});

yivi.use(Web);
yivi.start();

Options

element

The element option should contain a selector that points to an element in which to render the Yivi 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 Yivi 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.

const yivi = new YiviCore({
  translations: {
    header:  'Sign the agreement with <i class="yivi-web-logo">Yivi</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 yivi-css helper 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 Yivi 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.