Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/emanuel-braz/save_note
A lightweight tool for quickly draw on your Flutter app screen and send the notes to Slack channel, Gitlab and other platforms.
https://github.com/emanuel-braz/save_note
flutter slack tools
Last synced: 28 days ago
JSON representation
A lightweight tool for quickly draw on your Flutter app screen and send the notes to Slack channel, Gitlab and other platforms.
- Host: GitHub
- URL: https://github.com/emanuel-braz/save_note
- Owner: emanuel-braz
- License: gpl-3.0
- Created: 2024-08-26T02:54:50.000Z (2 months ago)
- Default Branch: master
- Last Pushed: 2024-08-30T02:24:42.000Z (2 months ago)
- Last Synced: 2024-09-28T14:40:13.260Z (about 1 month ago)
- Topics: flutter, slack, tools
- Language: Dart
- Homepage: https://pub.dev/packages/save_note
- Size: 150 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Save Note
[](https://pub.dev/packages/save_note) 
## Getting Started
### Features
* In the screenshot editor, you can add notes, draw on the screenshot, and send it to Slack and to other services (**see CustomNoteSender example**).
* Activate a quick action button that allows you to save the screenshot of the current screen and send it to a Slack channel with a note.
* Long press the quick action button to dismiss it.
* Tap the quick action button to take a screenshot and open the screenshot editor.
* Drag the quick action button to move it around the screen.
```dart
NoteQuickActionButton.show(context);
```
### Configuration
```dart
@override
initState() {
super.initState();
// IMPORTANT: Add the NoteSender to the controller
// This is a one-time setup for the app, and they will be available on Screenshot Editor.
// As an example, we are adding a SlackNoteSender and a [CustomNoteSender] that I created for this example.
AppNoteController().addNoteSenders([
SlackNoteSender(
token: const String.fromEnvironment('SLACK_API_TOKEN'), // Slack API token (xoxb-...) - You can get it from https://api.slack.com/apps
channelId: const String.fromEnvironment('SLACK_CHANNEL_ID_QA'), // Slack channel ID (public or private)
name: 'QA Team Notes',
// Optional
onSuccess: () {
debugPrint('✨ Note sent to Slack!');
},
// Optional
onError: (error) {
debugPrint('🚫 Error sending note to Slack: $error');
},
),
GitlabNoteSender(
projectId: const String.fromEnvironment('GITLAB_PROJECT_ID'),
token: const String.fromEnvironment('GITLAB_TOKEN'),
name: 'Gitlab Issues',
gitlabExtras: GitlabExtras(labels: 'my_notes'), // Initial value - Comma separated labels
onSuccess: () {
debugPrint('✨ Note sent to Gitlab!');
},
onError: (error) {
debugPrint('🚫 Error sending note to Gitlab: $error');
},
),
CustomNoteSender(), // CustomNoteSender is a custom implementation of NoteSender that I created for this example (see example project)
]);
}
```
#### Configure a VSCode Launcher with --dart-define
> **Note:** You can also use the `.env` file to store the environment variables in development mode, remote config, or any other aproach that you prefer. For this example, I'm using the `launch.json` file and dart-define.
```json
{
"version": "0.2.0",
"configurations": [
{
"name": "Flutter",
"request": "launch",
"type": "dart",
"program": "lib/main.dart",
"args": [
"--dart-define=SLACK_API_TOKEN=xoxb-...",
"--dart-define=SLACK_CHANNEL_QA_TEAM=..."
"--dart-define=SLACK_CHANNEL_DEV_TEAM=..."
"--dart-define=SLACK_CHANNEL_STAKEHOLDERS=..."
]
}
]
}
```
### Android
For Android platform, you need to add the following permissions into the **AndroidManifest.xml** file.
```xml
```
And don't forget to add the following property to the `application` tag in the **AndroidManifest.xml** file.
```
android:requestLegacyExternalStorage="true"
```
### iOS
For iOS platform, you need to add the following permissions into the **Info.plist** file.
```
NSPhotoLibraryAddUsageDescription
Take screenshots and save it
```
### Usage Example
For usage examples, please see the **example** project.
### Built-in Widgets
#### `ThreeFingerTapDetector`
```dart
MaterialApp(
home: ThreeFingerTapDetector(
child: Center(
child: Text(
'Tap with three fingers to show the screenshot editor.',
style: TextStyle(color: Colors.white),
),
),
),
),
```
#### `TapCounter`
```dart
TapCounter(
requiredTaps: 5,
onSuccess: () {
NoteQuickActionButton.show(context);
},
child: OutlinedButton(
onPressed: () async {},
child: const Text('Tap 5 times'),
),
),
```
### Important Notes
Please note that this plugin does not handle the runtime permission checking process.
Therefore, make sure you check the runtime permission first using the `permission_handler` plugin.
