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-frontend

v0.1.3

Published

A simplified package of yivi-frontend modules to get started easily

Downloads

1,235

Readme

Yivi frontend

This is a thin wrapper around yivi-core, yivi-web, yivi-popup, yivi-client and yivi-css. The intended use of this package is to provide an all-in-one Javascript file that developers can include to get started:

<script src="assets/yivi.js" type="text/javascript"></script>

or as JavaScript import:

const yivi = require('@privacybydesign/yivi-frontend');

Documentation

More documentation on how to use this module can be found in the Yivi documentation.

Usage

When you want to use an embedded web element, then you can instantiate yivi-frontend like so:

const example = yivi.newWeb({
  debugging: false,            // Enable to get helpful output in the browser console
  element:   '#yivi-web-form', // Which DOM element to render to

  // Back-end options
  session: {
    // Configure your flow here, see code examples in root README file
  },

  ...
});

When you want to use a popup overlay that renders on top of the content of your website, then you can instantiate yivi-frontend like so:

const example = yivi.newPopup({
  debugging: false, // Enable to get helpful output in the browser console

  // Back-end options
  session: {
    // Configure your flow here, see code examples in root README file
  },

  ...
});

Finally, you can start your Yivi flow:

example.start()
.then(result => console.log("Successful disclosure! 🎉", result))
.catch(error => console.error("Couldn't do what you asked 😢", error));

Be aware that you can start an instance of yivi-core only once. When you want to call start() again, you have to create a new instance.

Download

A bundled JavaScript file can be found here. Please download this file and host it yourself. Versions can change and we do not want to break your website.

Development

You can link local versions of modules easily using npm link. There is an explanation about how to use npm link in the README of the yivi-frontend-packages root directory.