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

remotestorage-widget

v1.6.0

Published

remoteStorage.js connect widget

Downloads

118

Readme

remotestorage-widget

npm

A ready-to-use connect/sync widget, as add-on library for remoteStorage.js.

Usage

import RemoteStorage from 'remotestoragejs';
import Widget from 'remotestorage-widget';

// ...

const remoteStorage = new RemoteStorage(/* options */);

remoteStorage.access.claim('bookmarks', 'rw');

const widget = new Widget(remoteStorage);
widget.attach();

// ...

Configuration

The widget has some configuration options to customize the behavior:

| Option | Description | Type | Default | |---|---|---|---| | leaveOpen | Keep the widget open when user clicks outside of it | Boolean | false | | autoCloseAfter | Timeout after which the widget closes automatically (in milliseconds). The widget only closes when a storage is connected. | Number | 1500 | | skipInitial | Don't show the initial connect hint, but show sign-in screen directly instead | Boolean | false | | logging | Enable logging for debugging purposes | Boolean | false | | modalBackdrop | Show a dark, transparent backdrop when opening the widget for connecting an account. true shows backdrop everywhere, false turns it off everywhere. Default is to only show it on small screens. | Boolean, String | "onlySmallScreens" |

Example:

const widget = new Widget(remoteStorage, { autoCloseAfter: 2000 });

Available Functions

attach(elementID) - Attach the widget to the DOM and display it. You can use an optional element ID that the widget should be attached to. Otherwise it will be attached to the body.

While the attach() method is required for the widget to be actually shown, the following functions are usually not needed. They allow for fine-tuning the experience.

close() - Close/minimize the widget to only show the icon.

open() - Open the widget when it's minimized.

toggle() - Switch between open and closed state.

Development / Customization

Install deps:

npm install

Build, run and watch demo/test app:

npm start

The demo app will then be served at http://localhost:8008