├── .editorconfig ├── .eslintrc.json ├── .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 ├── bun.lockb ├── example ├── App.js ├── app.json ├── assets │ ├── adaptive-icon.png │ ├── 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 ├── BackspaceKeyIcon.tsx ├── BioMetricIcon.tsx ├── PinCodeKey.tsx ├── PinCodeRow.tsx ├── __tests__ │ └── index.test.tsx ├── index.tsx └── keypad.tsx ├── tsconfig.build.json ├── tsconfig.json ├── typedoc.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 | -------------------------------------------------------------------------------- /.eslintrc.json: -------------------------------------------------------------------------------- 1 | { 2 | "root": true, 3 | "parser": "@typescript-eslint/parser", 4 | "extends": [ 5 | "airbnb", 6 | "airbnb/hooks", 7 | "plugin:@typescript-eslint/recommended", 8 | "prettier", 9 | "plugin:prettier/recommended" 10 | ], 11 | "env": { 12 | "es6": true, 13 | "node": true 14 | }, 15 | "plugins": [ 16 | "@typescript-eslint", 17 | "react", 18 | "react-native" 19 | ], 20 | "ignorePatterns": [ 21 | "__tests__/*", 22 | "docs/*", 23 | "*.config.js" 24 | ], 25 | "rules": { 26 | "react/prop-types": "off", 27 | "react-hooks/exhaustive-deps": "off", 28 | "react-hooks/rules-of-hooks": "off", 29 | "react-native/no-inline-styles": "off", 30 | "no-alert": "off", 31 | "no-catch-shadow": "off", 32 | "no-console": "off", 33 | "@typescript-eslint/no-explicit-any": "off", 34 | "no-use-before-define": "off", 35 | "@typescript-eslint/ban-ts-comment": "off", 36 | "react/require-default-props": "off", 37 | "import/extensions": "off", 38 | "no-restricted-syntax": "off", 39 | "import/no-extraneous-dependencies": "off", 40 | "react/jsx-no-useless-fragment": "off", 41 | "guard-for-in": "off", 42 | "no-underscore-dangle": "off", 43 | "camelcase": "off", 44 | "no-shadow": "off", 45 | "no-plusplus": "off", 46 | "default-param-last": "off", 47 | "react/no-unstable-nested-components": "off", 48 | "react/destructuring-assignment": "off", 49 | "react/function-component-definition": "off", 50 | "react/jsx-props-no-spreading": "off", 51 | "no-param-reassign": "off", 52 | "@typescript-eslint/no-shadow": "off", 53 | "react/jsx-filename-extension": "off", 54 | "@typescript-eslint/no-var-requires": "off", 55 | "import/no-unresolved": [ 56 | 0, 57 | { 58 | "alias": { 59 | "@malaa": "./src" 60 | } 61 | } 62 | ] 63 | }, 64 | "parserOptions": { 65 | "ecmaVersion": 2017, 66 | "sourceType": "module", 67 | "ecmaFeatures": { 68 | "jsx": true, 69 | "tsx": true, 70 | "modules": true, 71 | "experimentalObjectRestSpread": true 72 | } 73 | } 74 | } -------------------------------------------------------------------------------- /.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') }}-${{ hashFiles('**/package.json') }} 19 | restore-keys: | 20 | ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }} 21 | ${{ runner.os }}-yarn- 22 | 23 | - name: Install dependencies 24 | if: steps.yarn-cache.outputs.cache-hit != 'true' 25 | run: | 26 | yarn install --cwd example --frozen-lockfile 27 | yarn install --frozen-lockfile 28 | shell: bash 29 | -------------------------------------------------------------------------------- /.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-library: 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 | 50 | build-web: 51 | runs-on: ubuntu-latest 52 | steps: 53 | - name: Checkout 54 | uses: actions/checkout@v3 55 | 56 | - name: Setup 57 | uses: ./.github/actions/setup 58 | 59 | - name: Build example for Web 60 | run: | 61 | yarn example expo export:web 62 | -------------------------------------------------------------------------------- /.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 | v18 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 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2023 Saud Elabdullah 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 | [![License](http://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://github.com/Malaa-tech/react-native-simple-keypad) 2 | 3 | # react-native-simple-keypad 4 | 5 | A simple, easy to use, and beautiful keypad component for react native 6 | 7 | ## 🖥️ Example App Demo 8 | run it your self using `yarn example [ios/andriod]` 9 | 10 | ## 📦 Installation 11 | 12 | ```sh 13 | npm install react-native-simple-keypad 14 | ``` 15 | or 16 | ```sh 17 | yarn add react-native-simple-keypad 18 | ``` 19 | 20 | ## How we use it in Malaa App 21 | 22 | 23 | ## ⚒️ Usage 24 | 25 | ```js 26 | import * as React from 'react'; 27 | import { View } from 'react-native'; 28 | import Keypad from 'react-native-simple-keypad'; 29 | 30 | export default function App() { 31 | return ( 32 | 33 | console.log(`${value} is pressed`)} 35 | textStyle={{ fontWeight: '600', fontSize: 30 }} 36 | backspaceIconFillColor="#000000" 37 | backspaceIconStrokeColor="#FFFFFF" 38 | bioMetricFillColor="#000000" 39 | backspaceIconHeight={24} 40 | backspaceIconWidth={33} 41 | bioMetricIconHeight={28} 42 | bioMetricIconWidth={28} 43 | onBioAuthPress={() => console.log('Bio Auth')} 44 | /> 45 | 46 | ); 47 | } 48 | 49 | ``` 50 | 51 | ## 🤝 Contributing 52 | 53 | See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow. 54 | 55 | ## License 56 | 57 | MIT 58 | 59 | --- 60 | 61 | Made with [create-react-native-library](https://github.com/callstack/react-native-builder-bob) 62 | -------------------------------------------------------------------------------- /babel.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | presets: ['module:metro-react-native-babel-preset'], 3 | }; 4 | -------------------------------------------------------------------------------- /bun.lockb: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Malaa-tech/react-native-simple-keypad/bb2e0b70764efd00893b0454950075c718c8ff0f/bun.lockb -------------------------------------------------------------------------------- /example/App.js: -------------------------------------------------------------------------------- 1 | // eslint-disable-next-line no-restricted-exports 2 | export { default } from './src/App'; 3 | -------------------------------------------------------------------------------- /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/Malaa-tech/react-native-simple-keypad/bb2e0b70764efd00893b0454950075c718c8ff0f/example/assets/adaptive-icon.png -------------------------------------------------------------------------------- /example/assets/favicon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Malaa-tech/react-native-simple-keypad/bb2e0b70764efd00893b0454950075c718c8ff0f/example/assets/favicon.png -------------------------------------------------------------------------------- /example/assets/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Malaa-tech/react-native-simple-keypad/bb2e0b70764efd00893b0454950075c718c8ff0f/example/assets/icon.png -------------------------------------------------------------------------------- /example/assets/splash.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Malaa-tech/react-native-simple-keypad/bb2e0b70764efd00893b0454950075c718c8ff0f/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 | 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": "~49.0.7", 13 | "expo-status-bar": "~1.6.0", 14 | "react": "18.2.0", 15 | "react-native": "0.72.3", 16 | "react-dom": "18.2.0", 17 | "react-native-web": "~0.19.6", 18 | "react-native-svg": ">=13.4.0" 19 | }, 20 | "devDependencies": { 21 | "@babel/core": "^7.20.0", 22 | "babel-plugin-module-resolver": "^5.0.0", 23 | "@expo/webpack-config": "^18.0.1", 24 | "babel-loader": "^8.1.0" 25 | }, 26 | "private": true 27 | } -------------------------------------------------------------------------------- /example/src/App.tsx: -------------------------------------------------------------------------------- 1 | import * as React from 'react'; 2 | import { View } from 'react-native'; 3 | import Keypad from 'react-native-simple-keypad'; 4 | import Svg, { Path } from 'react-native-svg'; 5 | 6 | function App() { 7 | return ( 8 | 9 | console.log(`${value} is pressed`)} 11 | textStyle={{ fontWeight: '600', fontSize: 30 }} 12 | backspaceIconFillColor="#000000" 13 | backspaceIconStrokeColor="#FFFFFF" 14 | bioMetricFillColor="#000000" 15 | backspaceIconHeight={24} 16 | backspaceIconWidth={33} 17 | bioMetricIconHeight={28} 18 | bioMetricIconWidth={28} 19 | onBioAuthPress={() => console.log('Bio Auth')} 20 | bioMetricAuthIcon={ 21 | 22 | 29 | 30 | } 31 | /> 32 | 33 | ); 34 | } 35 | 36 | export default App; 37 | -------------------------------------------------------------------------------- /example/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "../tsconfig", 3 | "compilerOptions": { 4 | // Avoid expo-cli auto-generating a tsconfig 5 | } 6 | } -------------------------------------------------------------------------------- /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 | commit-msg: 2 | parallel: true 3 | commands: 4 | commitlint: 5 | run: npx commitlint --edit 6 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "react-native-simple-keypad", 3 | "version": "0.3.0", 4 | "description": "A simple, easy to use, and beautiful keypad component for react native", 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 --fix \"**/*.{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/Malaa-tech/react-native-simple-keypad", 44 | "author": "Saud Elabdullah (https://github.com/SaudElabdullah)", 45 | "license": "MIT", 46 | "bugs": { 47 | "url": "https://github.com/Malaa-tech/react-native-simple-keypad/issues" 48 | }, 49 | "homepage": "https://github.com/Malaa-tech/react-native-simple-keypad#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-airbnb": "19.0.4", 65 | "eslint-config-prettier": "^8.5.0", 66 | "eslint-plugin-import": "^2.27.5", 67 | "eslint-plugin-jsx-a11y": "^6.5.1", 68 | "eslint-plugin-prettier": "^4.0.0", 69 | "eslint-plugin-react": "^7.32.1", 70 | "eslint-plugin-react-native": "^4.0.0", 71 | "jest": "^28.1.1", 72 | "pod-install": "^0.1.0", 73 | "prettier": "^2.0.5", 74 | "react": "18.2.0", 75 | "react-native": "0.72.3", 76 | "react-native-builder-bob": "^0.20.0", 77 | "release-it": "^15.0.0", 78 | "typescript": "^5.0.2", 79 | "react-native-svg": ">=13.4.0" 80 | }, 81 | "resolutions": { 82 | "@types/react": "17.0.21" 83 | }, 84 | "peerDependencies": { 85 | "react": ">=16.8.0", 86 | "react-native": ">=0.70.0", 87 | "react-native-svg": ">=13.4.0" 88 | }, 89 | "engines": { 90 | "node": ">= 16.0.0" 91 | }, 92 | "jest": { 93 | "preset": "react-native", 94 | "modulePathIgnorePatterns": [ 95 | "/example/node_modules", 96 | "/lib/" 97 | ] 98 | }, 99 | "commitlint": { 100 | "extends": [ 101 | "@commitlint/config-conventional" 102 | ] 103 | }, 104 | "release-it": { 105 | "git": { 106 | "commitMessage": "chore: release ${version}", 107 | "tagName": "v${version}" 108 | }, 109 | "npm": { 110 | "publish": true 111 | }, 112 | "github": { 113 | "release": true 114 | }, 115 | "plugins": { 116 | "@release-it/conventional-changelog": { 117 | "preset": "angular" 118 | } 119 | } 120 | }, 121 | "eslintConfig": { 122 | "root": true, 123 | "extends": [ 124 | "@react-native-community", 125 | "prettier" 126 | ], 127 | "rules": { 128 | "prettier/prettier": [ 129 | "error", 130 | { 131 | "quoteProps": "consistent", 132 | "singleQuote": true, 133 | "tabWidth": 2, 134 | "trailingComma": "es5", 135 | "useTabs": false 136 | } 137 | ] 138 | } 139 | }, 140 | "eslintIgnore": [ 141 | "node_modules/", 142 | "lib/" 143 | ], 144 | "prettier": { 145 | "quoteProps": "consistent", 146 | "singleQuote": true, 147 | "tabWidth": 2, 148 | "trailingComma": "es5", 149 | "useTabs": false 150 | }, 151 | "react-native-builder-bob": { 152 | "source": "src", 153 | "output": "lib", 154 | "targets": [ 155 | "commonjs", 156 | "module", 157 | [ 158 | "typescript", 159 | { 160 | "project": "tsconfig.build.json" 161 | } 162 | ] 163 | ] 164 | } 165 | } 166 | -------------------------------------------------------------------------------- /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/BackspaceKeyIcon.tsx: -------------------------------------------------------------------------------- 1 | import * as React from 'react'; 2 | import Svg, { type SvgProps, Path } from 'react-native-svg'; 3 | 4 | const BackspaceKeyIcon = (props: SvgProps) => ( 5 | 12 | 17 | 23 | 29 | 30 | ); 31 | 32 | export default BackspaceKeyIcon; 33 | -------------------------------------------------------------------------------- /src/BioMetricIcon.tsx: -------------------------------------------------------------------------------- 1 | import * as React from 'react'; 2 | import { Platform } from 'react-native'; 3 | import Svg, { type SvgProps, Path } from 'react-native-svg'; 4 | 5 | function BioMetricIcon(props: SvgProps) { 6 | if (Platform.OS === 'android') { 7 | return ( 8 | 15 | 16 | 17 | ); 18 | } 19 | return ( 20 | 27 | 31 | 37 | 43 | 47 | 48 | ); 49 | } 50 | 51 | export default BioMetricIcon; 52 | -------------------------------------------------------------------------------- /src/PinCodeKey.tsx: -------------------------------------------------------------------------------- 1 | import React from 'react'; 2 | import { 3 | type TextStyle, 4 | type ColorValue, 5 | Text, 6 | TouchableOpacity, 7 | } from 'react-native'; 8 | import type { NumberProp } from 'react-native-svg'; 9 | import BackspaceKeyIcon from './BackspaceKeyIcon'; 10 | import BioMetricIcon from './BioMetricIcon'; 11 | 12 | function PinCodeKey({ 13 | item, 14 | onKeyPress, 15 | textStyle, 16 | backspaceIcon, 17 | bioMetricAuthIcon, 18 | backspaceIconFillColor, 19 | backspaceIconStrokeColor, 20 | bioMetricFillColor, 21 | onBioAuthPress, 22 | backspaceIconHeight, 23 | backspaceIconWidth, 24 | bioMetricIconHeight, 25 | bioMetricIconWidth, 26 | disable = false, 27 | }: { 28 | item: string | number; 29 | onKeyPress: (value: any) => void; 30 | textStyle: TextStyle; 31 | onBioAuthPress?: () => void; 32 | backspaceIcon?: JSX.Element; 33 | bioMetricAuthIcon?: JSX.Element; 34 | backspaceIconFillColor: ColorValue; 35 | backspaceIconStrokeColor: ColorValue; 36 | bioMetricFillColor: ColorValue; 37 | backspaceIconHeight: NumberProp; 38 | backspaceIconWidth: NumberProp; 39 | bioMetricIconHeight: NumberProp; 40 | bioMetricIconWidth: NumberProp; 41 | disable?: boolean; 42 | }) { 43 | // --------------------------------------------------- 44 | // @ Helper Functions 45 | // --------------------------------------------------- 46 | const getContent = () => { 47 | if (item === 'auth') { 48 | if (onBioAuthPress) { 49 | return ( 50 | <> 51 | {bioMetricAuthIcon || ( 52 | 58 | )} 59 | 60 | ); 61 | } 62 | return undefined; 63 | } 64 | if (item === 'delete') { 65 | return ( 66 | <> 67 | {backspaceIcon || ( 68 | 73 | )} 74 | 75 | ); 76 | } 77 | return {item}; 78 | }; 79 | 80 | const getOnPress = () => { 81 | if (item === 'auth') { 82 | return onBioAuthPress ? onBioAuthPress() : null; 83 | } 84 | return onKeyPress(item); 85 | }; 86 | 87 | // --------------------------------------------------- 88 | // @ Main View 89 | // --------------------------------------------------- 90 | return ( 91 | getOnPress()} 93 | style={{ 94 | justifyContent: 'center', 95 | alignItems: 'center', 96 | flex: 1, 97 | }} 98 | disabled={disable} 99 | > 100 | {getContent()} 101 | 102 | ); 103 | } 104 | 105 | export default PinCodeKey; 106 | -------------------------------------------------------------------------------- /src/PinCodeRow.tsx: -------------------------------------------------------------------------------- 1 | import React from 'react'; 2 | import type { PropsWithChildren } from 'react'; 3 | import { View } from 'react-native'; 4 | 5 | function PinCodeRow({ 6 | rowReverse = false, 7 | children, 8 | }: PropsWithChildren<{ rowReverse: boolean }>) { 9 | return ( 10 | 18 | {children} 19 | 20 | ); 21 | } 22 | 23 | export default PinCodeRow; 24 | -------------------------------------------------------------------------------- /src/__tests__/index.test.tsx: -------------------------------------------------------------------------------- 1 | it.todo('write a test'); 2 | -------------------------------------------------------------------------------- /src/index.tsx: -------------------------------------------------------------------------------- 1 | import Keypad from './keypad'; 2 | 3 | export default Keypad; 4 | -------------------------------------------------------------------------------- /src/keypad.tsx: -------------------------------------------------------------------------------- 1 | import React from 'react'; 2 | import { type TextStyle, type ColorValue } from 'react-native'; 3 | import type { NumberProp } from 'react-native-svg'; 4 | import PinCodeRow from './PinCodeRow'; 5 | import PinCodeKey from './PinCodeKey'; 6 | 7 | export const Keypad = ({ 8 | onKeyPress, 9 | textStyle = {}, 10 | backspaceIcon, 11 | bioMetricAuthIcon, 12 | rowReverse = false, 13 | backspaceIconFillColor = '#000000', 14 | backspaceIconStrokeColor = '#FFFFFF', 15 | bioMetricFillColor = '#000000', 16 | backspaceIconHeight = 24, 17 | backspaceIconWidth = 33, 18 | bioMetricIconHeight = 28, 19 | bioMetricIconWidth = 28, 20 | onBioAuthPress, 21 | disable = false, 22 | }: { 23 | onKeyPress: (value: any) => void; 24 | textStyle?: TextStyle; 25 | rowReverse?: boolean; 26 | backspaceIcon?: JSX.Element; 27 | bioMetricAuthIcon?: JSX.Element; 28 | backspaceIconFillColor?: ColorValue; 29 | backspaceIconStrokeColor?: ColorValue; 30 | bioMetricFillColor?: ColorValue; 31 | backspaceIconHeight?: NumberProp; 32 | backspaceIconWidth?: NumberProp; 33 | bioMetricIconHeight?: NumberProp; 34 | bioMetricIconWidth?: NumberProp; 35 | onBioAuthPress?: () => void; 36 | disable?: boolean; 37 | }) => { 38 | // --------------------------------------------------- 39 | // @ Defaults 40 | // --------------------------------------------------- 41 | const keys = [ 42 | [1, 2, 3], 43 | [4, 5, 6], 44 | [7, 8, 9], 45 | ['auth', 0, 'delete'], 46 | ]; 47 | 48 | // --------------------------------------------------- 49 | // @ Main View 50 | // --------------------------------------------------- 51 | return ( 52 | <> 53 | {keys.map((list: any, index: number) => ( 54 | // eslint-disable-next-line react/no-array-index-key 55 | 56 | {list.map((item: string | number) => ( 57 | 74 | ))} 75 | 76 | ))} 77 | 78 | ); 79 | }; 80 | 81 | export default Keypad; 82 | -------------------------------------------------------------------------------- /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-simple-keypad": ["./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 | -------------------------------------------------------------------------------- /typedoc.json: -------------------------------------------------------------------------------- 1 | { 2 | "entryPoints": [ 3 | "src/index.tsx" 4 | ], 5 | "out": "docs", 6 | "excludeExternals": true, 7 | "excludeInternal": true, 8 | "excludeNotDocumented": true, 9 | "darkHighlightTheme": "dark-plus", 10 | "excludePrivate": true, 11 | "excludeProtected": true, 12 | "plugin": [ 13 | "typedoc-plugin-markdown" 14 | ], 15 | "name": "React Native Simple Keypad", 16 | "pretty": true 17 | } --------------------------------------------------------------------------------