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

@joyfill/sdk-js

v1.0.9

Published

Joyfill sdk for embeddable UI and components.

Downloads

13

Readme

sdk-js

Joyfill sdk for embeddable UI and components.

Install

npm install @joyfill/sdk-js

Getting Started

Head over to Joyfill developer docs.

Retrieve API Key

From the Joyfill Manager we now need to create an API Key. Navigate to the API Keys menu option from the top nav menu of the Joyfill Manager.

Embed your Portal

Use the following code to embed your Portal into your app. Also for more help run our /examples/js example project.

ESM

// /index.html
<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8">
  </head>

  <body>
    <div id="joyfill-portal"> <!--injects here--> </div>
    <script type="module" src="src/index.js"></script>
  </body>
</html>

// /index.js
import { Portal } from "@joyfill/sdk-js/dist/joyfill.esm.js";

/**
 * call whenever you'd like us to insert the portal
 * within the provided mountOn id
 */
Portal.load({
  userAccessToken: '<valid_useraccesstoken>',
  mountOn: '#joyfill-portal',
  mode: 'edit', // edit | fill | readonly
  onUploadAsync: ({ type, document, fileUploads }) => {
    /* handle file uploads here */
  },
  onSubmit: ({ type, doc }) => {
    /* handle final save of a from here */
  },
  onChange: ({ type, params, changes, doc }) => {
    /* handle actively made form changes here */
  }
});

Vanilla JS

Similar to ESM just can't use ES module imports.

// /index.html
<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8">
    <script type="text/javascript" src="https://cdn.jsdelivr.net/npm/joyfill/dist/joyfill.js"></script>

  </head>

  <body>
    <div id="joyfill-portal"> <!--injects here--> </div>
    <script src="src/index.js"></script>
  </body>
</html>

// /index.js
window.onload = function() {
  var joyfill = window.joyfill;
  joyfill.Portal.load({
    userAccessToken: 'abcefg_doe123>',
    mountOn: '#joyfill-portal',
    ...<otherfields>
  });
}

Next steps

Check out the Joyfill developer docs to see what's needed to get your Portal working in production, including:

  1. Setting up Authentication
  2. Understanding the JoyDoc
  3. PDF Exports & Downloads