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 🙏

© 2022 – Pkg Stats / Ryan Hefner

grid-util-js

v1.1.0

Published

JS helpers for the Grid

Downloads

47

Readme

Grid JS Utilities

JavaScript utilities for handling [Grid] URLs and API.

Installation

Through npm

npm install --save grid-util-js

or jspm

jspm install npm:grid-util-js

Dependencies

You need a modern browsers implementing fetch and Promise or you can polyfill those methods.

Usage

import GridUtils from 'grid-util-js';

var grid = new GridUtils({
	apiBaseUrl: 'http://root.api.of.grid'
});

API

Extract Grid image ID from any URL

Finds the Grid image ID in an URL. The URL can be anything, the media or crop link, or the link of the public image as long as the media ID is inside the URL.

grid.excractMediaId('http://deployed.image/12345...abcde')

Returns and object containing

{
	id: 'grid id',
	crop: 'crop id, if present'
}

Get the image data from the Grid

Calls the API to retrieve the image information. It uses hypermedia Grid API.

grid.getImage('12345...abcde')

Returns a promise that resolves with the JSON response or rejects in case of error.

Get the crop from the image data

Get a specified crop from the image API response.

  • grid.filterCrops(apiResponse) returns all crops
  • grid.filterCrops(apiResponse, 'crop_id') returns the crop with id crop_id
  • grid.filterCrops(apiResponse, filterFunction) returns all crops matching filterFunction.

filterFunction receives as only parameter the crop data.

Get the crop for a drag event

When dragging a crop from the Grid, the crop information is inside the event dataTransfer.

grid.getCropFromEvent(evt)

Returns a JSON object.

Get the Grid url from a drag event

When dragging a crop from the Grid, the event dataTransfer contains the original image URL in the Grid.

grid.getGridUrlFromEvent(evt)

Returns the URL as a string.