{"id":15177509,"url":"https://github.com/emanuel-braz/save_note","last_synced_at":"2026-03-01T15:31:14.588Z","repository":{"id":254854124,"uuid":"847522314","full_name":"emanuel-braz/save_note","owner":"emanuel-braz","description":"A lightweight tool for quickly draw on your Flutter app screen and send the notes to Slack channel, Gitlab and other platforms.","archived":false,"fork":false,"pushed_at":"2024-08-30T02:24:42.000Z","size":154,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-23T11:16:03.647Z","etag":null,"topics":["flutter","slack","tools"],"latest_commit_sha":null,"homepage":"https://pub.dev/packages/save_note","language":"Dart","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/emanuel-braz.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-08-26T02:54:50.000Z","updated_at":"2025-01-18T12:31:58.000Z","dependencies_parsed_at":null,"dependency_job_id":"2e52bdbf-5a16-49ee-8a58-60d31d81941d","html_url":"https://github.com/emanuel-braz/save_note","commit_stats":{"total_commits":16,"total_committers":1,"mean_commits":16.0,"dds":0.0,"last_synced_commit":"da1d1a53493f94d78cfd3b9546a93d78e2d815c0"},"previous_names":["emanuel-braz/save_note"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/emanuel-braz/save_note","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emanuel-braz%2Fsave_note","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emanuel-braz%2Fsave_note/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emanuel-braz%2Fsave_note/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emanuel-braz%2Fsave_note/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/emanuel-braz","download_url":"https://codeload.github.com/emanuel-braz/save_note/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/emanuel-braz%2Fsave_note/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29973312,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-01T15:29:09.406Z","status":"ssl_error","status_checked_at":"2026-03-01T15:28:28.558Z","response_time":124,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["flutter","slack","tools"],"created_at":"2024-09-27T14:40:14.331Z","updated_at":"2026-03-01T15:31:14.568Z","avatar_url":"https://github.com/emanuel-braz.png","language":"Dart","funding_links":["https://www.buymeacoffee.com/emanuelbraz"],"categories":[],"sub_categories":[],"readme":"# Save Note\n[![Pub Version](https://img.shields.io/pub/v/save_note?color=%2302569B\u0026label=pub\u0026logo=flutter)](https://pub.dev/packages/save_note) ![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)\n## Getting Started\n\n### Features\n* In the screenshot editor, you can add notes, draw on the screenshot, and send it to Slack and to other services (**see CustomNoteSender example**).\n* 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.\n* Long press the quick action button to dismiss it.\n* Tap the quick action button to take a screenshot and open the screenshot editor.\n* Drag the quick action button to move it around the screen.\n\n```dart\nNoteQuickActionButton.show(context);\n```\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://github.com/user-attachments/assets/cc3b93ff-0e64-43e5-8300-909e0669caf2\" alt=\"First Image\" width=\"200\"/\u003e\n  \u003cimg src=\"https://github.com/user-attachments/assets/957b9a5f-4df6-47a2-ac31-9cfd2aaefffb\" alt=\"Second Image\" width=\"200\"/\u003e\n  \u003cimg src=\"https://github.com/user-attachments/assets/099bdfab-d274-479d-8c2c-ad6bab506117\" alt=\"Third Image\" width=\"200\"/\u003e\n\u003c/p\u003e\n\n### Configuration\n```dart\n@override\n  initState() {\n    super.initState();\n\n    // IMPORTANT: Add the NoteSender to the controller\n    // This is a one-time setup for the app, and they will be available on Screenshot Editor.\n\n    // As an example, we are adding a SlackNoteSender and a [CustomNoteSender] that I created for this example.\n    AppNoteController().addNoteSenders([\n      SlackNoteSender(\n        token: const String.fromEnvironment('SLACK_API_TOKEN'), // Slack API token (xoxb-...) - You can get it from https://api.slack.com/apps\n        channelId: const String.fromEnvironment('SLACK_CHANNEL_ID_QA'), // Slack channel ID (public or private)\n        name: 'QA Team Notes',\n        // Optional\n        onSuccess: () {\n          debugPrint('✨ Note sent to Slack!');\n        },\n        // Optional\n        onError: (error) {\n          debugPrint('🚫 Error sending note to Slack: $error');\n        },\n      ),\n      GitlabNoteSender(\n        projectId: const String.fromEnvironment('GITLAB_PROJECT_ID'),\n        token: const String.fromEnvironment('GITLAB_TOKEN'),\n        name: 'Gitlab Issues',\n        gitlabExtras: GitlabExtras(labels: 'my_notes'), // Initial value - Comma separated labels\n        onSuccess: () {\n          debugPrint('✨ Note sent to Gitlab!');\n        },\n        onError: (error) {\n          debugPrint('🚫 Error sending note to Gitlab: $error');\n        },\n      ),\n      CustomNoteSender(), // CustomNoteSender is a custom implementation of NoteSender that I created for this example (see example project)\n    ]);\n  }\n```\n\n#### Configure a VSCode Launcher with --dart-define\n\u003e **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.\n```json\n{\n  \"version\": \"0.2.0\",\n  \"configurations\": [\n    {\n      \"name\": \"Flutter\",\n      \"request\": \"launch\",\n      \"type\": \"dart\",\n      \"program\": \"lib/main.dart\",\n      \"args\": [\n        \"--dart-define=SLACK_API_TOKEN=xoxb-...\",\n        \"--dart-define=SLACK_CHANNEL_QA_TEAM=...\"\n        \"--dart-define=SLACK_CHANNEL_DEV_TEAM=...\"\n        \"--dart-define=SLACK_CHANNEL_STAKEHOLDERS=...\"\n      ]\n    }\n  ]\n}\n```\n\n\n### Android\n\nFor Android platform, you need to add the following permissions into the **AndroidManifest.xml** file.\n\n```xml\n\u003cuses-permission android:name=\"android.permission.WRITE_EXTERNAL_STORAGE\" /\u003e\n```\n\nAnd don't forget to add the following property to the `application` tag in the **AndroidManifest.xml** file.\n\n```\nandroid:requestLegacyExternalStorage=\"true\"\n```\n\n### iOS\n\nFor iOS platform, you need to add the following permissions into the **Info.plist** file.\n\n```\n\u003ckey\u003eNSPhotoLibraryAddUsageDescription\u003c/key\u003e\n\u003cstring\u003eTake screenshots and save it\u003c/string\u003e\n```\n\n### Usage Example\n\nFor usage examples, please see the **example** project.\n\n### Built-in Widgets\n#### `ThreeFingerTapDetector`\n```dart\nMaterialApp(\n  home: ThreeFingerTapDetector(\n    child: Center(\n      child: Text(\n        'Tap with three fingers to show the screenshot editor.',\n        style: TextStyle(color: Colors.white),\n      ),\n    ),\n  ),\n),\n```\n\n#### `TapCounter`\n```dart\nTapCounter(\n  requiredTaps: 5,\n  onSuccess: () {\n    NoteQuickActionButton.show(context);\n  },\n  child: OutlinedButton(\n    onPressed: () async {},\n    child: const Text('Tap 5 times'),\n  ),\n),\n```\n\n### Important Notes\n\nPlease note that this plugin does not handle the runtime permission checking process.\nTherefore, make sure you check the runtime permission first using the `permission_handler` plugin.\n\n\u003ca href=\"https://www.buymeacoffee.com/emanuelbraz\" target=\"_blank\"\u003e\u003cimg src=\"https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png\" alt=\"Buy Me A Coffee\" style=\"height: 50px !important;width: 217px !important;\" \u003e\u003c/a\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Femanuel-braz%2Fsave_note","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Femanuel-braz%2Fsave_note","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Femanuel-braz%2Fsave_note/lists"}