react-ios-scroll-lock ver 1.0.0

Author: stripearmy

.gitignore

@@ -0,0 +1,24 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+*.js

.prettierignore

@@ -0,0 +1,3 @@
+# Ignore artifacts:
+build
+coverage

.prettierrc

@@ -0,0 +1 @@
+{}

LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Arsen Mkrtchyan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,2 +1,74 @@
 # react-ios-scroll-lock
-ios-scroll-lock React Package
+
+The initial idea was to lock the body scroll on iOS Safari whenever we see fit, turns out we made something that works everywhere on the web<br />This was achieved with overscroll-behaviour css property
+
+### Medium Article: 
+
+### Demo: [https://stripearmy.github.io/ios-scroll-lock-demo/](https://stripearmy.github.io/ios-scroll-lock-demo/)
+
+## Installation
+
+	$ npm install react-ios-scroll-lock
+	or
+	$ yarn add react-ios-scroll-lock
+
+## Usage
+
+```javascript
+// Import react-ios-scroll-lock
+import {IosScrollLock} from 'react-ios-scroll-lock';
+// Import css
+import 'react-ios-scroll-lock/css';
+
+<IosScrollLock>
+  Your content goes here
+</IosScrollLock>
+```
+
+### Trigger the open state by modifying the "isOpen" (boolean) attribute <br /><br />Note: Is disabled by "isInline" attribute
+
+```javascript
+<IosScrollLock isOpen={true}>
+```
+
+### Tip: if your CSS breaks the functionality of IosScrollLock just render it using React Portal
+
+```javascript
+{createPortal(
+  <IosScrollLock isOpen={true}>
+    Your content goes here
+  </IosScrollLock>,
+  document.body
+)}
+```
+
+### Pass your custom className(s) by using the optional "className" attribute
+
+```javascript
+<IosScrollLock className="yourCustomClassName">
+```
+
+### Pass your custom background color by using the optional "bgColor" attribute
+
+```javascript
+<IosScrollLock bgColor="#000">
+// or
+<IosScrollLock bgColor="rgba(0, 0, 0, 0.5)">
+// or
+<IosScrollLock bgColor="var(--yourCustomBgColor)">
+```
+
+### Render the component contents ONLY wherever you want by using the optional "isInline" (boolean) attribute<br /><br />Note: Disables the effects of "isOpen" attribute 
+
+```javascript
+<IosScrollLock isInline={true}>
+```
+
+## Contributing
+
+Pull requests are welcome. For major changes, please open an issue first
+to discuss what you would like to change.
+
+## License
+
+[MIT](https://choosealicense.com/licenses/mit/)

dist/index.d.ts

@@ -0,0 +1,14 @@
+import { default as default_2 } from 'react';
+import { JSX } from 'react/jsx-runtime';
+
+export declare function IosScrollLock({ children, isOpen, isInline, className, bgColor, }: IosScrollLockProps): JSX.Element;
+
+declare interface IosScrollLockProps {
+    bgColor?: string;
+    isInline?: boolean;
+    className?: string;
+    isOpen?: boolean;
+    children: default_2.ReactNode;
+}
+
+export { }