Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(whatsapp share): whatsapp share component has been added successfully #22

Merged
merged 10 commits into from
Apr 9, 2024
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* text=auto
33 changes: 22 additions & 11 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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?

Expand All @@ -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?

Expand Down Expand Up @@ -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

Expand Down
27 changes: 10 additions & 17 deletions .github/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"/>
Expand Down Expand Up @@ -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.
Expand All @@ -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
```
Expand All @@ -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'}
Expand All @@ -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)
Expand All @@ -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]
Expand All @@ -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
Expand Down
6 changes: 3 additions & 3 deletions .github/SETUP.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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)
Expand Down
51 changes: 22 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"/>
Expand Down Expand Up @@ -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.
Expand All @@ -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
```
Expand All @@ -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'}
Expand All @@ -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
Expand All @@ -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
Expand Down
8 changes: 8 additions & 0 deletions __app/component/FaceDetector/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@


```mermaid
graph TD;
FaceDetector--->FaceDetectorClose;
FaceDetector--->FaceDetectorFacing;
FaceDetector--->FaceDetectorFlash;
```
11 changes: 11 additions & 0 deletions __app/component/Scanner/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,12 @@


```mermaid
graph TD;
Scanner--->CameraClick;
Scanner--->CameraClose;
Scanner--->CameraFacing;
Scanner--->CameraFlash;
Scanner--->CameraScanBox;
Scanner--->PhoneGallery;
Scanner--->StartCamera;
```
11 changes: 8 additions & 3 deletions __app/component/TextToSpeech/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## 1. Happy Flow
## 1. Happy Flow

```js
<VoiceRecognitionInit>
Expand All @@ -11,5 +11,10 @@
</VoiceRecognitionInit>
```




```mermaid
graph TD;
TextToSpeech--->TextToSpeechInit;
TextToSpeech--->TextToSpeechStart;
TextToSpeech--->TextToSpeechStop;
```
11 changes: 8 additions & 3 deletions __app/component/VoiceRecognition/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

## 1. Happy Flow
## 1. Happy Flow

```js
<TextToSpeech.Init text="Password field is not contained in a form: (More info: ">
Expand All @@ -8,5 +8,10 @@
</TextToSpeech.Init>
```




```mermaid
graph TD;
VoiceRecognition--->TextToSpeechInit;
VoiceRecognition--->VoiceRecognitionIcon;
VoiceRecognition--->VoiceRecognitionModal;
```
43 changes: 43 additions & 0 deletions __app/component/WhatsappShare/README.md
Original file line number Diff line number Diff line change
@@ -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






Loading