https://github.com/ayoubamine/flutter_tawk

Tawk widget for Flutter.
https://github.com/ayoubamine/flutter_tawk

dart flutter flutter-package

Last synced: about 2 months ago
JSON representation

Tawk widget for Flutter.

• Host: GitHub
• URL: https://github.com/ayoubamine/flutter_tawk
• Owner: ayoubamine
• License: mit
• Created: 2020-10-29T12:02:12.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-03-04T10:57:41.000Z (7 months ago)
• Last Synced: 2024-07-08T21:03:06.468Z (2 months ago)
• Topics: dart, flutter, flutter-package
• Language: Dart
• Homepage: https://pub.dev/packages/flutter_tawk
• Size: 390 KB
• Stars: 19
• Watchers: 2
• Forks: 53
• Open Issues: 23
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# flutter_tawk

[![pub package](https://img.shields.io/pub/v/flutter_tawk.svg)](https://pub.dartlang.org/packages/flutter_tawk)



[Tawk](https://www.tawk.to) widget for Flutter.

## 🚀 Showcase



    

    

    



## Install

To use this package, add `flutter_tawk` as dependency in your pubspec.yaml file.

## Import

```dart

import 'package:flutter_tawk/flutter_tawk.dart';

```

## How To Use

```dart

Tawk(

    directChatLink: 'YOUR_DIRECT_CHAT_LINK',

    visitor: TawkVisitor(

        name: 'Ayoub AMINE',

        email: '[email protected]',

    ),

)

```

See the `example` directory for the complete sample app.

## Customization

### Tawk

| Parameter      | Type          | Default                                      | Description                                    | Required |

| -------------- | ------------- | -------------------------------------------- | ---------------------------------------------- | -------- |

| directChatLink | `String`      | `null`                                       | Tawk direct chat link.                         | Yes      |

| visitor        | `TawkVisitor` | `null`                                       | Object used to set the visitor name and email. | No       |

| onLoad         | `Function`    | `null`                                       | Called right after the widget is rendered.     | No       |

| onLinkTap      | `Function`    | `null`                                       | Called when a link pressed.                    | No       |

| placeholder    | `Widget`      | `Center(child: CircularProgressIndicator())` | Render your own loading widget.                | No       |

### TawkVisitor

| Parameter | Type     | Default | Description                                                 | Required |

| --------- | -------- | ------- | ----------------------------------------------------------- | -------- |

| name      | `String` | `null`  | Visitor's name.                                             | No       |

| email     | `String` | `null`  | Visitor's email.                                            | No       |

| hash      | `String` | `null`  | [Secure mode](https://developer.tawk.to/jsapi/#SecureMode). | No       |

## Contributions

Feel free to contribute to this project.

If you find a bug or want a feature, but don't know how to fix/implement it, please fill an [issue](https://github.com/ayoubamine/flutter_tawk/issues).  

If you fixed a bug or implemented a new feature, please send a [pull request](https://github.com/ayoubamine/flutter_tawk/pulls).

## Changelog

[CHANGELOG](./CHANGELOG.md)

## License

[MIT License](./LICENSE)