@synthsym/uncover-el@2.0.0
Built and signed on GitHub Actions
Built and signed on GitHub Actions

latest

A smol library to scroll a page to an element. Adapted from Cypress's actionability code.

Published

11 months ago (2.0.0)

Uncover-El 🔍

Reveal to me that which is hidden, unveil to me what is forbidden.

A smol library to scroll a page to an element. Adapted from Cypress's actionability code.

This library is available on NPM as uncover-el.

npm install uncover-el

It is also available on JSR as @synthsym/uncover-el.

npx jsr add @synthsym/uncover-el

We also provide ESM and UMD builds from the Github Release CDN. The library is available at window.uncoverEl in browser environments.

Visit the Releases page for more information.

The function uncover takes a HTMLElement and an optional configuration object.

import { uncover } from 'uncover-el'

const hiddenEl = document.getElementById('hiddenEl')
await uncover(hiddenEl)

The configurable options are listed below.

Name	Type	Default	Description
retries	`number`	`3`	Number of times to retry scrolling.
interval	`number`	`100`	Number of milliseconds to wait between retries.
x	`number`	`0`	Pixel offset from the left of the element to check for coverage.
y	`number`	`0`	Pixel offset from the top of the element to check for coverage.
scrollBehaviour	`'top' \| 'bottom' \| 'center'`	`'top'`	Where on the element to perform the first scroll.
position	`'top' \| 'topLeft' \| 'topRight' \| 'left' \| 'center' \| 'right' \| 'bottomLeft' \| 'bottom'\| 'bottomRight'`	`'top'`	The anchor of the the element used to determine if the element in covered.

Built and signed on

GitHub Actions

Add Package

deno add jsr:@synthsym/uncover-el

Import symbol

import * as uncover_el from "@synthsym/uncover-el";

Import directly with a jsr specifier

import * as uncover_el from "jsr:@synthsym/uncover-el";

Add Package

pnpm i jsr:@synthsym/uncover-el

or (using pnpm 10.8 or older)

pnpm dlx jsr add @synthsym/uncover-el

Import symbol

import * as uncover_el from "@synthsym/uncover-el";

Add Package

yarn add jsr:@synthsym/uncover-el

or (using Yarn 4.8 or older)

yarn dlx jsr add @synthsym/uncover-el

Import symbol

import * as uncover_el from "@synthsym/uncover-el";

Add Package

vlt install jsr:@synthsym/uncover-el

Import symbol

import * as uncover_el from "@synthsym/uncover-el";

Add Package

npx jsr add @synthsym/uncover-el

Import symbol

import * as uncover_el from "@synthsym/uncover-el";