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

spase

v9.0.1

Published

Micro library for performing 2D spatial calculations of DOM elements

Downloads

59

Readme

spase npm CI CD

Micro library for performing 2D spatial calculations of DOM elements.

Usage

import { getFOV, hitTest, Point, Rect, Size } from 'spase';

API

Class: Point

A type representing a point on a 2D plane.

Class: Size

A type that represents a size on a 2D plane.

Class: Rect

A type representing a rectangle on a 2D plane.

Rect.intersecting(...elements)

Computes the intersecting Rect of one or more elements. If only 1 element is specified, the intersection will be computed against the viewport.

  • @param elements: Element[] — Element(s) to be used to compute the intersecting Rect.
  • @returns Rect | null — The intersecting Rect.

Rect.from(target[, options])

Gets the combined Rect of one or more elements.

  • @param target: Rect | Window | Element | Element[] — An element or array of elements to compute the combined Rect.
  • @param options — Additional options.
  • @param options.reference: Window | Element | undefined — The element whose coordinate space the computed top, right, bottom and left values are relative to.
  • @param options.overflow: boolean Specifies whether the overflow width/height should be accounted for.
  • @returns Rect | null — The combined Rect.

Rect.fromViewport()

Gets the Rect of the viewport (current field of view). Think of this as the Rect of the current window.

  • @returns Rect — The Rect of the viewport.

getFOV(element[, options])

Computes the field-of-view (FOV) of an element.

  • @param element: Element | null The target element.
  • @param options Additional options.
  • @param options.reference: Window | Element | undefined — The element whose coordinate space the computed field-of-view is relative to.
  • @returns FOV | null - The FOV if it is computable, null otherwise.

hitTest(obj1, obj2)

Hit-tests 2 objects. These objects can either be Point's, Rect's or Element's.

  • @param obj1: Rect | Element | Element[] | Point | readonly [number number] | Readonly<{ x: number; y: number; }> | Rect[] — First object.
  • @param obj2: Rect | Element | Element[] | Point | Rect[] — Second object.
  • @returns booleantrue if test passes, false otherwise.

Caveats

Note that this library is intended to be used for 2D DOM elements only. If an element has transform styles applied to it, the top, right, bottom and left properties will be obscured. This is because the underlying method of calculating these values depends on the native getBoundingClientRect function.

Breaking Changes

v4.0.0

  • Widths and heights now use offsetWidth and offsetHeight when applicable.

v3.0.0

  • API changes: getIntersectRect, getRect, and getViewportRect are now static members of Rect class, as Rect.intersecting, Rect.from, and Rect.fromViewport, respectively.