https://github.com/Imgkl/davinci

A flutter package to convert any widget to an Image.
https://github.com/Imgkl/davinci

flutter flutter-package flutter-plugin image widgets

Last synced: 3 months ago
JSON representation

A flutter package to convert any widget to an Image.

• Host: GitHub
• URL: https://github.com/Imgkl/davinci
• Owner: Imgkl
• License: mit
• Created: 2021-05-02T18:07:06.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-10-07T11:55:37.000Z (4 months ago)
• Last Synced: 2024-10-07T12:24:45.376Z (4 months ago)
• Topics: flutter, flutter-package, flutter-plugin, image, widgets
• Language: C++
• Homepage: https://pub.dev/packages/davinci
• Size: 338 KB
• Stars: 47
• Watchers: 4
• Forks: 25
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        





Davinci is a powerful package that allows you to convert any widget into an image, which can be saved locally or shared across apps and chats. Perfect for creating snapshots of your UI! 📸

## 🛠️ Supported Platforms

| Platform | Status  |

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

| Android  | ✅      |

| iOS      | ✅      |

| Web      | ✅      |

*Feel free to test it on other platforms and report back with your findings!* 🚀

## 📹 Preview



## Prerequisites

**For iOS**  

Add the following keys to your _Info.plist_ file, located in `/ios/Runner/Info.plist`:

- `NSPhotoLibraryUsageDescription` - Describe why your app needs permission for the photo library. This is called _Privacy - Photo Library Usage Description_ in the visual editor.

**For Android**  

Add the following permission to your `AndroidManifest.xml`:

- `android.permission.WRITE_EXTERNAL_STORAGE` - Permission for usage of external storage.

## ℹ️ Usage

### Imports

```dart

import 'package:davinci/core/davinci_capture.dart';

import 'package:davinci/davinci.dart';

```

### Code

#### If the widget is in the widget tree, use the `click` method:



#### If the widget is not in the widget tree, use the `offStage` method:





## 🎨 Customization



ℹ️ All the parameters in the `click` method are present in the `offStage` method except the `brandTag` prop.

## 🛎️ Note:

- **If you wish to save the generated images locally, do remember to add the necessary permissions in `Info.plist` and `AndroidManifest.xml`.**