├── .editorconfig
├── .gitattributes
├── .github
├── actions
│ └── setup
│ │ └── action.yml
└── workflows
│ └── ci.yml
├── .gitignore
├── .nvmrc
├── .watchmanconfig
├── .yarn
├── install-state.gz
└── releases
│ └── yarn-4.4.1.cjs
├── .yarnrc.yml
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── babel.config.js
├── example
├── App.js
├── app.json
├── assets
│ ├── adaptive-icon.png
│ ├── favicon.png
│ ├── icon.png
│ └── splash.png
├── babel.config.js
├── metro.config.js
├── package-lock.json
├── package.json
├── src
│ ├── App.tsx
│ ├── HeadlessCollapsible
│ │ └── HeadlessCollapsible.tsx
│ └── SimpleCollapsible
│ │ └── SimpleCollapsible.tsx
├── tsconfig.json
└── webpack.config.js
├── lefthook.yml
├── package.json
├── scripts
└── bootstrap.js
├── src
├── Collapsible
│ ├── Collapsible.styles.ts
│ └── Collapsible.tsx
├── index.tsx
├── types.ts
└── useCollapsible.ts
├── tsconfig.build.json
├── tsconfig.json
└── yarn.lock
/.editorconfig:
--------------------------------------------------------------------------------
1 | # EditorConfig helps developers define and maintain consistent
2 | # coding styles between different editors and IDEs
3 | # editorconfig.org
4 |
5 | root = true
6 |
7 | [*]
8 |
9 | indent_style = space
10 | indent_size = 2
11 |
12 | end_of_line = lf
13 | charset = utf-8
14 | trim_trailing_whitespace = true
15 | insert_final_newline = true
16 |
--------------------------------------------------------------------------------
/.gitattributes:
--------------------------------------------------------------------------------
1 | *.pbxproj -text
2 | # specific for windows script files
3 | *.bat text eol=crlf
--------------------------------------------------------------------------------
/.github/actions/setup/action.yml:
--------------------------------------------------------------------------------
1 | name: Setup
2 | description: Setup Node.js and install dependencies
3 |
4 | runs:
5 | using: composite
6 | steps:
7 | - name: Setup Node.js
8 | uses: actions/setup-node@v3
9 | with:
10 | node-version-file: .nvmrc
11 |
12 | - name: Cache dependencies
13 | id: yarn-cache
14 | uses: actions/cache@v3
15 | with:
16 | path: |
17 | **/node_modules
18 | key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
19 | restore-keys: |
20 | ${{ runner.os }}-yarn-
21 |
22 | - name: Install dependencies
23 | if: steps.yarn-cache.outputs.cache-hit != 'true'
24 | run: yarn install --immutable --frozen-lockfile
25 | shell: bash
26 |
--------------------------------------------------------------------------------
/.github/workflows/ci.yml:
--------------------------------------------------------------------------------
1 | name: CI
2 | on:
3 | push:
4 | branches:
5 | - main
6 | pull_request:
7 | branches:
8 | - main
9 | merge_group:
10 | types:
11 | - checks_requested
12 |
13 | jobs:
14 | lint:
15 | runs-on: ubuntu-latest
16 | steps:
17 | - name: Checkout
18 | uses: actions/checkout@v3
19 |
20 | - name: Setup
21 | uses: ./.github/actions/setup
22 |
23 | - name: Lint files
24 | run: yarn lint
25 |
26 | - name: Typecheck files
27 | run: yarn typecheck
28 |
29 | test:
30 | runs-on: ubuntu-latest
31 | steps:
32 | - name: Checkout
33 | uses: actions/checkout@v3
34 |
35 | - name: Setup
36 | uses: ./.github/actions/setup
37 |
38 | - name: Run unit tests
39 | run: yarn test --maxWorkers=2 --coverage --passWithNoTests
40 |
41 | build-library:
42 | runs-on: ubuntu-latest
43 | steps:
44 | - name: Checkout
45 | uses: actions/checkout@v3
46 |
47 | - name: Setup
48 | uses: ./.github/actions/setup
49 |
50 | - name: Build package
51 | run: yarn prepack
52 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # OSX
2 | #
3 | .DS_Store
4 |
5 | # XDE
6 | .expo/
7 |
8 | # VSCode
9 | .vscode/
10 | jsconfig.json
11 |
12 | # Xcode
13 | #
14 | build/
15 | *.pbxuser
16 | !default.pbxuser
17 | *.mode1v3
18 | !default.mode1v3
19 | *.mode2v3
20 | !default.mode2v3
21 | *.perspectivev3
22 | !default.perspectivev3
23 | xcuserdata
24 | *.xccheckout
25 | *.moved-aside
26 | DerivedData
27 | *.hmap
28 | *.ipa
29 | *.xcuserstate
30 | project.xcworkspace
31 |
32 | # Android/IJ
33 | #
34 | .classpath
35 | .cxx
36 | .gradle
37 | .idea
38 | .project
39 | .settings
40 | local.properties
41 | android.iml
42 |
43 | # Cocoapods
44 | #
45 | example/ios/Pods
46 |
47 | # Ruby
48 | example/vendor/
49 |
50 | # node.js
51 | #
52 | node_modules/
53 | npm-debug.log
54 | yarn-debug.log
55 | yarn-error.log
56 |
57 | # BUCK
58 | buck-out/
59 | \.buckd/
60 | android/app/libs
61 | android/keystores/debug.keystore
62 |
63 | # Expo
64 | .expo/
65 |
66 | # Turborepo
67 | .turbo/
68 |
69 | # generated by bob
70 | lib/
71 |
72 | .yarn/cache/
--------------------------------------------------------------------------------
/.nvmrc:
--------------------------------------------------------------------------------
1 | v18
2 |
--------------------------------------------------------------------------------
/.watchmanconfig:
--------------------------------------------------------------------------------
1 | {}
--------------------------------------------------------------------------------
/.yarn/install-state.gz:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/lukaszkurantdev/react-native-fast-collapsible/b7b67c13474417d1bcb52319f6966dc9dd19448f/.yarn/install-state.gz
--------------------------------------------------------------------------------
/.yarnrc.yml:
--------------------------------------------------------------------------------
1 | checksumBehavior: update
2 |
3 | compressionLevel: mixed
4 |
5 | enableGlobalCache: false
6 |
7 | nmHoistingLimits: workspaces
8 |
9 | nodeLinker: node-modules
10 |
11 | yarnPath: .yarn/releases/yarn-4.4.1.cjs
12 |
--------------------------------------------------------------------------------
/CODE_OF_CONDUCT.md:
--------------------------------------------------------------------------------
1 |
2 | # Contributor Covenant Code of Conduct
3 |
4 | ## Our Pledge
5 |
6 | We as members, contributors, and leaders pledge to make participation in our
7 | community a harassment-free experience for everyone, regardless of age, body
8 | size, visible or invisible disability, ethnicity, sex characteristics, gender
9 | identity and expression, level of experience, education, socio-economic status,
10 | nationality, personal appearance, race, caste, color, religion, or sexual
11 | identity and orientation.
12 |
13 | We pledge to act and interact in ways that contribute to an open, welcoming,
14 | diverse, inclusive, and healthy community.
15 |
16 | ## Our Standards
17 |
18 | Examples of behavior that contributes to a positive environment for our
19 | community include:
20 |
21 | * Demonstrating empathy and kindness toward other people
22 | * Being respectful of differing opinions, viewpoints, and experiences
23 | * Giving and gracefully accepting constructive feedback
24 | * Accepting responsibility and apologizing to those affected by our mistakes,
25 | and learning from the experience
26 | * Focusing on what is best not just for us as individuals, but for the overall
27 | community
28 |
29 | Examples of unacceptable behavior include:
30 |
31 | * The use of sexualized language or imagery, and sexual attention or advances of
32 | any kind
33 | * Trolling, insulting or derogatory comments, and personal or political attacks
34 | * Public or private harassment
35 | * Publishing others' private information, such as a physical or email address,
36 | without their explicit permission
37 | * Other conduct which could reasonably be considered inappropriate in a
38 | professional setting
39 |
40 | ## Enforcement Responsibilities
41 |
42 | Community leaders are responsible for clarifying and enforcing our standards of
43 | acceptable behavior and will take appropriate and fair corrective action in
44 | response to any behavior that they deem inappropriate, threatening, offensive,
45 | or harmful.
46 |
47 | Community leaders have the right and responsibility to remove, edit, or reject
48 | comments, commits, code, wiki edits, issues, and other contributions that are
49 | not aligned to this Code of Conduct, and will communicate reasons for moderation
50 | decisions when appropriate.
51 |
52 | ## Scope
53 |
54 | This Code of Conduct applies within all community spaces, and also applies when
55 | an individual is officially representing the community in public spaces.
56 | Examples of representing our community include using an official e-mail address,
57 | posting via an official social media account, or acting as an appointed
58 | representative at an online or offline event.
59 |
60 | ## Enforcement
61 |
62 | Instances of abusive, harassing, or otherwise unacceptable behavior may be
63 | reported to the community leaders responsible for enforcement at
64 | [INSERT CONTACT METHOD].
65 | All complaints will be reviewed and investigated promptly and fairly.
66 |
67 | All community leaders are obligated to respect the privacy and security of the
68 | reporter of any incident.
69 |
70 | ## Enforcement Guidelines
71 |
72 | Community leaders will follow these Community Impact Guidelines in determining
73 | the consequences for any action they deem in violation of this Code of Conduct:
74 |
75 | ### 1. Correction
76 |
77 | **Community Impact**: Use of inappropriate language or other behavior deemed
78 | unprofessional or unwelcome in the community.
79 |
80 | **Consequence**: A private, written warning from community leaders, providing
81 | clarity around the nature of the violation and an explanation of why the
82 | behavior was inappropriate. A public apology may be requested.
83 |
84 | ### 2. Warning
85 |
86 | **Community Impact**: A violation through a single incident or series of
87 | actions.
88 |
89 | **Consequence**: A warning with consequences for continued behavior. No
90 | interaction with the people involved, including unsolicited interaction with
91 | those enforcing the Code of Conduct, for a specified period of time. This
92 | includes avoiding interactions in community spaces as well as external channels
93 | like social media. Violating these terms may lead to a temporary or permanent
94 | ban.
95 |
96 | ### 3. Temporary Ban
97 |
98 | **Community Impact**: A serious violation of community standards, including
99 | sustained inappropriate behavior.
100 |
101 | **Consequence**: A temporary ban from any sort of interaction or public
102 | communication with the community for a specified period of time. No public or
103 | private interaction with the people involved, including unsolicited interaction
104 | with those enforcing the Code of Conduct, is allowed during this period.
105 | Violating these terms may lead to a permanent ban.
106 |
107 | ### 4. Permanent Ban
108 |
109 | **Community Impact**: Demonstrating a pattern of violation of community
110 | standards, including sustained inappropriate behavior, harassment of an
111 | individual, or aggression toward or disparagement of classes of individuals.
112 |
113 | **Consequence**: A permanent ban from any sort of public interaction within the
114 | community.
115 |
116 | ## Attribution
117 |
118 | This Code of Conduct is adapted from the [Contributor Covenant][homepage],
119 | version 2.1, available at
120 | [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
121 |
122 | Community Impact Guidelines were inspired by
123 | [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
124 |
125 | For answers to common questions about this code of conduct, see the FAQ at
126 | [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
127 | [https://www.contributor-covenant.org/translations][translations].
128 |
129 | [homepage]: https://www.contributor-covenant.org
130 | [v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
131 | [Mozilla CoC]: https://github.com/mozilla/diversity
132 | [FAQ]: https://www.contributor-covenant.org/faq
133 | [translations]: https://www.contributor-covenant.org/translations
134 |
--------------------------------------------------------------------------------
/CONTRIBUTING.md:
--------------------------------------------------------------------------------
1 | # Contributing
2 |
3 | Contributions are always welcome, no matter how large or small!
4 |
5 | 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).
6 |
7 | ## Development workflow
8 |
9 | To get started with the project, run `yarn` in the root directory to install the required dependencies for each package:
10 |
11 | ```sh
12 | yarn
13 | ```
14 |
15 | > 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.
16 |
17 | 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.
18 |
19 | To start the packager:
20 |
21 | ```sh
22 | yarn example start
23 | ```
24 |
25 | To run the example app on Android:
26 |
27 | ```sh
28 | yarn example android
29 | ```
30 |
31 | To run the example app on iOS:
32 |
33 | ```sh
34 | yarn example ios
35 | ```
36 |
37 | To run the example app on Web:
38 |
39 | ```sh
40 | yarn example web
41 | ```
42 |
43 | Make sure your code passes TypeScript and ESLint. Run the following to verify:
44 |
45 | ```sh
46 | yarn typecheck
47 | yarn lint
48 | ```
49 |
50 | To fix formatting errors, run the following:
51 |
52 | ```sh
53 | yarn lint --fix
54 | ```
55 |
56 | Remember to add tests for your change if possible. Run the unit tests by:
57 |
58 | ```sh
59 | yarn test
60 | ```
61 |
62 |
63 | ### Commit message convention
64 |
65 | We follow the [conventional commits specification](https://www.conventionalcommits.org/en) for our commit messages:
66 |
67 | - `fix`: bug fixes, e.g. fix crash due to deprecated method.
68 | - `feat`: new features, e.g. add new method to the module.
69 | - `refactor`: code refactor, e.g. migrate from class components to hooks.
70 | - `docs`: changes into documentation, e.g. add usage example for the module..
71 | - `test`: adding or updating tests, e.g. add integration tests using detox.
72 | - `chore`: tooling changes, e.g. change CI config.
73 |
74 | Our pre-commit hooks verify that your commit message matches this format when committing.
75 |
76 | ### Linting and tests
77 |
78 | [ESLint](https://eslint.org/), [Prettier](https://prettier.io/), [TypeScript](https://www.typescriptlang.org/)
79 |
80 | 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.
81 |
82 | Our pre-commit hooks verify that the linter and tests pass when committing.
83 |
84 | ### Publishing to npm
85 |
86 | 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.
87 |
88 | To publish new versions, run the following:
89 |
90 | ```sh
91 | yarn release
92 | ```
93 |
94 | ### Scripts
95 |
96 | The `package.json` file contains various scripts for common tasks:
97 |
98 | - `yarn bootstrap`: setup project by installing all dependencies and pods.
99 | - `yarn typecheck`: type-check files with TypeScript.
100 | - `yarn lint`: lint files with ESLint.
101 | - `yarn test`: run unit tests with Jest.
102 | - `yarn example start`: start the Metro server for the example app.
103 | - `yarn example android`: run the example app on Android.
104 | - `yarn example ios`: run the example app on iOS.
105 |
106 | ### Sending a pull request
107 |
108 | > **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).
109 |
110 | When you're sending a pull request:
111 |
112 | - Prefer small pull requests focused on one change.
113 | - Verify that linters and tests are passing.
114 | - Review the documentation to make sure it looks good.
115 | - Follow the pull request template when opening a pull request.
116 | - For pull requests that change the API or implementation, discuss with maintainers first by opening an issue.
117 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) 2023 Lukasz Kurant
4 | Permission is hereby granted, free of charge, to any person obtaining a copy
5 | of this software and associated documentation files (the "Software"), to deal
6 | in the Software without restriction, including without limitation the rights
7 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 | copies of the Software, and to permit persons to whom the Software is
9 | furnished to do so, subject to the following conditions:
10 |
11 | The above copyright notice and this permission notice shall be included in all
12 | copies or substantial portions of the Software.
13 |
14 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20 | SOFTWARE.
21 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | 
2 |
3 | Pure Javascript library for React Native with super-fast collapsible component using Reanimated API. It works with Expo.
4 |
5 | - 🎙️ Works with Expo
6 | - 🪽 Easy usage
7 | - ⚠️ `react-native-reanimated` required
8 |
9 | ### Motivation
10 |
11 | There are currently many libraries available for Collapsible components, but they are either no longer supported or do not implement the latest innovations in the React Native architecture. Hence the need for a library that works with the new architecture based on the React Native Reanimated API V3 and allow to have always native performance.
12 |
13 | ### Installation
14 |
15 | ```sh
16 | yarn add react-native-fast-collapsible
17 | ```
18 |
19 | This library has a peer dependency on react-native-reanimated has to be installed, linked and configured into your project. Follow [react-native-reanimated](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/getting-started) to install the dependency.
20 |
21 | ### Usage / API
22 |
23 | #### Collapsible component
24 |
25 | A simple component that enables an animated action to hide and show content.
26 |
27 | https://github.com/user-attachments/assets/e74700c5-d1b9-4559-9b9b-940bd02d684f
28 |
29 | #### Example
30 |
31 | ```jsx
32 | import React, { useState } from 'react';
33 |
34 | import { StyleSheet, Text, TouchableOpacity, View } from 'react-native';
35 | import { Collapsible } from 'react-native-fast-collapsible';
36 |
37 | export default function SimpleCollapsible() {
38 | const [isVisible, setVisibility] = useState(false);
39 |
40 | const toggleVisibility = () => {
41 | setVisibility((previous) => !previous);
42 | };
43 |
44 | return (
45 |
46 |
47 | Expand / Collapse
48 |
49 |
50 |
51 | Lorem ipsum....
52 |
53 |
54 | );
55 | }
56 | ```
57 |
58 | #### Properties
59 |
60 | | Property | Type | Description | Default |
61 | | ------------------ | ----------- | ------------------------------------------- | --------------- |
62 | | **`isVisible`** | `boolean` | Whether to show the child components or not | `top` |
63 | | **`heightOffset`** | `number` | Offset of collapsed children visible | `0` |
64 | | **`duration`** | `number` | Time in ms of animation | `300` |
65 | | **`easing`** | `Easing` | Type of animation from Reanimated | `Easing.linear` |
66 | | **`children`** | `ReactNode` | Children to show or hide | – |
67 |
68 | ### useCollapsible hook
69 |
70 | Headless hook to create your own collapsible components.
71 |
72 | https://github.com/user-attachments/assets/aef8cf7a-bbb0-4d1d-96ea-452e3e3be2f2
73 |
74 | #### Example
75 |
76 | ```jsx
77 | import React, { useState } from 'react';
78 |
79 | import { StyleSheet, Text, TouchableOpacity, View } from 'react-native';
80 | import { useCollapsible } from 'react-native-fast-collapsible';
81 | import Animated, {
82 | Easing,
83 | interpolate,
84 | useAnimatedStyle,
85 | } from 'react-native-reanimated';
86 |
87 | export default function HeadlessCollapsible() {
88 | const [isVisible, setVisibility] = useState(false);
89 |
90 | const { animatedStyles, onLayout, height, maxHeight } = useCollapsible({
91 | isVisible,
92 | easing: Easing.bounce,
93 | duration: 1000,
94 | });
95 |
96 | const toggleVisibility = () => {
97 | setVisibility((previous) => !previous);
98 | };
99 |
100 | const arrowStyles = useAnimatedStyle(() => {
101 | const degree = interpolate(height.value, [0, maxHeight], [0, 180]);
102 |
103 | return {
104 | transform: [{ rotate: `${degree}deg` }],
105 | };
106 | });
107 |
108 | return (
109 |
110 |
114 | Expand / Collapse
115 | ↓
116 |
117 |
118 |
122 |
123 | Lorem ipsum...
124 |
125 |
126 |
127 | );
128 | }
129 | ```
130 |
131 | #### Config object options
132 |
133 | | Property | Type | Description | Default |
134 | | ------------------ | --------- | ------------------------------------------- | --------------- |
135 | | **`isVisible`** | `boolean` | Whether to show the child components or not | `top` |
136 | | **`heightOffset`** | `number` | Offset of collapsed children visible | `0` |
137 | | **`duration`** | `number` | Time in ms of animation | `300` |
138 | | **`easing`** | `Easing` | Type of animation from Reanimated | `Easing.linear` |
139 |
140 | #### Hook returned object
141 |
142 | | Property | Type | Description |
143 | | -------------------- | ------------------------------------ | ---------------------------------------------- |
144 | | **`onLayout`** | `(event: LayoutChangeEvent) => void` | Function need to be used on children container |
145 | | **`height`** | `SharedValue` | Reanimated shared value with current height |
146 | | **`animatedStyles`** | `number` | Styles of children container |
147 | | **`maxHeight`** | `number` | Children max height |
148 |
149 | ### Contributing
150 |
151 | See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
152 |
153 | ## License
154 |
155 | MIT © 2023-2024 Lukasz Kurant
156 |
--------------------------------------------------------------------------------
/babel.config.js:
--------------------------------------------------------------------------------
1 | module.exports = {
2 | presets: ['module:metro-react-native-babel-preset'],
3 | plugins: ['react-native-reanimated/plugin'],
4 | };
5 |
--------------------------------------------------------------------------------
/example/App.js:
--------------------------------------------------------------------------------
1 | export { default } from './src/App';
2 |
--------------------------------------------------------------------------------
/example/app.json:
--------------------------------------------------------------------------------
1 | {
2 | "expo": {
3 | "name": "example",
4 | "slug": "example",
5 | "version": "1.0.0",
6 | "orientation": "portrait",
7 | "icon": "./assets/icon.png",
8 | "userInterfaceStyle": "light",
9 | "splash": {
10 | "image": "./assets/splash.png",
11 | "resizeMode": "contain",
12 | "backgroundColor": "#ffffff"
13 | },
14 | "assetBundlePatterns": [
15 | "**/*"
16 | ],
17 | "ios": {
18 | "supportsTablet": true
19 | },
20 | "android": {
21 | "adaptiveIcon": {
22 | "foregroundImage": "./assets/adaptive-icon.png",
23 | "backgroundColor": "#ffffff"
24 | }
25 | },
26 | "web": {
27 | "favicon": "./assets/favicon.png"
28 | }
29 | }
30 | }
31 |
--------------------------------------------------------------------------------
/example/assets/adaptive-icon.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/lukaszkurantdev/react-native-fast-collapsible/b7b67c13474417d1bcb52319f6966dc9dd19448f/example/assets/adaptive-icon.png
--------------------------------------------------------------------------------
/example/assets/favicon.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/lukaszkurantdev/react-native-fast-collapsible/b7b67c13474417d1bcb52319f6966dc9dd19448f/example/assets/favicon.png
--------------------------------------------------------------------------------
/example/assets/icon.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/lukaszkurantdev/react-native-fast-collapsible/b7b67c13474417d1bcb52319f6966dc9dd19448f/example/assets/icon.png
--------------------------------------------------------------------------------
/example/assets/splash.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/lukaszkurantdev/react-native-fast-collapsible/b7b67c13474417d1bcb52319f6966dc9dd19448f/example/assets/splash.png
--------------------------------------------------------------------------------
/example/babel.config.js:
--------------------------------------------------------------------------------
1 | const path = require('path');
2 | const pak = require('../package.json');
3 |
4 | module.exports = function (api) {
5 | api.cache(true);
6 |
7 | return {
8 | presets: ['babel-preset-expo'],
9 | plugins: [
10 | [
11 | 'module-resolver',
12 | {
13 | extensions: ['.tsx', '.ts', '.js', '.json'],
14 | alias: {
15 | // For development, we want to alias the library to the source
16 | [pak.name]: path.join(__dirname, '..', pak.source),
17 | },
18 | },
19 | ],
20 | ['react-native-reanimated/plugin'],
21 | ],
22 | };
23 | };
24 |
--------------------------------------------------------------------------------
/example/metro.config.js:
--------------------------------------------------------------------------------
1 | const path = require('path');
2 | const escape = require('escape-string-regexp');
3 | const { getDefaultConfig } = require('@expo/metro-config');
4 | const exclusionList = require('metro-config/src/defaults/exclusionList');
5 | const pak = require('../package.json');
6 |
7 | const root = path.resolve(__dirname, '..');
8 | const modules = Object.keys({ ...pak.peerDependencies });
9 |
10 | const defaultConfig = getDefaultConfig(__dirname);
11 |
12 | /**
13 | * Metro configuration
14 | * https://facebook.github.io/metro/docs/configuration
15 | *
16 | * @type {import('metro-config').MetroConfig}
17 | */
18 | const config = {
19 | ...defaultConfig,
20 |
21 | projectRoot: __dirname,
22 | watchFolders: [root],
23 |
24 | // We need to make sure that only one version is loaded for peerDependencies
25 | // So we block them at the root, and alias them to the versions in example's node_modules
26 | resolver: {
27 | ...defaultConfig.resolver,
28 |
29 | blacklistRE: exclusionList(
30 | modules.map(
31 | (m) =>
32 | new RegExp(`^${escape(path.join(root, 'node_modules', m))}\\/.*$`)
33 | )
34 | ),
35 |
36 | extraNodeModules: modules.reduce((acc, name) => {
37 | acc[name] = path.join(__dirname, 'node_modules', name);
38 | return acc;
39 | }, {}),
40 | },
41 | };
42 |
43 | module.exports = config;
44 |
--------------------------------------------------------------------------------
/example/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "example",
3 | "version": "1.0.0",
4 | "main": "node_modules/expo/AppEntry.js",
5 | "scripts": {
6 | "start": "expo start",
7 | "android": "expo start --android",
8 | "ios": "expo start --ios",
9 | "web": "expo start --web"
10 | },
11 | "dependencies": {
12 | "expo": "^51.0.31",
13 | "expo-status-bar": "~1.12.1",
14 | "react": "18.2.0",
15 | "react-dom": "18.2.0",
16 | "react-native": "0.74.5",
17 | "react-native-reanimated": "~3.10.1",
18 | "react-native-web": "~0.19.10"
19 | },
20 | "devDependencies": {
21 | "@babel/core": "^7.24.0",
22 | "@expo/webpack-config": "~19.0.1",
23 | "babel-loader": "^8.1.0",
24 | "babel-plugin-module-resolver": "^5.0.0"
25 | },
26 | "private": true
27 | }
28 |
--------------------------------------------------------------------------------
/example/src/App.tsx:
--------------------------------------------------------------------------------
1 | import React from 'react';
2 |
3 | import { SafeAreaView, StyleSheet, View } from 'react-native';
4 |
5 | import SimpleCollapsible from './SimpleCollapsible/SimpleCollapsible';
6 | import HeadlessCollapsible from './HeadlessCollapsible/HeadlessCollapsible';
7 |
8 | export default function App() {
9 | return (
10 |
11 |
12 |
13 |
14 |
15 |
16 | );
17 | }
18 |
19 | const styles = StyleSheet.create({
20 | container: {
21 | paddingTop: 100,
22 | padding: 20,
23 | rowGap: 50,
24 | },
25 | });
26 |
--------------------------------------------------------------------------------
/example/src/HeadlessCollapsible/HeadlessCollapsible.tsx:
--------------------------------------------------------------------------------
1 | import React, { useState } from 'react';
2 |
3 | import { StyleSheet, Text, TouchableOpacity, View } from 'react-native';
4 | import { useCollapsible } from 'react-native-fast-collapsible';
5 | import Animated, {
6 | Easing,
7 | interpolate,
8 | useAnimatedStyle,
9 | } from 'react-native-reanimated';
10 |
11 | export default function HeadlessCollapsible() {
12 | const [isVisible, setVisibility] = useState(false);
13 |
14 | const { animatedStyles, onLayout, height, maxHeight } = useCollapsible({
15 | isVisible,
16 | easing: Easing.bounce,
17 | duration: 1000,
18 | });
19 |
20 | const toggleVisibility = () => {
21 | setVisibility((previous) => !previous);
22 | };
23 |
24 | const arrowStyles = useAnimatedStyle(() => {
25 | const degree = interpolate(height.value, [0, maxHeight], [0, 180]);
26 |
27 | return {
28 | transform: [{ rotate: `${degree}deg` }],
29 | };
30 | });
31 |
32 | return (
33 |
34 |
38 | Expand / Collapse
39 | ↓
40 |
41 |
42 |
46 | {/* @ts-ignore */}
47 |
48 |
49 | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do
50 | eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim
51 | ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut
52 | aliquip ex ea commodo consequat. Duis aute irure dolor in
53 | reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla
54 | pariatur. Excepteur sint occaecat cupidatat non proident, sunt in
55 | culpa qui officia deserunt mollit anim id est laborum.
56 |
57 |
58 |
59 |
60 |
61 | Sed ut perspiciatis unde omnis iste natus error sit voluptatem
62 | accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab
63 | illo inventore veritatis et quasi architecto beatae vitae dicta sunt
64 | explicabo.
65 |
66 |
67 | );
68 | }
69 |
70 | const styles = StyleSheet.create({
71 | container: {
72 | rowGap: 20,
73 | },
74 | overflowHidden: {
75 | overflow: 'hidden',
76 | },
77 | collapsibleContainer: {
78 | position: 'absolute',
79 | top: 0,
80 | left: 0,
81 | right: 0,
82 | },
83 | buttonContainer: {
84 | justifyContent: 'space-between',
85 | flexDirection: 'row',
86 | },
87 | });
88 |
--------------------------------------------------------------------------------
/example/src/SimpleCollapsible/SimpleCollapsible.tsx:
--------------------------------------------------------------------------------
1 | import React, { useState } from 'react';
2 |
3 | import { StyleSheet, Text, TouchableOpacity, View } from 'react-native';
4 | import { Collapsible } from 'react-native-fast-collapsible';
5 |
6 | export default function SimpleCollapsible() {
7 | const [isVisible, setVisibility] = useState(false);
8 |
9 | const toggleVisibility = () => {
10 | setVisibility((previous) => !previous);
11 | };
12 |
13 | return (
14 |
15 |
16 | Expand / Collapse
17 |
18 |
19 |
20 |
21 | Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do
22 | eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad
23 | minim veniam, quis nostrud exercitation ullamco laboris nisi ut
24 | aliquip ex ea commodo consequat. Duis aute irure dolor in
25 | reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla
26 | pariatur. Excepteur sint occaecat cupidatat non proident, sunt in
27 | culpa qui officia deserunt mollit anim id est laborum.
28 |
29 |
30 |
31 | Sed ut perspiciatis unde omnis iste natus error sit voluptatem
32 | accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab
33 | illo inventore veritatis et quasi architecto beatae vitae dicta sunt
34 | explicabo.
35 |
36 |
37 | );
38 | }
39 |
40 | const styles = StyleSheet.create({
41 | container: {
42 | rowGap: 10,
43 | },
44 | });
45 |
--------------------------------------------------------------------------------
/example/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "extends": "../tsconfig",
3 | "compilerOptions": {
4 | // Avoid expo-cli auto-generating a tsconfig
5 | }
6 | }
7 |
--------------------------------------------------------------------------------
/example/webpack.config.js:
--------------------------------------------------------------------------------
1 | const path = require('path');
2 | const createExpoWebpackConfigAsync = require('@expo/webpack-config');
3 | const { resolver } = require('./metro.config');
4 |
5 | const root = path.resolve(__dirname, '..');
6 | const node_modules = path.join(__dirname, 'node_modules');
7 |
8 | module.exports = async function (env, argv) {
9 | const config = await createExpoWebpackConfigAsync(env, argv);
10 |
11 | config.module.rules.push({
12 | test: /\.(js|jsx|ts|tsx)$/,
13 | include: path.resolve(root, 'src'),
14 | use: 'babel-loader',
15 | });
16 |
17 | // We need to make sure that only one version is loaded for peerDependencies
18 | // So we alias them to the versions in example's node_modules
19 | Object.assign(config.resolve.alias, {
20 | ...resolver.extraNodeModules,
21 | 'react-native-web': path.join(node_modules, 'react-native-web'),
22 | });
23 |
24 | return config;
25 | };
26 |
--------------------------------------------------------------------------------
/lefthook.yml:
--------------------------------------------------------------------------------
1 | pre-commit:
2 | parallel: true
3 | commands:
4 | lint:
5 | files: git diff --name-only @{push}
6 | glob: "*.{js,ts,jsx,tsx}"
7 | run: npx eslint {files}
8 | types:
9 | files: git diff --name-only @{push}
10 | glob: "*.{js,ts, jsx, tsx}"
11 | run: npx tsc --noEmit
12 | commit-msg:
13 | parallel: true
14 | commands:
15 | commitlint:
16 | run: npx commitlint --edit
17 |
--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "react-native-fast-collapsible",
3 | "version": "1.1.2",
4 | "description": "Pure Javascript library for React Native with super-fast collapsible component using Reanimated v3 API.",
5 | "main": "lib/commonjs/index",
6 | "module": "lib/module/index",
7 | "types": "lib/typescript/index.d.ts",
8 | "react-native": "src/index",
9 | "source": "src/index",
10 | "files": [
11 | "src",
12 | "lib",
13 | "android",
14 | "ios",
15 | "cpp",
16 | "*.podspec",
17 | "!lib/typescript/example",
18 | "!ios/build",
19 | "!android/build",
20 | "!android/gradle",
21 | "!android/gradlew",
22 | "!android/gradlew.bat",
23 | "!android/local.properties",
24 | "!**/__tests__",
25 | "!**/__fixtures__",
26 | "!**/__mocks__",
27 | "!**/.*"
28 | ],
29 | "scripts": {
30 | "test": "jest",
31 | "typecheck": "tsc --noEmit",
32 | "lint": "eslint \"**/*.{js,ts,tsx}\"",
33 | "prepack": "bob build",
34 | "release": "release-it",
35 | "example": "yarn --cwd example",
36 | "bootstrap": "yarn example && yarn install"
37 | },
38 | "keywords": [
39 | "react-native",
40 | "ios",
41 | "android"
42 | ],
43 | "repository": "https://github.com/lukaszkurantdev/react-native-fast-collapsible",
44 | "author": "Lukasz Kurant (https://lukaszkurant.com)",
45 | "license": "MIT",
46 | "bugs": {
47 | "url": "https://github.com/lukaszkurantdev/react-native-fast-collapsible/issues"
48 | },
49 | "homepage": "https://github.com/lukaszkurantdev/react-native-fast-collapsible#readme",
50 | "publishConfig": {
51 | "registry": "https://registry.npmjs.org/"
52 | },
53 | "devDependencies": {
54 | "@commitlint/config-conventional": "^17.0.2",
55 | "@evilmartians/lefthook": "^1.5.0",
56 | "@react-native-community/eslint-config": "^3.0.2",
57 | "@release-it/conventional-changelog": "^5.0.0",
58 | "@types/jest": "^28.1.2",
59 | "@types/react": "~17.0.21",
60 | "@types/react-native": "0.70.0",
61 | "commitlint": "^17.0.2",
62 | "del-cli": "^5.0.0",
63 | "eslint": "^8.4.1",
64 | "eslint-config-prettier": "^8.5.0",
65 | "eslint-plugin-prettier": "^4.0.0",
66 | "jest": "^28.1.1",
67 | "pod-install": "^0.1.0",
68 | "prettier": "^2.0.5",
69 | "react": "18.2.0",
70 | "react-native": "0.72.3",
71 | "react-native-builder-bob": "^0.21.3",
72 | "react-native-reanimated": "3.3.0",
73 | "release-it": "^15.0.0",
74 | "typescript": "^5.0.2"
75 | },
76 | "resolutions": {
77 | "@types/react": "17.0.21"
78 | },
79 | "peerDependencies": {
80 | "react": "*",
81 | "react-native": "*",
82 | "react-native-reanimated": "*"
83 | },
84 | "engines": {
85 | "node": ">= 16.0.0"
86 | },
87 | "packageManager": "yarn@4.4.1",
88 | "jest": {
89 | "preset": "react-native",
90 | "modulePathIgnorePatterns": [
91 | "/example/node_modules",
92 | "/lib/"
93 | ]
94 | },
95 | "commitlint": {
96 | "extends": [
97 | "@commitlint/config-conventional"
98 | ]
99 | },
100 | "release-it": {
101 | "git": {
102 | "commitMessage": "chore: release ${version}",
103 | "tagName": "v${version}"
104 | },
105 | "npm": {
106 | "publish": true
107 | },
108 | "github": {
109 | "release": true
110 | },
111 | "plugins": {
112 | "@release-it/conventional-changelog": {
113 | "preset": "angular"
114 | }
115 | }
116 | },
117 | "eslintConfig": {
118 | "root": true,
119 | "extends": [
120 | "@react-native-community",
121 | "prettier"
122 | ],
123 | "rules": {
124 | "prettier/prettier": [
125 | "error",
126 | {
127 | "quoteProps": "consistent",
128 | "singleQuote": true,
129 | "tabWidth": 2,
130 | "trailingComma": "es5",
131 | "useTabs": false
132 | }
133 | ]
134 | }
135 | },
136 | "eslintIgnore": [
137 | "node_modules/",
138 | "lib/"
139 | ],
140 | "prettier": {
141 | "quoteProps": "consistent",
142 | "singleQuote": true,
143 | "tabWidth": 2,
144 | "trailingComma": "es5",
145 | "useTabs": false
146 | },
147 | "react-native-builder-bob": {
148 | "source": "src",
149 | "output": "lib",
150 | "targets": [
151 | "commonjs",
152 | "module",
153 | [
154 | "typescript",
155 | {
156 | "project": "tsconfig.build.json"
157 | }
158 | ]
159 | ]
160 | }
161 | }
162 |
--------------------------------------------------------------------------------
/scripts/bootstrap.js:
--------------------------------------------------------------------------------
1 | const os = require('os');
2 | const path = require('path');
3 | const child_process = require('child_process');
4 |
5 | const root = path.resolve(__dirname, '..');
6 | const args = process.argv.slice(2);
7 | const options = {
8 | cwd: process.cwd(),
9 | env: process.env,
10 | stdio: 'inherit',
11 | encoding: 'utf-8',
12 | };
13 |
14 | if (os.type() === 'Windows_NT') {
15 | options.shell = true;
16 | }
17 |
18 | let result;
19 |
20 | if (process.cwd() !== root || args.length) {
21 | // We're not in the root of the project, or additional arguments were passed
22 | // In this case, forward the command to `yarn`
23 | result = child_process.spawnSync('yarn', args, options);
24 | } else {
25 | // If `yarn` is run without arguments, perform bootstrap
26 | result = child_process.spawnSync('yarn', ['bootstrap'], options);
27 | }
28 |
29 | process.exitCode = result.status;
30 |
--------------------------------------------------------------------------------
/src/Collapsible/Collapsible.styles.ts:
--------------------------------------------------------------------------------
1 | import { StyleSheet } from 'react-native';
2 |
3 | export const collapsibleStyles = StyleSheet.create({
4 | overflowHidden: {
5 | overflow: 'hidden',
6 | },
7 | container: {
8 | position: 'absolute',
9 | top: 0,
10 | left: 0,
11 | right: 0,
12 | },
13 | });
14 |
--------------------------------------------------------------------------------
/src/Collapsible/Collapsible.tsx:
--------------------------------------------------------------------------------
1 | import React, { type ReactNode } from 'react';
2 | import { useCollapsible } from '../useCollapsible';
3 | import Animated from 'react-native-reanimated';
4 |
5 | import { collapsibleStyles } from './Collapsible.styles';
6 | import type { CollapsibleConfig } from '../types';
7 |
8 | export type CollapsibleProps = CollapsibleConfig & {
9 | children?: ReactNode;
10 | };
11 |
12 | export function Collapsible(props: CollapsibleProps) {
13 | const { children, isVisible } = props;
14 |
15 | const { animatedStyles, onLayout } = useCollapsible(props);
16 |
17 | return (
18 |
22 |
23 | {children}
24 |
25 |
26 | );
27 | }
28 |
--------------------------------------------------------------------------------
/src/index.tsx:
--------------------------------------------------------------------------------
1 | export * from './useCollapsible';
2 | export * from './types';
3 | export * from './Collapsible/Collapsible';
4 |
--------------------------------------------------------------------------------
/src/types.ts:
--------------------------------------------------------------------------------
1 | import type Animated from 'react-native-reanimated';
2 |
3 | export type CollapsibleConfig = {
4 | heightOffset?: number;
5 | duration?: number;
6 | easing?: Animated.EasingFunction;
7 | isVisible: boolean;
8 | };
9 |
--------------------------------------------------------------------------------
/src/useCollapsible.ts:
--------------------------------------------------------------------------------
1 | import { useCallback, useEffect, useState } from 'react';
2 | import type { LayoutChangeEvent } from 'react-native';
3 | import {
4 | Easing,
5 | cancelAnimation,
6 | useAnimatedStyle,
7 | useSharedValue,
8 | withTiming,
9 | } from 'react-native-reanimated';
10 |
11 | import { type CollapsibleConfig } from './types';
12 |
13 | export function useCollapsible({
14 | isVisible,
15 | heightOffset = 0,
16 | duration = 300,
17 | easing = Easing.linear,
18 | }: CollapsibleConfig) {
19 | const [componentHeight, setComponentHeight] = useState(0);
20 | const height = useSharedValue(heightOffset);
21 |
22 | useEffect(() => {
23 | cancelAnimation(height);
24 | if (isVisible) {
25 | height.value = withTiming(componentHeight, { duration, easing });
26 | } else {
27 | height.value = withTiming(heightOffset, { duration, easing });
28 | }
29 | }, [componentHeight, height, duration, heightOffset, isVisible, easing]);
30 |
31 | const onLayout = useCallback(
32 | (event: LayoutChangeEvent) => {
33 | const measuredHeight = event.nativeEvent.layout.height;
34 |
35 | if (Math.round(componentHeight) !== Math.round(measuredHeight)) {
36 | setComponentHeight(measuredHeight);
37 | }
38 | },
39 | [componentHeight]
40 | );
41 |
42 | const animatedStyles = useAnimatedStyle(() => ({ height: height.value }));
43 |
44 | return {
45 | onLayout,
46 | height,
47 | animatedStyles,
48 | maxHeight: componentHeight,
49 | };
50 | }
51 |
--------------------------------------------------------------------------------
/tsconfig.build.json:
--------------------------------------------------------------------------------
1 |
2 | {
3 | "extends": "./tsconfig",
4 | "exclude": ["example"]
5 | }
6 |
--------------------------------------------------------------------------------
/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 | "compilerOptions": {
3 | "baseUrl": "./",
4 | "paths": {
5 | "react-native-fast-collapsible": ["./src/index"]
6 | },
7 | "allowUnreachableCode": false,
8 | "allowUnusedLabels": false,
9 | "esModuleInterop": true,
10 | "forceConsistentCasingInFileNames": true,
11 | "jsx": "react",
12 | "lib": ["esnext"],
13 | "module": "esnext",
14 | "moduleResolution": "node",
15 | "noFallthroughCasesInSwitch": true,
16 | "noImplicitReturns": true,
17 | "noImplicitUseStrict": false,
18 | "noStrictGenericChecks": false,
19 | "noUncheckedIndexedAccess": true,
20 | "noUnusedLocals": true,
21 | "noUnusedParameters": true,
22 | "resolveJsonModule": true,
23 | "skipLibCheck": true,
24 | "strict": true,
25 | "target": "esnext",
26 | "verbatimModuleSyntax": true
27 | }
28 | }
29 |
--------------------------------------------------------------------------------