Merge pull request #22 from opensrc0/main

feat(whatsapp share): whatsapp share component has been added successfully
opensrc0 · Apr 9, 2024 · 57ed32d · 57ed32d
2 parents 608051b + a80375f
commit 57ed32d
Show file tree

Hide file tree

Showing 14 changed files with 249 additions and 81 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1 @@
+* text=auto
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -11,13 +11,22 @@ that can be consumed in isolation.
 
 ### Tooling
 
-- [PNPM](https://pnpm.io/) to manage packages and dependencies
+- [NPM](https://www.npmjs.com/) to manage packages and dependencies
 
 ### Commands
 
-**`pnpm install`**: bootstraps the entire project, symlinks all dependencies for
+**`npm install`**: bootstraps the entire project, symlinks all dependencies for
 cross-component development and builds all components.
 
+**`npm start`**: Runs the build and watch command for all component packages.
+
+**`npm run build`**: run build for all component packages.
+
+**`npm run test`**: run test for all component packages.
+
+**`npm run commit`**: to commit the changes.
+
+**`npm run create --component=Share_TEST`**: to create a component along with necessary files
 
 ## Think you found a bug?
 
@@ -27,8 +36,7 @@ link.
 
 You may wish to use our starters to help you get going:
 
-- JavaScript Starter: https://codesandbox.io/s/fe-pilotJS
-- TypeScript Starter: https://codesandbox.io/s/fe-pilotTs
+- JavaScript Starter: https://codesandbox.io/p/sandbox/fe-pilotjs-lts3rg
 
 ## Proposing new or changed API?
 
@@ -69,19 +77,22 @@ the following categories:
 
 ### Steps to PR
 
-Under Maintenance
+1. Fork the fe-pilot repository and clone your fork.
 
-### Tests
+2. Create a new branch out of the `main` branch. We follow the convention
+   `[type/scope]`. For example `fix/share` or `docs/scanner`. `type`
+   can be either `docs`, `fix`, `feat`, `build`, or any other conventional
+   commit type. `scope` will be short name that describes the scope of work.
 
-All commits that fix bugs or add features need a test.
+3. Make and commit your changes following the
+   [commit convention](https://github.com/opensrc0/fe-pilot/blob/main/.github/CONTRIBUTING.md#commit-convention).
 
-## Want to write a blog post or tutorial
 
-Under Maintenance
+### Tests
 
-## Want to help improve the docs?
+All commits that fix bugs or add features need a test.
 
-Under Maintenance
+> **Dear fe-pilot team:** Please do not merge code without tests
 
 ## License
 

diff --git a/.github/README.md b/.github/README.md
@@ -6,7 +6,7 @@
 <h3 >
   <p align="center" class="tasklist-issue-content">
     <a href="https://www.npmjs.com/package/fe-pilot">
-     <img alt="Minified Size" src="https://badgen.net/bundlephobia/minzip/fe-pilot?color=cyan"/>
+     <img alt="Minified Size" src="https://img.shields.io/bundlephobia/min/fe-pilot"/>
     </a>
     <a href="https://react.dev/reference/react">
     <img alt="React Version" src="https://img.shields.io/badge/react-18.2.0-%23f1e05a?logo=React"/>
@@ -40,7 +40,7 @@ A React UI library for Advance Web Features that streamlines the development of
 6. 📝 [Contributing](#contributing)
 7. ✨ [Contributors](#contributors)
 8. ⚖️  [License](#license)
- 
+
 ## Features
 - **Web/Mobile Support:** fe-pilot will be helpfull in Large/Mid/Small size of web based applications.
 - **Ease of Use:** fe-pilot contains a set of components like `Scanner`, `PhoneBook`, `Voice Search`, `Share`, `Live Location Tracking`, `Current Location` that are easy to plug and play.
@@ -49,19 +49,19 @@ A React UI library for Advance Web Features that streamlines the development of
 ## Installation
 Install `fe-pilot` package using any package manager
 
-###### 1. Package Manager yarn 
+###### 1. Package Manager yarn
 ```sh
 yarn add fe-pilot
 ```
-###### 2. Package Manager npm 
-```sh  
+###### 2. Package Manager npm
+```sh
 npm i fe-pilot --save
 ```
-###### 3. Package Manager pnpm 
+###### 3. Package Manager pnpm
 ```sh
 pnpm add fe-pilot
 ```
-###### 4. Package Manager bun 
+###### 4. Package Manager bun
 ```sh
 bun add fe-pilot
 ```
@@ -72,7 +72,7 @@ bun add fe-pilot
 ```js
 import Share from 'fe-pilot/Share';
 
-<Share 
+<Share
   name={'fe-pilot'}
   title={'A React library for advance web features'}
   url={'https://www.npmjs.com/package/fe-pilot'}
@@ -82,7 +82,7 @@ import Share from 'fe-pilot/Share';
 > <details>
 >  <summary>See the list of components</summary>
 >
->  ### 
+>  ###
 >  01. :white_check_mark: AutoFillOtp &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [Implementation & Structure](https://github.com/opensrc0/fe-pilot/blob/main/__app/component/AutoFillOtp/README.md)
 >  00. :white_check_mark: ColorPicker&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [Implementation & Structure](https://github.com/opensrc0/fe-pilot/blob/main/__app/component/ColorPicker/README.md)
 >  00. :white_check_mark: CopyToClipboard&nbsp; [Implementation & Structure](https://github.com/opensrc0/fe-pilot/blob/main/__app/component/CopyToClipboard/README.md)
@@ -104,13 +104,6 @@ import Share from 'fe-pilot/Share';
 <!-- - TypeScript Starter: WIP -->
 <!-- - NextJS TypeScript Starter: WIP -->
 
-#### 2. Stackblitz
-- JavaScript Starter: https://stackblitz.com/edit/fe-pilot?file=src%2FApp.jsx
-<!-- - TypeScript Starter: WIP -->
-<!-- - NextJS TypeScript Starter: WIP -->
-<!-- - purple -->
-<br />
-
 ## Demo the features and component
 1. https://6jpxdq.csb.app/
 > [!IMPORTANT]
@@ -119,7 +112,7 @@ import Share from 'fe-pilot/Share';
 <br />
 
 ## Contributing
-Feel like contributing? Most welcome! 
+Feel like contributing? Most welcome!
 [Setup locally](https://github.com/opensrc0/fe-pilot/blob/HEAD/.github/SETUP.md) to get fe-pilot working on your local machine and [guide lines](https://github.com/opensrc0/fe-pilot/blob/main/.github/CONTRIBUTING.md) to contribute in fe-pilot.
 
 ## Contributors

diff --git a/.github/SETUP.md b/.github/SETUP.md
@@ -3,7 +3,7 @@ Clone the repository and run the following commands from the root directory of f
 
 ## Local setup
 
-#### 1. Go to the fe-pilot repo location in your terminal and do 
+#### 1. Go to the fe-pilot repo location in your terminal and do
 ```
 npm install
 npm start
@@ -37,8 +37,8 @@ import { TextToSpeechInit, TextToSpeechStart, TextToSpeechStop } from 'fe-pilot/
 ## Folder Structure
 ```
 fe-pilot
-  └── __app      
-    └── component                   
+  └── __app
+    └── component
       ├──TextToSpeech                (component name)
       |   ├──TextToSpeech.js         (top level exports/re-exports)
       |   ├──TextToSpeechInit.js     (parent component)

diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@
 <h3 >
   <p align="center" class="tasklist-issue-content">
     <a href="https://www.npmjs.com/package/fe-pilot">
-     <img alt="Minified Size" src="https://badgen.net/bundlephobia/minzip/fe-pilot?color=cyan"/>
+     <img alt="Minified Size" src="https://img.shields.io/bundlephobia/min/fe-pilot"/>
     </a>
     <a href="https://react.dev/reference/react">
     <img alt="React Version" src="https://img.shields.io/badge/react-18.2.0-%23f1e05a?logo=React"/>
@@ -40,7 +40,7 @@ A React UI library for Advance Web Features that streamlines the development of
 6. 📝 [Contributing](#contributing)
 7. ✨ [Contributors](#contributors)
 8. ⚖️  [License](#license)
- 
+
 ## Features
 - **Web/Mobile Support:** fe-pilot will be helpfull in Large/Mid/Small size of web based applications.
 - **Ease of Use:** fe-pilot contains a set of components like `Scanner`, `PhoneBook`, `Voice Search`, `Share`, `Live Location Tracking`, `Current Location` that are easy to plug and play.
@@ -49,19 +49,19 @@ A React UI library for Advance Web Features that streamlines the development of
 ## Installation
 Install `fe-pilot` package using any package manager
 
-###### 1. Package Manager yarn 
+###### 1. Package Manager yarn
 ```sh
 yarn add fe-pilot
 ```
-###### 2. Package Manager npm 
-```sh  
+###### 2. Package Manager npm
+```sh
 npm i fe-pilot --save
 ```
-###### 3. Package Manager pnpm 
+###### 3. Package Manager pnpm
 ```sh
 pnpm add fe-pilot
 ```
-###### 4. Package Manager bun 
+###### 4. Package Manager bun
 ```sh
 bun add fe-pilot
 ```
@@ -72,7 +72,7 @@ bun add fe-pilot
 ```js
 import Share from 'fe-pilot/Share';
 
-<Share 
+<Share
   name={'fe-pilot'}
   title={'A React library for advance web features'}
   url={'https://www.npmjs.com/package/fe-pilot'}
@@ -82,19 +82,19 @@ import Share from 'fe-pilot/Share';
 <details>
 <summary>See the list of components</summary>
 
-### 
-1. :white_check_mark: AutoFillOtp &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [Implementation & Structure](https://github.com/opensrc0/fe-pilot/blob/main/__app/component/AutoFillOtp/README.md)
-2. :white_check_mark: ColorPicker&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [Implementation & Structure](https://github.com/opensrc0/fe-pilot/blob/main/__app/component/ColorPicker/README.md)
-3. :white_check_mark: CopyToClipboard&nbsp; [Implementation & Structure](https://github.com/opensrc0/fe-pilot/blob/main/__app/component/CopyToClipboard/README.md)
-4. :white_check_mark: FaceDetector&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [Implementation & Structure](https://github.com/opensrc0/fe-pilot/blob/main/__app/component/FaceDetector/README.md)
-5. :white_check_mark: LiveLocation &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [Implementation & Structure](https://github.com/opensrc0/fe-pilot/blob/main/__app/component/LiveLocationTracking/README.md)
-6. :white_check_mark: LocateMe &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [Implementation & Structure](https://github.com/opensrc0/fe-pilot/blob/main/__app/component/LocateMe/README.md)
-7. :white_check_mark: PhoneBook &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [Implementation & Structure](https://github.com/opensrc0/fe-pilot/blob/main/__app/component/PhoneBook/README.md)
-8. :white_check_mark: Scanner &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [Implementation & Structure](https://github.com/opensrc0/fe-pilot/blob/main/__app/component/Scanner/README.md)
-9. :white_check_mark: Share &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [Implementation & Structure](https://github.com/opensrc0/fe-pilot/blob/main/__app/component/Share/README.md)
-10. :white_check_mark: TextToSpeech &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [Implementation & Structure](https://github.com/opensrc0/fe-pilot/blob/main/__app/component/TextToSpeech/README.md)
-11. :white_check_mark: VoiceRecognition&nbsp; [Implementation & Structure](https://github.com/opensrc0/fe-pilot/blob/main/__app/component/VoiceRecognition/README.md)
-12. :white_check_mark: Vibrate &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Implementation & Structure](https://github.com/opensrc0/fe-pilot/blob/main/__app/component/Vibrate/README.md)
+###
+1. :white_check_mark: [Implementation & Structure](https://github.com/opensrc0/fe-pilot/blob/main/__app/component/AutoFillOtp/README.md) AutoFillOtp
+2. :white_check_mark: [Implementation & Structure](https://github.com/opensrc0/fe-pilot/blob/main/__app/component/ColorPicker/README.md) ColorPicker
+3. :white_check_mark: [Implementation & Structure](https://github.com/opensrc0/fe-pilot/blob/main/__app/component/CopyToClipboard/README.md) CopyToClipboard
+4. :white_check_mark: [Implementation & Structure](https://github.com/opensrc0/fe-pilot/blob/main/__app/component/FaceDetector/README.md) FaceDetector
+5. :white_check_mark: [Implementation & Structure](https://github.com/opensrc0/fe-pilot/blob/main/__app/component/LiveLocationTracking/README.md) LiveLocation
+6. :white_check_mark: [Implementation & Structure](https://github.com/opensrc0/fe-pilot/blob/main/__app/component/LocateMe/README.md) LocateMe
+7. :white_check_mark: [Implementation & Structure](https://github.com/opensrc0/fe-pilot/blob/main/__app/component/PhoneBook/README.md) PhoneBook
+8. :white_check_mark: [Implementation & Structure](https://github.com/opensrc0/fe-pilot/blob/main/__app/component/Scanner/README.md) Scanner
+9. :white_check_mark: [Implementation & Structure](https://github.com/opensrc0/fe-pilot/blob/main/__app/component/Share/README.md) Share
+10. :white_check_mark: [Implementation & Structure](https://github.com/opensrc0/fe-pilot/blob/main/__app/component/TextToSpeech/README.md) TextToSpeech
+11. :white_check_mark: [Implementation & Structure](https://github.com/opensrc0/fe-pilot/blob/main/__app/component/VoiceRecognition/README.md) VoiceRecognition
+12. :white_check_mark: [Implementation & Structure](https://github.com/opensrc0/fe-pilot/blob/main/__app/component/Vibrate/README.md) Vibrate
 ></details>
 
 ## Online Editor Templates
@@ -104,20 +104,13 @@ import Share from 'fe-pilot/Share';
 <!-- - TypeScript Starter: WIP -->
 <!-- - NextJS TypeScript Starter: WIP -->
 
-#### 2. Stackblitz
-- JavaScript Starter: https://stackblitz.com/edit/fe-pilot?file=src%2FApp.jsx
-<!-- - TypeScript Starter: WIP -->
-<!-- - NextJS TypeScript Starter: WIP -->
-
-<br />
-
 ## Demo the features and component
 
 1. https://6jpxdq.csb.app/
 
 
 ## Contributing
-Feel like contributing? Most welcome! 
+Feel like contributing? Most welcome!
 [Setup locally](https://github.com/opensrc0/fe-pilot/blob/HEAD/.github/SETUP.md) to get fe-pilot working on your local machine and [guide lines](https://github.com/opensrc0/fe-pilot/blob/main/.github/CONTRIBUTING.md) to contribute in fe-pilot.
 
 ## Contributors

diff --git a/__app/component/FaceDetector/README.md b/__app/component/FaceDetector/README.md
@@ -0,0 +1,8 @@
+
+
+```mermaid
+graph TD;
+    FaceDetector--->FaceDetectorClose;
+    FaceDetector--->FaceDetectorFacing;
+    FaceDetector--->FaceDetectorFlash;
+```
diff --git a/__app/component/Scanner/README.md b/__app/component/Scanner/README.md
@@ -1 +1,12 @@
 
+
+```mermaid
+graph TD;
+    Scanner--->CameraClick;
+    Scanner--->CameraClose;
+    Scanner--->CameraFacing;
+    Scanner--->CameraFlash;
+    Scanner--->CameraScanBox;
+    Scanner--->PhoneGallery;
+    Scanner--->StartCamera;
+```
diff --git a/__app/component/TextToSpeech/README.md b/__app/component/TextToSpeech/README.md
@@ -1,4 +1,4 @@
-## 1. Happy Flow 
+## 1. Happy Flow
 
 ```js
 <VoiceRecognitionInit>
@@ -11,5 +11,10 @@
 </VoiceRecognitionInit>
 ```
 
-
-
+
+```mermaid
+graph TD;
+    TextToSpeech--->TextToSpeechInit;
+    TextToSpeech--->TextToSpeechStart;
+    TextToSpeech--->TextToSpeechStop;
+```
diff --git a/__app/component/VoiceRecognition/README.md b/__app/component/VoiceRecognition/README.md
@@ -1,5 +1,5 @@
 
-## 1. Happy Flow 
+## 1. Happy Flow
 
 ```js
 <TextToSpeech.Init text="Password field is not contained in a form: (More info: ">
@@ -8,5 +8,10 @@
 </TextToSpeech.Init>
 ```
 
-
-
+
+```mermaid
+graph TD;
+    VoiceRecognition--->TextToSpeechInit;
+    VoiceRecognition--->VoiceRecognitionIcon;
+    VoiceRecognition--->VoiceRecognitionModal;
+```
diff --git a/__app/component/WhatsappShare/README.md b/__app/component/WhatsappShare/README.md
@@ -0,0 +1,43 @@
+## 1. Happy Flow
+#### a) Passing child
+
+
+
+
+## 2. Success: successCb callBack Fn along with success msg
+
+
+
+
+
+> [!Note]
+> **successCb** will get an object contains the property **msgType**, **msg**, **data**
+
+## 3. Failure: failureCb callBack Fn along with failure msg
+
+
+
+
+
+> [!Note]
+> **failureCb** will get an object contains the property **msgType**, **msg**
+
+> [!Important]
+Failure can happend due to multiple reasons, due to that reason **failureMsg** is an object having different kind of error property according to the error can occur in component
+
+## 4. Failure: Device don't support the feature and you want to hide the feauture from User
+
+
+
+
+
+> [!Note]
+> if **showForever** props value is false, feature will be hidden in case of unSupported by the device
+
+## 5. Combine with all props
+
+
+
+
+
+