@monterosa/react-native-parallax-scroll

v1.8.0

Parallax scroll for React Native For more information about how to use this package see README

Latest version published 7 years ago

License: MIT

NPM

GitHub

Package Health Score

52 / 100

security
No known security issues
popularity
Limited
maintenance
Inactive
community
Sustainable

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
1.8.0	\|	04/2018	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.7.0	\|	04/2018		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.6.0	\|	04/2018		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.5.4	\|	03/2018		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.4.3	\|	10/2017		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (350)

GitHub Stars: 554
Forks: 62
Contributors: 3

Direct Usage Popularity

The npm package @monterosa/react-native-parallax-scroll receives a total of 350 downloads a week. As such, we scored @monterosa/react-native-parallax-scroll popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package @monterosa/react-native-parallax-scroll, we found that it has been starred 554 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: Yes
Contributors: 3
Funding: No

This project has seen only 10 or less contributors.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 13
Open PR: 15
Last Release: 7 years ago
Last Commit: 5 years ago

Further analysis of the maintenance status of @monterosa/react-native-parallax-scroll based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for @monterosa/react-native-parallax-scroll is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 7 years
Dependencies: 0 Direct
Versions: 23
Install Size: 322 kB
Dist-tags: 1
# of Files: 16
Maintainers: 4
TS Typings: No

@monterosa/react-native-parallax-scroll has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

react-native-parallax-scroll

A ScrollView-like component that:

Has a parallax background
Has a parallax foreground
Has a fixed or sticky header
Can be nested within other views(FlatList, SectionList)
Works on iOS and Android

Installation

$ npm install @monterosa/react-native-parallax-scroll --save

Demo

YouTube - https://www.youtube.com/watch?v=zM4koduK32Y

| | | | | | |

Basic Usage

import ParallaxScroll from '@monterosa/react-native-parallax-scroll';

// Inside of a component's render() method:
render() {
  return (
      <header>}
      headerHeight={50}
      isHeaderFixed={false}
      parallaxHeight={250}
      renderParallaxBackground={({ animatedValue }) =&gt; }
      renderParallaxForeground={({ animatedValue }) =&gt; }
      parallaxBackgroundScrollSpeed={5}
      parallaxForegroundScrollSpeed={2.5}
    &gt;
      
    
  );
}

Examples

Please clone the repo and run npm run storybook or yarn storybook to show examples of usages.

Usage (API)

All of the properties of ScrollView are supported. Please refer to the ScrollView documentation for more detail.

The ParallaxScroll component adds a few additional properties, as described below.

Property	Type	Defaut	Description
`style`	`object`	`{}`	Component's styles
`width`	`number`	`Dimensions.get('window').width`	Component's width.
`height`	`number`	`Dimensions.get('window').height`	Component's height.
`innerRef`	`func`	`null`	To get a reference to the scrollable component.
`scrollStyle`	`object`	`{}`	These styles will be applied to the scroll view.
`headerHeight`	`number`	`45`	This is the height of sticky(fixed) header.
`renderHeader`	`({ width, height, animatedValue }) => {}`	`null`	This renders an optional sticky(fixed) header that will be visible to the top of the view.
`onHeaderFixed`	`func`	`null`	A callback function that is invoked when the header will attach to the top.
`isHeaderFixed`	`bool`	`false`	Is header fixed to top(not sticky)?
`parallaxHeight`	`number`	`Dimensions.get('window').width * 9 / 16`	This is the height of parallax.
`useNativeDriver`	`bool`	`false`	Enable Native driver for animated. NOTE: Works only with `Animated.ScrollView` component.
`scrollableComponent`	`class`	`Animated.ScrollView`	This is a class of scrollable component.
`isBackgroundScalable`	`bool`	`true`	Is background scalable on iOS?
`headerBackgroundColor`	`string`	`rgba(0, 0, 0, 0)`	The color of the unsticked(unfixed) header background. Can be empty `''` string. NOTE: Dosen't work with useNativeDriver.
`contentContainerStyle`	`object`	`{}`	These styles will be applied to the scroll view content container which wraps all of the child views.
`headerFixedTransformY`	`number`	`0`	This number indicating how much the fixed header should move upwards during the scroll. Used as the hack to change fixed header height during scroll.
`onChangeHeaderVisibility`	`func`	`null`	A callback function that is invoked when the parallax header is hidden or shown (as the user is scrolling). Function is called with a `boolean` value to indicate whether header is visible or not.
`renderParallaxBackground`	`({ width, height, animatedValue }) => {}`	`null`	This renders the background of the parallax.
`renderBackgroundPlaceholder`	`({ height, animatedValue }) => {}`	`null`	By default we assume that you want to show the foreground and background in its own space. We prepend an empty view with the height of `parallaxHeight`. You can override this behaviour to layer things in between foreground and background. You might want to avoid foreground in such a scenario, see Issue #23 for more details.
`renderParallaxForeground`	`({ width, height, animatedValue }) => {}`	`null`	This renders the foreground of the parallax.
`fadeOutParallaxBackground`	`bool`	`false`	If `true`, the background will fade out as the user scrolls up.
`fadeOutParallaxForeground`	`bool`	`false`	If `true`, the foreground will fade out as the user scrolls up.
`headerFixedBackgroundColor`	`string`	`rgba(0, 0, 0, 1)`	The color of the sticked(fixed) header background.
`backgroundScale`	`number`	`3`	The speed factor that the background scales. Respects `backgroundScaleOrigin`
`backgroundScaleOrigin`	`center` or `top`	`center`	The point of which the background should scroll from. Use `top` with `backgroundScale={2}` in order to achieve iOS native parallax scroll behavior. Top will keep the background locked to the top of the scrollview, while scaling the image such that it stretches the background in the downwards direction.
`parallaxBackgroundScrollSpeed`	`number`	`5`	The speed factor that the background moves at relative to the scroll content.
`parallaxForegroundScrollSpeed`	`number`	`5`	The speed factor that the foreground moves at relative to the scroll content.

Latest changelog

All changes here

1.8.0 - 2018-04-14

Added

renderBackgroundPlaceholder prop for overriding default behaviour to layer things in between foreground and background (#23)

1.7.0 - 2018-04-12

Added

backgroundScale and backgroundScaleOrigin props for support scaling from the top and make scale factor configurable (#22)

1.6.0 - 2018-04-05

Fixed

Based on the Component, instead of PureComponent

Contributing

I welcome contributions! Please open an issue if you have any feature ideas or find any bugs. I also accept pull requests with open arms. I will go over the issues when I have time. 😃

@monterosa/react-native-parallax-scroll development dependencies

@storybook/addon-knobs @storybook/addons @storybook/react-native babel-eslint babel-preset-react-native eslint eslint-config-airbnb eslint-plugin-import eslint-plugin-jsx-a11y eslint-plugin-prettier eslint-plugin-react prettier prettier-eslint-cli prop-types react react-dom react-native react-native-lightbox webpack

FAQs

What is @monterosa/react-native-parallax-scroll?

Parallax scroll for React Native. Visit Snyk Advisor to see a full health score report for @monterosa/react-native-parallax-scroll, including popularity, security, maintenance & community analysis.

Is @monterosa/react-native-parallax-scroll popular?

The npm package @monterosa/react-native-parallax-scroll receives a total of 350 weekly downloads. As such, @monterosa/react-native-parallax-scroll popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @monterosa/react-native-parallax-scroll well maintained?

We found indications that @monterosa/react-native-parallax-scroll is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is @monterosa/react-native-parallax-scroll safe to use?

The npm package @monterosa/react-native-parallax-scroll was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 19 November-2024, at 15:00 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (350)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

react-native-parallax-scroll

Installation

Demo

Basic Usage

Examples

Usage (API)

Latest changelog

1.8.0 - 2018-04-14

Added

1.7.0 - 2018-04-12

Added

1.6.0 - 2018-04-05

Fixed

Contributing

@monterosa/react-native-parallax-scroll development dependencies

FAQs

What is @monterosa/react-native-parallax-scroll?

Is @monterosa/react-native-parallax-scroll popular?

Is @monterosa/react-native-parallax-scroll well maintained?

Is @monterosa/react-native-parallax-scroll safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues