{"id":16609121,"url":"https://github.com/hueyyeng/simple-react-lightbox","last_synced_at":"2025-10-29T16:32:44.674Z","repository":{"id":65151138,"uuid":"524559532","full_name":"hueyyeng/simple-react-lightbox","owner":"hueyyeng","description":"Modified TypeScript React lightbox based on Michele Cocuccio's Simple React Lightbox.","archived":false,"fork":false,"pushed_at":"2023-05-11T06:22:25.000Z","size":28924,"stargazers_count":2,"open_issues_count":0,"forks_count":5,"subscribers_count":0,"default_branch":"develop","last_synced_at":"2024-10-03T12:09:41.260Z","etag":null,"topics":["lightbox-gallery-plugin","react","reactjs","typescript-react"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hueyyeng.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-08-14T03:02:56.000Z","updated_at":"2024-06-19T06:46:28.000Z","dependencies_parsed_at":"2023-02-15T21:45:51.621Z","dependency_job_id":null,"html_url":"https://github.com/hueyyeng/simple-react-lightbox","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hueyyeng%2Fsimple-react-lightbox","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hueyyeng%2Fsimple-react-lightbox/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hueyyeng%2Fsimple-react-lightbox/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hueyyeng%2Fsimple-react-lightbox/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hueyyeng","download_url":"https://codeload.github.com/hueyyeng/simple-react-lightbox/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219868382,"owners_count":16555746,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["lightbox-gallery-plugin","react","reactjs","typescript-react"],"created_at":"2024-10-12T01:28:13.805Z","updated_at":"2025-10-29T16:32:39.320Z","avatar_url":"https://github.com/hueyyeng.png","language":"TypeScript","readme":"# @hueyyeng/simple-react-lightbox\n\n[![npm version](https://badge.fury.io/js/@hueyyeng%2Fsimple-react-lightbox.svg)](https://badge.fury.io/js/@hueyyeng%2Fsimple-react-lightbox)\n\n\u003e A demo that uses the latest version of this library can be found on my personal website: [https://taukeke.com/gallery](https://taukeke.com/gallery)\n\nModified React lightbox based on Michele Cocuccio's Simple React Lightbox. The original README.md can be found here: [README.old.md](README.old.md).\n\nSince the original GitHub repository is no longer accessible, I had to make some custom modifications to align with my specific\nneeds. As a result, I ended up forking the project from a repository that was itself a fork of the original repository.\n\nThe code has also been converted to TypeScript, using TypeScript 5.0.\n\n## Changes Since v3.6.9 by Michele Cocuccio\n\n- **NEW:** Converted to **TypeScript**\n- **NEW:** Add **react-remove-scroll** dependencies\n- Override **.react-transform-wrapper** overflow to inherit\n- Expose **react-zoom-pan-pinch** `limitToBounds` settings\n- Remove **body-scroll-lock** dependencies and logic\n- Remove Travis CI config and reference\n\n## Quickstart\n\nTo get started with this library in your React app, follow these steps:\n\n1. Make sure you have **React** installed. Although the library has been tested with React 17 and\n   is expected to work with React 16, compatibility with React 18 is not guaranteed. If you have made\n   it compatible with React 18, please feel free to open a pull request.\n2. Ensure you have **Node.js 16** installed.\n3. Use **Yarn** as your package manager, as it is required for this library.\n\n### Installing as Local Package\n\n1. Clone this repository with `git clone yourpreferredmethod.git @hueyyeng/simple-react-lightbox` using\n   either SSH or HTTPS. The resulting folder should look like this (e.g. yourreactapp/packages/@hueyyeng/simple-react-lightbox).\n2. Optionally, exclude it using React app `.gitignore`.\n3. Add this to your React app `package.json` dependencies (using step 1 example path).\n\n```json\n  \"dependencies\": {\n    ...,\n    \"simple-react-lightbox\": \"file:packages/@hueyyeng/simple-react-lightbox\",\n  },\n```\n\n4. Navigate to `yourreactapp/packages/@hueyyeng/simple-react-lightbox` folder.\n5. Run `yarn build:dev`.\n\nRefer to [README.old.md](README.old.md) on the usage. I'm unsure how it works for non-CreateReactApp (CRA) project\nbut if you're using CRA, you need to run `yarn build:dev` whenever you make changes to **simple-react-lightbox** for CRA\nto automatically reload with the new changes.\n\n## Usage\n\n\u003e Make sure at least **Node.js 16** and **Yarn** installed.\n\n### Development\n\n1. Run `yarn install`.\n2. Modify the existing codes as required.\n3. Run `yarn build:dev` to generate the build output. The dev build have inline sourcemaps for debugging in browser.\n\n### Production\n\n1. Run `yarn install`.\n2. Modify the existing codes as required.\n3. Run `yarn build` to generate the production build output.\n\n## Known Issues\n\n1. Several forks of this project have adjusted the React version range to include React 16. However,\n   since this library relies on React Context, which was introduced in React 16.3, it is recommended\n   to set React 16.3 as the minimum required version.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhueyyeng%2Fsimple-react-lightbox","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhueyyeng%2Fsimple-react-lightbox","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhueyyeng%2Fsimple-react-lightbox/lists"}