-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #13 from SimformSolutionsPvtLtd/develop
Release v1.0.0
- Loading branch information
Showing
120 changed files
with
15,259 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| **/node_modules | ||
| example/ | ||
| lib/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| { | ||
| "extends": ["@react-native-community", "prettier"], | ||
| "root": true, | ||
| "rules": { | ||
| "prettier/prettier": [ | ||
| "error", | ||
| { | ||
| "quoteProps": "preserve", | ||
| "singleQuote": true, | ||
| "tabWidth": 2, | ||
| "trailingComma": "es5", | ||
| "useTabs": false | ||
| } | ||
| ], | ||
| "no-shadow": "off", | ||
| "@typescript-eslint/no-shadow": ["error"], | ||
| "no-bitwise": 0, | ||
| "prefer-const": "warn", | ||
| "no-console": ["error", { "allow": ["warn", "error"] }] | ||
| }, | ||
| "globals": { | ||
| "JSX": "readonly" | ||
| }, | ||
| "env": { | ||
| "jest": true | ||
| }, | ||
| "plugins": ["prettier"] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| name: '🚀 Publish' | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - master | ||
|
|
||
| jobs: | ||
| release: | ||
| name: 🚀 Publish | ||
| runs-on: macos-11 | ||
| steps: | ||
| - name: 📚 checkout | ||
| uses: actions/checkout@v2.4.2 | ||
| - name: 🟢 node | ||
| uses: actions/setup-node@v3.3.0 | ||
| with: | ||
| node-version: 16 | ||
| registry-url: https://registry.npmjs.org | ||
| - name: 🚀 Build & Publish | ||
| run: yarn install && yarn build && yarn publish --access public | ||
| env: | ||
| NODE_AUTH_TOKEN: ${{secrets.NPM_AUTH_TOKEN}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| # OSX | ||
| # | ||
| .DS_Store | ||
|
|
||
| # Xcode | ||
| # | ||
| build/ | ||
| *.pbxuser | ||
| !default.pbxuser | ||
| *.mode1v3 | ||
| !default.mode1v3 | ||
| *.mode2v3 | ||
| !default.mode2v3 | ||
| *.perspectivev3 | ||
| !default.perspectivev3 | ||
| xcuserdata | ||
| *.xccheckout | ||
| *.moved-aside | ||
| DerivedData | ||
| *.hmap | ||
| *.ipa | ||
| *.xcuserstate | ||
|
|
||
| # Android/IntelliJ | ||
| # | ||
| build/ | ||
| .idea | ||
| .gradle | ||
| local.properties | ||
| *.iml | ||
|
|
||
| # node.js | ||
| # | ||
| node_modules/ | ||
| npm-debug.log | ||
| yarn-error.log* | ||
| yarn.lock | ||
|
|
||
| # BUCK | ||
| buck-out/ | ||
| \.buckd/ | ||
| *.keystore | ||
| !debug.keystore | ||
|
|
||
| # fastlane | ||
| # | ||
| # It is recommended to not store the screenshots in the git repo. Instead, use fastlane to re-generate the | ||
| # screenshots whenever they are needed. | ||
| # For more information about the recommended setup visit: | ||
| # https://docs.fastlane.tools/best-practices/source-control/ | ||
|
|
||
| */fastlane/report.xml | ||
| */fastlane/Preview.html | ||
| */fastlane/screenshots | ||
|
|
||
| # Bundle artifact | ||
| *.jsbundle | ||
|
|
||
| # Ruby / CocoaPods | ||
| /ios/Pods/ | ||
| /vendor/bundle/ | ||
| coverage | ||
|
|
||
| # generated | ||
| lib |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| #!/bin/sh | ||
| . "$(dirname "$0")/_/husky.sh" | ||
|
|
||
| yarn commitlint --edit $1 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| #!/bin/sh | ||
| . "$(dirname "$0")/_/husky.sh" | ||
|
|
||
| yarn lint-staged |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| #!/bin/sh | ||
| . "$(dirname "$0")/_/husky.sh" | ||
|
|
||
| yarn build | ||
| yarn test |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| .github/ | ||
| example/ | ||
| assets/ | ||
| .eslintignore | ||
| .eslintrc | ||
| CONTRIBUTING.md | ||
| babel.config.js | ||
| .buckconfig | ||
| jest-setup.js | ||
| .husky/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| module.exports = { | ||
| arrowParens: 'avoid', | ||
| bracketSameLine: true, | ||
| bracketSpacing: true, | ||
| singleQuote: true, | ||
| trailingComma: 'es5' | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| # Contributing | ||
|
|
||
| We welcome code changes that improve this library or fix a problem, and please make sure to follow all best practices and test all the changes/fixes before committing and creating a pull request. 🚀 🚀 | ||
|
|
||
| ### Committing and Pushing Changes | ||
|
|
||
| Commit messages should be formatted as: | ||
|
|
||
| ``` | ||
| <type>[optional scope]: <description> | ||
| [optional body] | ||
| [optional footer] | ||
| ``` | ||
|
|
||
| Where type can be one of the following: | ||
|
|
||
| - feat | ||
| - fix | ||
| - docs | ||
| - chore | ||
| - style | ||
| - refactor | ||
| - test | ||
|
|
||
| and an optional scope can be a component | ||
|
|
||
| ``` | ||
| docs: update contributing guide | ||
| ``` | ||
|
|
||
| ``` | ||
| fix(TicketId/Component): layout flicker issue | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,200 @@ | ||
| # react-native-tree-selection | ||
|  | ||
|
|
||
| # react-native-tree-selection | ||
|
|
||
| [](https://www.npmjs.com/package/react-native-tree-selection) [](https://www.npmtrends.com/react-native-tree-selection) [](https://packagephobia.com/result?p=react-native-tree-selection) [](https://www.android.com) [](https://developer.apple.com/ios) [](https://opensource.org/licenses/MIT) | ||
|
|
||
| --- | ||
|
|
||
| Hierarchical Tree Select Control, a high-performance and lightweight library designed to effortlessly render select components with hierarchical tree data. This versatile control not only facilitates the display of work selection but also empowers users to make their own selection. | ||
|
|
||
| It is simple to use and fully customizable. It works on both android and iOS platforms. | ||
|
|
||
| --- | ||
|
|
||
| ## 🎬 Preview | ||
|
|
||
| --- | ||
|
|
||
| | Tree Selection with No Children | Tree Selection with children | | ||
| | ---------------------------------------------------------------------- | ------------------------------------------------------------ | | ||
| |  |  | | ||
|
|
||
| --- | ||
|
|
||
| ## Quick Access | ||
|
|
||
| - [Installation](#installation) | ||
| - [Tree-selection Data](#tree-data-format) | ||
| - [Usage and Examples](#usage) | ||
| - [Properties](#properties) | ||
| - [Example Code](#example) | ||
| - [License](#license) | ||
|
|
||
| ## Getting Started 🔧 | ||
|
|
||
| # Installation | ||
|
|
||
| ##### 1. Install library | ||
|
|
||
| ```bash | ||
| npm install react-native-tree-selection | ||
| ``` | ||
|
|
||
| ###### --- or --- | ||
|
|
||
| ```bash | ||
| yarn add react-native-tree-selection | ||
| ``` | ||
|
|
||
| ##### 2. Install cocoapods in the ios project | ||
|
|
||
| ```bash | ||
| cd ios && pod install | ||
| ``` | ||
|
|
||
| # Tree-selection | ||
|
|
||
| ### Tree Data Format | ||
|
|
||
| ```jsx | ||
| const treeData: TreeDataTypes[] = [ | ||
| { | ||
| id: '1', | ||
| title: 'Fruits', | ||
| data: [ | ||
| { | ||
| title: 'Apples', | ||
| data: [ | ||
| { | ||
| title: 'Red Delicious', | ||
| }, | ||
| { | ||
| title: 'Granny Smith', | ||
| }, | ||
| { | ||
| title: 'Gala', | ||
| }, | ||
| ], | ||
| }, | ||
| { | ||
| title: 'Bananas', | ||
| data: [ | ||
| { | ||
| title: 'Cavendish', | ||
| }, | ||
| { | ||
| title: 'Lady Finger', | ||
| }, | ||
| ], | ||
| }, | ||
| ], | ||
| }, | ||
| ]; | ||
| ``` | ||
|
|
||
| #### Usage | ||
|
|
||
| ```jsx | ||
| <TreeSelect | ||
| data={treeData} | ||
| childKey="data" | ||
| titleKey="title" | ||
| onParentPress={onParentPress} | ||
| onChildPress={onChildPress} | ||
| onCheckBoxPress={onCheckBoxPress} | ||
| /> | ||
| ``` | ||
|
|
||
| Checkout TreeSelect Example [here](./example/src/App.tsx) | ||
|
|
||
| ##### App | ||
|
|
||
| ```jsx | ||
| import React from 'react'; | ||
| import { | ||
| TreeDataTypes, | ||
| TreeSelect, | ||
| } from 'react-native-tree-selection'; | ||
|
|
||
| const App = () => { | ||
|
|
||
| return ( | ||
| <TreeSelect | ||
| data={treeData} | ||
| childKey="data" | ||
| titleKey="title" | ||
| onParentPress={onParentPress} | ||
| onChildPress={onChildPress} | ||
| onCheckBoxPress={onCheckBoxPress} | ||
| /> | ||
| /> | ||
| ); | ||
| }; | ||
|
|
||
| export default App; | ||
| ``` | ||
|
|
||
| # Properties | ||
|
|
||
| --- | ||
|
|
||
| | Prop | Default | Type | Description | | ||
| | :--------------------- | :------ | :-------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | **data** | - | [Data](#tree-data-format) | An array of objects representing multiple data items organized in a tree structure. Each object can contain various types of data and can be extended to include additional information. This format allows for flexible data manipulation and integration. | | ||
| | **childKey** | data | string | Specifies the name of the property in each node object that contains the children to display. | | ||
| | **titleKey** | title | string | Specifies the name of the property in each node object that contains the title to display. | | ||
| | onParentPress | - | function | A callback function that is called when a parent node is clicked. | | ||
| | onChildPress | - | function | A callback function that is called when a child node is clicked. | | ||
| | onCheckBoxPress | - | function | A callback function that is called when a checkbox is clicked. | | ||
| | rightIconStyles | - | ImageStyle | Checkbox image style | | ||
| | leftIconStyles | - | ImageStyle | Arrow image style | | ||
| | parentContainerStyles | - | ViewStyle | Style for Parent Container | | ||
| | childContainerStyles | - | TextStyle | Style for Child Container | | ||
| | parentTextStyles | - | TextStyle | Text Styles for Parent | | ||
| | childTextStyles | - | TextStyle | Text Styles for Child | | ||
| | touchableActiveOpacity | 0.7 | activeOpacity | activeOpacity style for Touchable. | | ||
| | flatListProps | - | FlatListProps<[ArrayData](#tree-data-format)> | Provide <a href="https://reactnative.dev/docs/flatlist#props">FlatList props</a>. | | ||
| | autoSelectParents | true | Boolean | Parents will gets selected when all the children are selected. | | ||
| | autoSelectChildren | true | Boolean | Children will gets selected when parent is selected. | | ||
| | renderArrowOpen | - | ImagePropType | Change icon for Arrow when parent expands. | | ||
| | renderArrowClosed | - | ImagePropType | Change icon for checkbox when checkbox is selected. | | ||
| | renderSelect | - | ImagePropType | Change icon for checkbox when checkbox is selected. | | ||
| | renderUnSelect | - | ImagePropType | Change icon for checkbox when checkbox is unselected. | | ||
|
|
||
| --- | ||
|
|
||
| # Example | ||
|
|
||
| A full working example project is here [Example](./example/src/App.tsx) | ||
|
|
||
| ```sh | ||
| yarn | ||
| yarn example ios // For ios | ||
| yarn example android // For Android | ||
| ``` | ||
|
|
||
| # TODO | ||
|
|
||
| - [ ] Provide dynamic render items | ||
|
|
||
| ## Find this library useful? ❤️ | ||
|
|
||
| Support it by joining [stargazers](https://github.com/SimformSolutionsPvtLtd/react-native-tree-selection/stargazers) for this repository.⭐ | ||
|
|
||
| ## Bugs / Feature requests / Feedbacks | ||
|
|
||
| For bugs, feature requests, and discussion please use [GitHub Issues](https://github.com/SimformSolutionsPvtLtd/react-native-tree-selection/issues/new?labels=bug&late=BUG_REPORT.md&title=%5BBUG%5D%3A), [GitHub New Feature](https://github.com/SimformSolutionsPvtLtd/react-native-tree-selection/issues/new?labels=enhancement&late=FEATURE_REQUEST.md&title=%5BFEATURE%5D%3A), [GitHub Feedback](https://github.com/SimformSolutionsPvtLtd/react-native-tree-selection/issues/new?labels=enhancement&late=FEATURE_REQUEST.md&title=%5BFEEDBACK%5D%3A) | ||
|
|
||
| ## 🤝 How to Contribute | ||
|
|
||
| We'd love to have you improve this library or fix a problem 💪 | ||
| Check out our [Contributing Guide](CONTRIBUTING.md) for ideas on contributing. | ||
|
|
||
| ## Awesome Mobile Libraries | ||
|
|
||
| - Check out our other [available awesome mobile libraries](https://github.com/SimformSolutionsPvtLtd/Awesome-Mobile-Libraries) | ||
|
|
||
| ## License | ||
|
|
||
| - [MIT License](./LICENSE) |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.