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

javascript-1flow-sdk

v1.0.2

Published

1Flow is a smart in-app survey platform for technology startups. This is the official package for 1Flow Javascript SDK. Visit 1flow.app for more information.

Downloads

373

Readme

Get Started

You can embed our Javascript SDK into any website or web application through NPM.

1. Install node package via npm

Run the below command in terminal in your app’s directory:

npm install javascript-1flow-sdk

2. Initialize 1Flow SDK

Place the below code inside your web app:

import { oneflow } from 'javascript-1flow-sdk';

oneflow.oneFlowInit('<your-project-api-key>')

3. Track events

You need to track events in order to use these events as triggers of 1Flow in-app surveys.

  • You can give an event contextual info by placing any key-value pairs inside the {}:
import { oneflow } from 'javascript-1flow-sdk';

oneflow.logEvent("event_name",{item_id:"123",type:"legos"}); 
  • You can also log events without any parameters:
 import { oneflow } from 'javascript-1flow-sdk';

oneflow.logEvent("event_name");

Example usage

Let’s say you want to trigger an event on a button click. You just need to log that button click event, and then that event can be used to trigger a survey:

import { oneflow } from 'javascript-1flow-sdk';

myFunction() {    
  ...
	oneflow.logEvent("event_name");
}

3. Log user (optional)

If your app requires the user to register an account and sign in, you can call a method to bind the user with 1Flow. This way, you'll be able to connect the data with your internal records.

Whenever the user has signed in, you can call oneflow.logUser() to pass the user identifier, along with any other parameters you'd like to store with us, to 1Flow.

import { oneflow } from 'javascript-1flow-sdk';

const parameter={'firstName': 'steve', 'lastName': 'jobs', 'number': 123456 };  //parameters are optional.
oneflow.logUser(userId, parameter); // parameters are optional, if no parameters, then only pass in userId

Show your first survey

Now that you've successfully integrated 1Flow into your SDK, it's time to create your first survey.

If you've already created a survey and published it (survey shows up in the "In Progress" section of the dashboard), run the app and trigger the event to happen, you should see the survey show up when the event is fired.