automattic/jetpack-lazy-images

Speed up your site and create a smoother viewing experience by loading images as visitors scroll down the screen, instead of all at once.

v2.1.14 2022-05-18 11:12 UTC

Requires

• automattic/jetpack-assets: ^1.17
• automattic/jetpack-constants: ^1.6

Requires (Dev)

• automattic/jetpack-changelogger: ^3.1
• automattic/wordbless: dev-master
• yoast/phpunit-polyfills: 1.0.3

GPL-2.0-or-later

README

Speed up your site and create a smoother viewing experience by loading images as visitors scroll down the screen, instead of all at once.

Usage

/*
 * Initialize lazy images on the wp action so that conditional
 * tags are safe to use.
 *
 * As an example, this is important if a theme wants to disable lazy images except
 * on single posts, pages, or attachments by short-circuiting lazy images when
 * is_singular() returns false.
 *
 * See: https://github.com/Automattic/jetpack/issues/8888
 */

add_action( 'wp', array( 'Automattic\\Jetpack\\Jetpack_Lazy_Images', 'instance' ) );

Development

Running tests requires working svn, composer and pnpm commands.

Once these are installed, you install the composer dependencies by running:

$ composer install --ignore-platform-reqs

Generate minified JavaScript

The JavaScript file can be minified from the root of the Jetpack repository:

$ cd ../../
$ pnpm build-packages

Run PHP unit tests

On a local development environment run:

$ composer phpunit

Lint PHP source code

The PHP code can be linted from the root of the Jetpack repository:

$ cd ../../
$ composer phpcs:compatibility packages/lazy-images
$ composer phpcs:lint packages/lazy-images