├── .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 ├── example ├── App.js ├── app.json ├── assets │ ├── adaptive-icon.png │ ├── example1.gif │ ├── example2.gif │ ├── example3.gif │ ├── example5.gif │ ├── example6.gif │ ├── favicon.png │ ├── icon.png │ └── splash.png ├── babel.config.js ├── metro.config.js ├── package.json ├── src │ └── App.tsx ├── tsconfig.json ├── webpack.config.js └── yarn.lock ├── lefthook.yml ├── package.json ├── scripts └── bootstrap.js ├── src ├── CircularProgress.tsx ├── __tests__ │ └── index.test.tsx └── index.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: | 25 | yarn install --cwd example --frozen-lockfile 26 | yarn install --frozen-lockfile 27 | shell: bash 28 | -------------------------------------------------------------------------------- /.github/workflows/ci.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | on: 3 | push: 4 | branches: 5 | - main 6 | pull_request: 7 | branches: 8 | - main 9 | 10 | jobs: 11 | lint: 12 | runs-on: ubuntu-latest 13 | steps: 14 | - name: Checkout 15 | uses: actions/checkout@v3 16 | 17 | - name: Setup 18 | uses: ./.github/actions/setup 19 | 20 | - name: Lint files 21 | run: yarn lint 22 | 23 | - name: Typecheck files 24 | run: yarn typecheck 25 | 26 | test: 27 | runs-on: ubuntu-latest 28 | steps: 29 | - name: Checkout 30 | uses: actions/checkout@v3 31 | 32 | - name: Setup 33 | uses: ./.github/actions/setup 34 | 35 | - name: Run unit tests 36 | run: yarn test --maxWorkers=2 --coverage 37 | 38 | build: 39 | runs-on: ubuntu-latest 40 | steps: 41 | - name: Checkout 42 | uses: actions/checkout@v3 43 | 44 | - name: Setup 45 | uses: ./.github/actions/setup 46 | 47 | - name: Build package 48 | run: yarn prepack 49 | -------------------------------------------------------------------------------- /.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 | -------------------------------------------------------------------------------- /.nvmrc: -------------------------------------------------------------------------------- 1 | 16.18.1 2 | -------------------------------------------------------------------------------- /.watchmanconfig: -------------------------------------------------------------------------------- 1 | {} -------------------------------------------------------------------------------- /.yarnrc: -------------------------------------------------------------------------------- 1 | # Override Yarn command so we can automatically setup the repo on running `yarn` 2 | 3 | yarn-path "scripts/bootstrap.js" 4 | -------------------------------------------------------------------------------- /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 | 118 | ## Steps to create package 119 | 120 | Created library scaffolding using `npx create-react-native-library react-native-progress-circle-gradient` and select the `JavaScript Library` option. When uploading a package to the npm registry it will first look at the `.gitignore` for files to exclude. You can also create a `.npmignore` file but note that will not be joined with the `.gitignore` file (it will now _only_ look at the `.npmignore` file). The best way to tell npm which files to include is to list them in the `files` property of `package.json`. 121 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2023 derekrsargent 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 | # react-native-progress-circle-gradient 2 | 3 | [![license](https://img.shields.io/github/license/mashape/apistatus.svg)]() 4 | [![Version](https://img.shields.io/npm/v/react-native-progress-circle-gradient.svg)](https://www.npmjs.com/package/react-native-progress-circle-gradient) 5 | [![npm](https://img.shields.io/npm/dt/react-native-progress-circle-gradient.svg)](https://www.npmjs.com/package/react-native-progress-circle-gradient) 6 | 7 | An animated progress circle with an angular gradient using _react-native-skia_. The **differentiator** between this package and other React Native animated circular progress charts with a gradient is that the start color can be different than the stop color. 8 | 9 | This package has only 2 dependencies (_@shopify/react-native-skia_ and _color-interpolate_). It has 0 peer dependencies and so does **not** require _react-native-reanimated_ or _react-native-svg_ to also be installed, linked or configured for your project. 10 | 11 | This project is inspired by this [YouTube](https://www.youtube.com/watch?v=7SCzL-XnfUU) tutorial. 12 | 13 | ## Installation 14 | 15 | ```sh 16 | npm install react-native-progress-circle-gradient 17 | ``` 18 | 19 | or 20 | 21 | ```sh 22 | yarn add react-native-progress-circle-gradient 23 | ``` 24 | 25 | ## Props 26 | 27 | | Prop | Description | Type | Default | Required | 28 | | ------------------ | ------------------------------------------------------------------------------------ | -------- | --------- | -------- | 29 | | colors | The color hex values array to be used for the angular gradient | String[] | N/A | ✓ | 30 | | backgroundColor | The color hex value for the remaining progress | String | '#F0F8FF' | | 31 | | duration | The duration of the animation in milliseconds | Number | 1250 | | 32 | | easing | The easing options for the animation: 'cubic', 'ease', 'linear', 'quad' | String | 'cubic' | | 33 | | granularity | Smaller progress circle charts can use a smaller granularity to increase performance | Number | 200 | | 34 | | onAnimationFinish | Callback for when animation reaches 100% | Function | N/A | | 35 | | percentageComplete | The percentage of progress completed ranging from 0-100 | Number | 0 | | 36 | | radius | The radius of the progress circle in points, measured from the center of the stroke | Number | 100 | | 37 | | rotation | The rotation of the progress circle in degrees | Number | 0 | | 38 | | strokeWidth | The thickness of the progress circle | Number | 30 | | 39 | 40 | ## Usage 41 | 42 | ```js 43 | import { CircularProgress } from 'react-native-progress-circle-gradient'; 44 | 45 | // ... 46 | 47 | ; 54 | ``` 55 | 56 | ![](https://github.com/derekrsargent/react-native-progress-circle-gradient/blob/main/example/assets/example1.gif) 57 | 58 | ```js 59 | import { CircularProgress } from 'react-native-progress-circle-gradient'; 60 | 61 | // ... 62 | 63 | { 72 | Alert.alert('Animation has finished!'); 73 | }} 74 | />; 75 | ``` 76 | 77 | ![](https://github.com/derekrsargent/react-native-progress-circle-gradient/blob/main/example/assets/example6.gif) 78 | 79 | ```js 80 | 87 | ``` 88 | 89 | ![](https://github.com/derekrsargent/react-native-progress-circle-gradient/blob/main/example/assets/example5.gif) 90 | 91 | ```js 92 | 100 | ``` 101 | 102 | ![](https://github.com/derekrsargent/react-native-progress-circle-gradient/blob/main/example/assets/example3.gif) 103 | 104 | ## Roadmap 105 | 106 | - Add functions for animation pause, play and reset 107 | - Add support for text once default system fonts become available in [this PR](https://github.com/Shopify/react-native-skia/issues/1249) 108 | - Add support for children components 109 | 110 | ## Contributing 111 | 112 | See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow. 113 | 114 | ## License 115 | 116 | MIT 117 | 118 | --- 119 | 120 | Made with [create-react-native-library](https://github.com/callstack/react-native-builder-bob) 121 | -------------------------------------------------------------------------------- /babel.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | presets: ['module:metro-react-native-babel-preset'], 3 | }; 4 | -------------------------------------------------------------------------------- /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/derekrsargent/react-native-progress-circle-gradient/96bac8e43a0c04ff10aea4c5ceba48d4e5ad76b7/example/assets/adaptive-icon.png -------------------------------------------------------------------------------- /example/assets/example1.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/derekrsargent/react-native-progress-circle-gradient/96bac8e43a0c04ff10aea4c5ceba48d4e5ad76b7/example/assets/example1.gif -------------------------------------------------------------------------------- /example/assets/example2.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/derekrsargent/react-native-progress-circle-gradient/96bac8e43a0c04ff10aea4c5ceba48d4e5ad76b7/example/assets/example2.gif -------------------------------------------------------------------------------- /example/assets/example3.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/derekrsargent/react-native-progress-circle-gradient/96bac8e43a0c04ff10aea4c5ceba48d4e5ad76b7/example/assets/example3.gif -------------------------------------------------------------------------------- /example/assets/example5.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/derekrsargent/react-native-progress-circle-gradient/96bac8e43a0c04ff10aea4c5ceba48d4e5ad76b7/example/assets/example5.gif -------------------------------------------------------------------------------- /example/assets/example6.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/derekrsargent/react-native-progress-circle-gradient/96bac8e43a0c04ff10aea4c5ceba48d4e5ad76b7/example/assets/example6.gif -------------------------------------------------------------------------------- /example/assets/favicon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/derekrsargent/react-native-progress-circle-gradient/96bac8e43a0c04ff10aea4c5ceba48d4e5ad76b7/example/assets/favicon.png -------------------------------------------------------------------------------- /example/assets/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/derekrsargent/react-native-progress-circle-gradient/96bac8e43a0c04ff10aea4c5ceba48d4e5ad76b7/example/assets/icon.png -------------------------------------------------------------------------------- /example/assets/splash.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/derekrsargent/react-native-progress-circle-gradient/96bac8e43a0c04ff10aea4c5ceba48d4e5ad76b7/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 | ], 21 | }; 22 | }; 23 | -------------------------------------------------------------------------------- /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 | 9 | const modules = Object.keys({ 10 | ...pak.peerDependencies, 11 | }); 12 | 13 | const defaultConfig = getDefaultConfig(__dirname); 14 | 15 | module.exports = { 16 | ...defaultConfig, 17 | 18 | projectRoot: __dirname, 19 | watchFolders: [root], 20 | 21 | // We need to make sure that only one version is loaded for peerDependencies 22 | // So we block them at the root, and alias them to the versions in example's node_modules 23 | resolver: { 24 | ...defaultConfig.resolver, 25 | 26 | blacklistRE: exclusionList( 27 | modules.map( 28 | (m) => 29 | new RegExp(`^${escape(path.join(root, 'node_modules', m))}\\/.*$`) 30 | ) 31 | ), 32 | 33 | extraNodeModules: modules.reduce((acc, name) => { 34 | acc[name] = path.join(__dirname, 'node_modules', name); 35 | return acc; 36 | }, {}), 37 | }, 38 | }; 39 | -------------------------------------------------------------------------------- /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": "~48.0.15", 13 | "expo-status-bar": "~1.4.4", 14 | "react": "18.2.0", 15 | "react-native": "0.71.8", 16 | "react-dom": "18.2.0", 17 | "react-native-web": "~0.18.10" 18 | }, 19 | "devDependencies": { 20 | "@babel/core": "^7.20.0", 21 | "babel-plugin-module-resolver": "^4.1.0", 22 | "@expo/webpack-config": "^0.17.2", 23 | "babel-loader": "^8.1.0" 24 | }, 25 | "private": true 26 | } -------------------------------------------------------------------------------- /example/src/App.tsx: -------------------------------------------------------------------------------- 1 | import * as React from 'react'; 2 | import { Alert, Pressable, StyleSheet, Text, View } from 'react-native'; 3 | import { CircularProgress } from 'react-native-progress-circle-gradient'; 4 | 5 | export default function App() { 6 | const [progress, setProgress] = React.useState(2); 7 | 8 | return ( 9 | 10 | 11 | { 19 | Alert.alert('Animation has finished!'); 20 | }} 21 | /> 22 | setProgress(progress + 100)}> 23 | Press me 24 | 25 | 26 | 27 | ); 28 | } 29 | 30 | const styles = StyleSheet.create({ 31 | container: { 32 | flex: 1, 33 | justifyContent: 'center', 34 | alignItems: 'center', 35 | backgroundColor: '#121212', 36 | }, 37 | progress: { 38 | justifyContent: 'center', 39 | alignItems: 'center', 40 | flex: 1, 41 | }, 42 | text: { 43 | color: '#121224', 44 | marginTop: 30, 45 | }, 46 | }); 47 | -------------------------------------------------------------------------------- /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-progress-circle-gradient", 3 | "version": "1.2.1", 4 | "description": "React Native component for making animated circular progress charts with an angular gradient using react-native-skia", 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/derekrsargent/react-native-progress-circle-gradient", 44 | "author": "derekrsargent (https://github.com/derekrsargent)", 45 | "license": "MIT", 46 | "bugs": { 47 | "url": "https://github.com/derekrsargent/react-native-progress-circle-gradient/issues" 48 | }, 49 | "homepage": "https://github.com/derekrsargent/react-native-progress-circle-gradient#readme", 50 | "publishConfig": { 51 | "registry": "https://registry.npmjs.org/" 52 | }, 53 | "devDependencies": { 54 | "@commitlint/config-conventional": "^17.0.2", 55 | "@evilmartians/lefthook": "^1.2.2", 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.71.8", 71 | "react-native-builder-bob": "^0.20.4", 72 | "release-it": "^15.0.0", 73 | "typescript": "^4.5.2" 74 | }, 75 | "resolutions": { 76 | "@types/react": "17.0.21" 77 | }, 78 | "peerDependencies": { 79 | "react": "*", 80 | "react-native": "*" 81 | }, 82 | "engines": { 83 | "node": ">= 16.0.0" 84 | }, 85 | "packageManager": "^yarn@1.22.15", 86 | "jest": { 87 | "preset": "react-native", 88 | "modulePathIgnorePatterns": [ 89 | "/example/node_modules", 90 | "/lib/" 91 | ] 92 | }, 93 | "commitlint": { 94 | "extends": [ 95 | "@commitlint/config-conventional" 96 | ] 97 | }, 98 | "release-it": { 99 | "git": { 100 | "commitMessage": "chore: release ${version}", 101 | "tagName": "v${version}" 102 | }, 103 | "npm": { 104 | "publish": true 105 | }, 106 | "github": { 107 | "release": true 108 | }, 109 | "plugins": { 110 | "@release-it/conventional-changelog": { 111 | "preset": "angular" 112 | } 113 | } 114 | }, 115 | "eslintConfig": { 116 | "root": true, 117 | "extends": [ 118 | "@react-native-community", 119 | "prettier" 120 | ], 121 | "rules": { 122 | "prettier/prettier": [ 123 | "error", 124 | { 125 | "quoteProps": "consistent", 126 | "singleQuote": true, 127 | "tabWidth": 2, 128 | "trailingComma": "es5", 129 | "useTabs": false 130 | } 131 | ] 132 | } 133 | }, 134 | "eslintIgnore": [ 135 | "node_modules/", 136 | "lib/" 137 | ], 138 | "prettier": { 139 | "quoteProps": "consistent", 140 | "singleQuote": true, 141 | "tabWidth": 2, 142 | "trailingComma": "es5", 143 | "useTabs": false 144 | }, 145 | "react-native-builder-bob": { 146 | "source": "src", 147 | "output": "lib", 148 | "targets": [ 149 | "commonjs", 150 | "module", 151 | [ 152 | "typescript", 153 | { 154 | "project": "tsconfig.build.json" 155 | } 156 | ] 157 | ] 158 | }, 159 | "dependencies": { 160 | "@shopify/react-native-skia": "^0.1.191", 161 | "color-interpolate": "^1.0.5" 162 | } 163 | } 164 | -------------------------------------------------------------------------------- /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/CircularProgress.tsx: -------------------------------------------------------------------------------- 1 | import React, { useEffect, useRef } from 'react'; 2 | import { PixelRatio } from 'react-native'; 3 | import interpolate from 'color-interpolate'; 4 | import { 5 | Canvas, 6 | Circle, 7 | Drawing, 8 | Easing, 9 | Group, 10 | Mask, 11 | PaintStyle, 12 | Path, 13 | runTiming, 14 | Skia, 15 | StrokeCap, 16 | StrokeJoin, 17 | TileMode, 18 | useValue, 19 | } from '@shopify/react-native-skia'; 20 | 21 | import type { FC } from 'react'; 22 | import type { CanvasProps, SkPaint, SkPoint } from '@shopify/react-native-skia'; 23 | 24 | type Line = { 25 | x0: number; 26 | y0: number; 27 | x1: number; 28 | y1: number; 29 | paint: SkPaint; 30 | }; 31 | 32 | type EasingOptions = 'cubic' | 'ease' | 'linear' | 'quad'; 33 | 34 | interface CircularProgressProps extends Omit { 35 | /** Color hex values array to be used for the angular gradient */ 36 | colors: string[]; 37 | /** Color hex value for the remaining progress */ 38 | backgroundColor?: string; 39 | /** Duration of the animation in milliseconds */ 40 | duration?: number; 41 | /** Easing options for animation */ 42 | easing?: EasingOptions; 43 | /** Smaller progress circle charts can use a smaller granularity to increase performance */ 44 | granularity?: number; 45 | /** Callback for when animation reaches 100% */ 46 | onAnimationFinish?: () => void; 47 | /** Percentage of progress completed ranging from 0-200 */ 48 | percentageComplete?: number; 49 | /** Radius of the progress circle in points, measured from the center of the stroke */ 50 | radius?: number; 51 | /** Rotation of progress circle in degrees */ 52 | rotation?: number; 53 | /** Thickness of the progress circle */ 54 | strokeWidth?: number; 55 | } 56 | 57 | export const CircularProgress: FC = ({ 58 | colors, 59 | backgroundColor = '#F0F8FF', 60 | duration = 1250, 61 | easing = 'cubic', 62 | granularity = 200, 63 | onAnimationFinish, 64 | percentageComplete = 0, 65 | radius = 100, 66 | rotation = 0, 67 | strokeWidth = 20, 68 | ...props 69 | }) => { 70 | const { cos, sin, PI } = Math; 71 | const prevPercentageComplete = useRef(0); 72 | const isAnimationComplete = useRef(false); 73 | const r = PixelRatio.roundToNearestPixel(radius - strokeWidth / 2); 74 | const animationState = useValue(0); 75 | 76 | // The duration is for 100% progress, so we adjust it based on the progress delta from the 77 | // previous state so that a small increase in progress does not use the full duration 78 | const adjustedDuration = 79 | ((percentageComplete - prevPercentageComplete.current) / 100) * duration; 80 | 81 | useEffect(() => { 82 | animationState.current = prevPercentageComplete.current / 100; 83 | runTiming(animationState, percentageComplete / 100, { 84 | duration: adjustedDuration, 85 | easing: Easing[easing], 86 | }); 87 | prevPercentageComplete.current = percentageComplete; 88 | }, [adjustedDuration, animationState, easing, percentageComplete]); 89 | 90 | // https://github.com/Shopify/react-native-skia/issues/239 91 | useEffect(() => { 92 | const unsubscribe = animationState.addListener((value) => { 93 | if (value >= 1.0 && !isAnimationComplete.current) { 94 | isAnimationComplete.current = true; 95 | onAnimationFinish?.(); 96 | } 97 | }); 98 | return () => { 99 | unsubscribe(); 100 | }; 101 | }, [animationState, onAnimationFinish]); 102 | 103 | const path = Skia.Path.Make(); 104 | path.addCircle(radius, radius, r); 105 | 106 | const basePaint = Skia.Paint(); 107 | basePaint.setStrokeWidth(strokeWidth); 108 | basePaint.setStyle(PaintStyle.Stroke); 109 | basePaint.setStrokeJoin(StrokeJoin.Round); 110 | basePaint.setStrokeCap(StrokeCap.Round); 111 | 112 | const step = (2 * PI) / granularity; 113 | 114 | const convertDegreesToRadians = (degrees: number) => 115 | ((2 * PI * degrees) / 360) % 360; 116 | 117 | // An array of the angles in radians of each sub-section of the progress chart. 118 | // We make an array with `granularity * 2` elements so that progress can go up to 200% 119 | const arcs = new Array(granularity * 2).fill(0).map((_, i) => { 120 | return ( 121 | (2 * PI * i) / granularity + PI / 2 + convertDegreesToRadians(rotation) 122 | ); 123 | }); 124 | 125 | const x = (α: number) => radius - r * cos(α); 126 | const y = (α: number) => -r * sin(α) + radius; 127 | 128 | const palette = interpolate(colors); 129 | 130 | const calculateXY = (α: number, idx: number) => { 131 | const x0 = x(α); 132 | const y0 = y(α); 133 | const x1 = x(α + step); 134 | const y1 = y(α + step); 135 | 136 | const paint = basePaint.copy(); 137 | 138 | const p0: SkPoint = { x: x0, y: y0 }; 139 | const p1: SkPoint = { x: x1, y: y1 }; 140 | 141 | const gradient = Skia.Shader.MakeLinearGradient( 142 | p0, 143 | p1, 144 | [palette(idx / granularity), palette((idx + 1) / granularity)].map( 145 | (color) => Skia.Color(color) 146 | ), 147 | null, 148 | TileMode.Clamp 149 | ); 150 | paint.setShader(gradient); 151 | return { x0, y0, x1, y1, paint }; 152 | }; 153 | 154 | function calculateLines() { 155 | const lines: Line[] = []; 156 | arcs.forEach((arc, idx) => { 157 | const line = calculateXY(arc, idx); 158 | lines.push(line); 159 | }); 160 | return lines; 161 | } 162 | 163 | const lines = calculateLines(); 164 | 165 | return ( 166 | 170 | 171 | {!!backgroundColor && ( 172 | 177 | 185 | 186 | } 187 | > 188 | 194 | 195 | )} 196 | { 198 | lines.forEach((line, idx) => { 199 | const point = idx / granularity; 200 | if (point <= animationState.current) { 201 | // TODO: fix animation being janky without this timeout 202 | setTimeout(() => {}, 0); 203 | canvas.drawLine(line.x0, line.y0, line.x1, line.y1, line.paint); 204 | } 205 | }); 206 | }} 207 | /> 208 | 209 | 210 | ); 211 | }; 212 | -------------------------------------------------------------------------------- /src/__tests__/index.test.tsx: -------------------------------------------------------------------------------- 1 | it.todo('write a test'); 2 | -------------------------------------------------------------------------------- /src/index.ts: -------------------------------------------------------------------------------- 1 | export * from './CircularProgress'; 2 | -------------------------------------------------------------------------------- /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-progress-circle-gradient": ["./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 | } 27 | } 28 | --------------------------------------------------------------------------------