@nomads42/react-native-lightbox

1.3.2 • Public • Published

React Native Lightbox

React Native Lightbox is an npm package that allows you using a lightbox in a React Native project.

Getting Started

Installation

$ npm install --save @nomads42/react-native-lightbox

Basic Usage

<LightBox>
  <Image ... />
  ...
  <Image ... />
</LightBox>

Properties

LightBox

Prop Default Type Description
paginationStyle null string Allows you to choose the pagination style. 3 possible values: null, dots and pages.
renderFooter null function Display the return value of this function at the bottom of the lightbox. renderFooter gets the index of the current <Image /> in parameters.
album false boolean Display all the children instead of just the selected one.

Image

If you want a specific <Image ... /> to be selected for your LightBox, simply add a selected attribute to that one like this: <Image ... selected />. By default, the first one is selected.

Dependencies

React Native Lightbox uses a number of open source projects to work properly:

Roadmap

  • [ ] Zoomable images
  • [ ] Animations

Package Sidebar

Install

npm i @nomads42/react-native-lightbox

Weekly Downloads

1

Version

1.3.2

License

none

Last publish

Collaborators