scrollreveal README

The project's README from github.com/jlmakes/scrollreveal. As one markdown file: README.md.

ScrollReveal


ScrollReveal

Animate elements as they scroll into view.

Build status Monthly downloads Version 5.7 kB min+gzip GPLv3 License


Installation

Browser

A simple and fast way to get started is to include this script on your page:

<script src="https://unpkg.com/scrollreveal"></script>

This will create the global variable ScrollReveal

Be careful using this method in production. Without specifying a fixed version number, Unpkg may delay your page load while it resolves the latest version. Learn more at unpkg.com

Module

$ npm install scrollreveal

CommonJS

const ScrollReveal = require('scrollreveal')

ES2015

import ScrollReveal from 'scrollreveal'

Usage

Installation provides us with the constructor function ScrollReveal(). Calling this function returns the ScrollReveal instance, the “brain” behind the magic.

ScrollReveal employs the singleton pattern; no matter how many times the constructor is called, it will always return the same instance. This means we can call it anywhere, worry-free.

There’s a lot we can do with this instance, but most of the time we’ll be using the reveal() method to create animation. Fundamentally, this is how to use ScrollReveal:

<h1 class="headline">
	Widget Inc.
</h1>
ScrollReveal().reveal('.headline')

🔎 See this demo live on JSBin



The full documentation can be found at https://scrollrevealjs.org

If you’re using an older version of ScrollReveal, you can find legacy documentation in the wiki



Commercial License Badge

License

For commercial sites, themes, projects, and applications, keep your source code private/proprietary by purchasing a Commercial License.

Licensed under the GNU General Public License 3.0 for compatible open source projects and non-commercial use.


Copyright 2023 Fisssion LLC

scrollreveal (jlmakes/scrollreveal)

Searching Database…

Что это такое?ScrollReveal — это JavaScript-библиотека, которая анимирует элементы на веб-странице, когда они появляются на экране при прокрутке.
Это отдельное приложение или что-то, что я встраиваю в код своей страницы?Это небольшая JavaScript-библиотека, которую вы подключаете к своей веб-странице — через тег script или как модуль, — а не отдельное приложение.
Как подключить её к странице?Подключите скрипт с unpkg — при этом появится глобальная переменная ScrollReveal, — либо установите библиотеку через npm и импортируйте её как модуль CommonJS или ES2015.
Можно ли безопасно использовать способ с тегом script в продакшене?Будьте осторожны: если не зафиксировать номер версии, unpkg может замедлить загрузку страницы, пока определяет актуальную версию, поэтому в продакшене указывайте конкретную версию.
Могу ли я использовать её на коммерческом сайте бесплатно?Нет, если хотите оставить свой код закрытым: коммерческим сайтам нужна платная Commercial License. Для open source проектов и некоммерческого использования GPLv3 предоставляется бесплатно.
Если вызвать ScrollReveal() несколько раз, создадутся лишние экземпляры?Нет. ScrollReveal использует паттерн singleton — сколько бы раз ни вызывался конструктор, он всегда возвращает один и тот же экземпляр, так что вызывать его можно откуда угодно без конфликтов.
На чём основаны анимации?Они используют CSS transforms и transitions. Внутри библиотека тянет с собой маленькие вспомогательные зависимости: rematrix, tealight и miniraf.
Проект ещё живой?Он существует с 2014 года, у него больше 22 тысяч звёзд на GitHub, и он не переведён в архив; в README указан копирайт 2023 от Fisssion LLC.
What are similar projects?GSAP, lax.js, isotope, motion, iscroll, toastr, headroom.js, anime
Creator
jlmakes
Size
1.1 MB
Stars
22.5K
Updated
CommitMar 18
Age
12y
Commits · 90 Days