Repository: stanleyugwu/react-native-bottom-sheet Branch: main Commit: 65f1c49bcc59 Files: 50 Total size: 88.9 KB Directory structure: gitextract_pza16rl0/ ├── .editorconfig ├── .gitattributes ├── .github/ │ ├── actions/ │ │ └── setup/ │ │ └── action.yml │ └── workflows/ │ └── ci.yml ├── .gitignore ├── .nvmrc ├── .watchmanconfig ├── .yarnrc ├── CODE_OF_CONDUCT.md ├── CONTRIBUTING.md ├── LICENSE ├── README.md ├── babel.config.js ├── commitlint.config.ts ├── example/ │ ├── App.js │ ├── app.json │ ├── babel.config.js │ ├── metro.config.js │ ├── package.json │ ├── src/ │ │ └── App.tsx │ ├── tsconfig.json │ └── webpack.config.js ├── lefthook.yml ├── package.json ├── scripts/ │ ├── bootstrap.js │ ├── copy-dts.js │ └── delete-lib-dir.js ├── src/ │ ├── __tests__/ │ │ └── index.test.tsx │ ├── components/ │ │ ├── animatedTouchableBackdropMask/ │ │ │ ├── index.tsx │ │ │ └── types.d.ts │ │ ├── backdrop/ │ │ │ ├── index.tsx │ │ │ └── types.d.ts │ │ ├── bottomSheet/ │ │ │ ├── index.tsx │ │ │ └── types.d.ts │ │ ├── container/ │ │ │ └── index.tsx │ │ └── defaultHandleBar/ │ │ ├── index.tsx │ │ └── types.d.ts │ ├── constant/ │ │ └── index.ts │ ├── hooks/ │ │ ├── useAnimatedValue.ts │ │ ├── useHandleAndroidBackButtonClose/ │ │ │ ├── index.ts │ │ │ └── types.d.ts │ │ └── useHandleKeyboardEvents/ │ │ ├── index.ts │ │ └── types.d.ts │ ├── index.ts │ ├── types.d.ts │ └── utils/ │ ├── convertHeight.ts │ ├── normalizeHeight.ts │ └── separatePaddingStyles.ts ├── tsconfig.build.json └── tsconfig.json ================================================ FILE CONTENTS ================================================ ================================================ FILE: .editorconfig ================================================ # EditorConfig helps developers define and maintain consistent # coding styles between different editors and IDEs # editorconfig.org root = true [*] indent_style = space indent_size = 2 end_of_line = lf charset = utf-8 trim_trailing_whitespace = true insert_final_newline = true ================================================ FILE: .gitattributes ================================================ *.pbxproj -text # specific for windows script files *.bat text eol=crlf ================================================ FILE: .github/actions/setup/action.yml ================================================ name: Setup description: Setup Node.js and install dependencies runs: using: composite steps: - name: Setup Node.js uses: actions/setup-node@v3 with: node-version-file: .nvmrc - name: Cache dependencies id: yarn-cache uses: actions/cache@v3 with: path: | **/node_modules key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}-${{ hashFiles('**/package.json') }} restore-keys: | ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }} ${{ runner.os }}-yarn- - name: Install dependencies if: steps.yarn-cache.outputs.cache-hit != 'true' run: | yarn install --cwd example --frozen-lockfile yarn install --frozen-lockfile shell: bash ================================================ FILE: .github/workflows/ci.yml ================================================ name: CI on: push: branches: - main pull_request: branches: - main jobs: lint: runs-on: ubuntu-latest steps: - name: Checkout uses: actions/checkout@v3 - name: Setup uses: ./.github/actions/setup - name: Lint files run: yarn lint - name: Typecheck files run: yarn typecheck test: runs-on: ubuntu-latest steps: - name: Checkout uses: actions/checkout@v3 - name: Setup uses: ./.github/actions/setup - name: Run unit tests run: yarn test --maxWorkers=2 --coverage build-library: runs-on: macos-latest steps: - name: Checkout uses: actions/checkout@v3 - name: Setup uses: ./.github/actions/setup - name: Build package run: yarn prepack build-web: runs-on: ubuntu-latest steps: - name: Checkout uses: actions/checkout@v3 - name: Setup uses: ./.github/actions/setup - name: Build example for Web run: | yarn example expo export:web ================================================ FILE: .gitignore ================================================ # OSX # .DS_Store # XDE .expo/ # VSCode .vscode/ jsconfig.json # Xcode # build/ *.pbxuser !default.pbxuser *.mode1v3 !default.mode1v3 *.mode2v3 !default.mode2v3 *.perspectivev3 !default.perspectivev3 xcuserdata *.xccheckout *.moved-aside DerivedData *.hmap *.ipa *.xcuserstate project.xcworkspace # Android/IJ # .classpath .cxx .gradle .idea .project .settings local.properties android.iml # Cocoapods # example/ios/Pods # Ruby example/vendor/ # node.js # node_modules/ npm-debug.log yarn-debug.log yarn-error.log .env # BUCK buck-out/ \.buckd/ android/app/libs android/keystores/debug.keystore # Expo .expo/ # Turborepo .turbo/ # generated by bob lib/ # user files backlog.md ================================================ FILE: .nvmrc ================================================ v18 ================================================ FILE: .watchmanconfig ================================================ {} ================================================ FILE: .yarnrc ================================================ # Override Yarn command so we can automatically setup the repo on running `yarn` yarn-path "scripts/bootstrap.js" ================================================ FILE: CODE_OF_CONDUCT.md ================================================ # Contributor Covenant Code of Conduct ## Our Pledge We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation. We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community. ## Our Standards Examples of behavior that contributes to a positive environment for our community include: * Demonstrating empathy and kindness toward other people * Being respectful of differing opinions, viewpoints, and experiences * Giving and gracefully accepting constructive feedback * Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience * Focusing on what is best not just for us as individuals, but for the overall community Examples of unacceptable behavior include: * The use of sexualized language or imagery, and sexual attention or advances of any kind * Trolling, insulting or derogatory comments, and personal or political attacks * Public or private harassment * Publishing others' private information, such as a physical or email address, without their explicit permission * Other conduct which could reasonably be considered inappropriate in a professional setting ## Enforcement Responsibilities Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful. Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate. ## Scope This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. ## Enforcement Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [INSERT CONTACT METHOD]. All complaints will be reviewed and investigated promptly and fairly. All community leaders are obligated to respect the privacy and security of the reporter of any incident. ## Enforcement Guidelines Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct: ### 1. Correction **Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community. **Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested. ### 2. Warning **Community Impact**: A violation through a single incident or series of actions. **Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban. ### 3. Temporary Ban **Community Impact**: A serious violation of community standards, including sustained inappropriate behavior. **Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban. ### 4. Permanent Ban **Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals. **Consequence**: A permanent ban from any sort of public interaction within the community. ## Attribution This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC]. For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at [https://www.contributor-covenant.org/translations][translations]. [homepage]: https://www.contributor-covenant.org [v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html [Mozilla CoC]: https://github.com/mozilla/diversity [FAQ]: https://www.contributor-covenant.org/faq [translations]: https://www.contributor-covenant.org/translations ================================================ FILE: CONTRIBUTING.md ================================================ # Contributing Contributions are always welcome, no matter how large or small! We want this community to be friendly and respectful to each other. Please follow it in all your interactions with the project. Before contributing, please read the [code of conduct](./CODE_OF_CONDUCT.md). ## Development workflow To get started with the project, run `yarn` in the root directory to install the required dependencies for each package: ```sh yarn ``` > While it's possible to use [`npm`](https://github.com/npm/cli), the tooling is built around [`yarn`](https://classic.yarnpkg.com/), so you'll have an easier time if you use `yarn` for development. While developing, you can run the [example app](/example/) to test your changes. Any changes you make in your library's JavaScript code will be reflected in the example app without a rebuild. If you change any native code, then you'll need to rebuild the example app. To start the packager: ```sh yarn example start ``` To run the example app on Android: ```sh yarn example android ``` To run the example app on iOS: ```sh yarn example ios ``` To run the example app on Web: ```sh yarn example web ``` Make sure your code passes TypeScript and ESLint. Run the following to verify: ```sh yarn typecheck yarn lint ``` To fix formatting errors, run the following: ```sh yarn lint --fix ``` Remember to add tests for your change if possible. Run the unit tests by: ```sh yarn test ``` ### Commit message convention We follow the [conventional commits specification](https://www.conventionalcommits.org/en) for our commit messages: - `fix`: bug fixes, e.g. fix crash due to deprecated method. - `feat`: new features, e.g. add new method to the module. - `refactor`: code refactor, e.g. migrate from class components to hooks. - `docs`: changes into documentation, e.g. add usage example for the module.. - `test`: adding or updating tests, e.g. add integration tests using detox. - `chore`: tooling changes, e.g. change CI config. - `perf`: changes that improve performance - `improvement`: changes that improve a current implementation - `style`: syntax formatting Our pre-commit hooks verify that your commit message matches this format when committing. ### Linting and tests [ESLint](https://eslint.org/), [Prettier](https://prettier.io/), [TypeScript](https://www.typescriptlang.org/) We use [TypeScript](https://www.typescriptlang.org/) for type checking, [ESLint](https://eslint.org/) with [Prettier](https://prettier.io/) for linting and formatting the code, and [Jest](https://jestjs.io/) for testing. Our pre-commit hooks verify that the linter and tests pass when committing. ### Publishing to npm We use [release-it](https://github.com/release-it/release-it) to make it easier to publish new versions. It handles common tasks like bumping version based on semver, creating tags and releases etc. To publish new versions, run the following: ```sh yarn release ``` ### Scripts The `package.json` file contains various scripts for common tasks: - `yarn bootstrap`: setup project by installing all dependencies and pods. - `yarn typecheck`: type-check files with TypeScript. - `yarn lint`: lint files with ESLint. - `yarn test`: run unit tests with Jest. - `yarn example start`: start the Metro server for the example app. - `yarn example android`: run the example app on Android. - `yarn example ios`: run the example app on iOS. ### Sending a pull request > **Working on your first pull request?** You can learn how from this _free_ series: [How to Contribute to an Open Source Project on GitHub](https://app.egghead.io/playlists/how-to-contribute-to-an-open-source-project-on-github). When you're sending a pull request: - Prefer small pull requests focused on one change. - Verify that linters and tests are passing. - Review the documentation to make sure it looks good. - Follow the pull request template when opening a pull request. - For pull requests that change the API or implementation, discuss with maintainers first by opening an issue. Thanks for your contributions 💖 ================================================ FILE: LICENSE ================================================ MIT License Copyright (c) 2023 Devvie 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. ================================================ FILE: README.md ================================================ # React Native Bottom Sheet 💖 ![GitHub](https://img.shields.io/github/license/stanleyugwu/react-native-bottom-sheet?style=plastic&label=License&color=%23fea9f8) ![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/stanleyugwu/react-native-bottom-sheet/ci.yml?color=%23fea9f8&label=Build) [![runs with expo](https://img.shields.io/badge/Expo-Support-fea9f8.svg?style=platic&logo=EXPO&logoColor=fff)](https://expo.io/) ![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/stanleyugwu/react-native-bottom-sheet?color=%23fea9f8&label=Code%20Size) ![npm bundle size (scoped)](https://img.shields.io/bundlephobia/minzip/@devvie/bottom-sheet?style=plastic&logo=npm&color=%23fea9f8&label=Bundle%20Size) ![npm downloads](https://img.shields.io/npm/dm/@devvie/bottom-sheet?style=plastic&logo=npm&color=%23fea9f8&label=Downloads) The smart 😎, tiny 📦, and flexible 🎗 bottom sheet your app craves 🚀 --- 👉🏾 Buy Me A Coffee 👈🏾 --- ![Preview for Android & iOS](https://i.ibb.co/Y38XsMr/Combined.gif) #### Web Preview

## ✨Features - 📦 Very tiny and lightweight - 0️⃣ No dependency (yeah!, just plug and play 😎) - ✨ Modal and standard (non-modal) bottom sheet support - ⌨ Smart & automatic keyboard and orientation handling for iOS & Android - 💪 Imperative calls - 📜 Supports FlatList, SectionList, ScrollView & View scrolling interactions - 📟 Handles layout & orientation changes smartly - 💯 Compatible with Expo - 🔧 Flexible config - 🚀 Supports props live update - 🎞 Configurable animation - 🎨 Follows Material Design principles - 🌐 Runs on the web - ✅ Written in TypeScript ## 💻 Installation ```sh npm install @devvie/bottom-sheet ``` or ```sh yarn add @devvie/bottom-sheet ``` ## 📱 Minimal Usage Opening and closing the bottom sheet is done imperatively, so just pass a `ref` to the bottom sheet and call the `open` or `close` methods via the `ref` instance to open and close the bottom sheet respectively. ##### Examples #### Typescript ```tsx import React, { useRef } from 'react'; import BottomSheet, { BottomSheetMethods } from '@devvie/bottom-sheet'; import { Button, View } from 'react-native'; const App = () => { const sheetRef = useRef(null); return (