Skip to content

docs: improve share_plus README clarity #3736

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.

Sign up for GitHub

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

Open
bouchinaseifeddine wants to merge 1 commit into
base: main
Choose a base branch
from
+13 −11
Open

docs: improve share_plus README clarity #3736

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 13 additions & 11 deletions packages/share_plus/share_plus/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,20 @@

[<img src="../../../assets/flutter-favorite-badge.png" width="100" />](https://flutter.dev/docs/development/packages-and-plugins/favorites)

A Flutter plugin to share content from your Flutter app via the platform's
share dialog.
A Flutter plugin that allows you to share content from your Flutter application
using the platform’s native share dialog.

Wraps the `ACTION_SEND` Intent on Android, `UIActivityViewController`
on iOS, or equivalent platform content sharing methods.
It wraps platform-specific sharing mechanisms such as the `ACTION_SEND` Intent
on Android, `UIActivityViewController` on iOS, and equivalent sharing methods
on other supported platforms.

## Platform Support

| Shared content | Android | iOS | macOS | Web | Linux | Windows |
| :------------: | :-----: | :-: | :---: | :-: | :---: | :-----: |
| Text | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| URI | ✅ | ✅ | ✅ | As text | As text | As text |
| Files | ✅ | ✅ | ✅ | ✅ | ❌ | ✅ |
| Shared content | Android | iOS | macOS | Web | Linux | Windows |
| :------------: | :-----: | :-: | :---: | :-----: | :-----: | :-----: |
| Text | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| URI | ✅ | ✅ | ✅ | As text | As text | As text |
| Files | ✅ | ✅ | ✅ | ✅ | ❌ | ✅ |

Also compatible with Windows and Linux by using "mailto" to share text via Email.

Expand All @@ -37,9 +38,10 @@ Sharing files is not supported on Linux.

## Usage

To use this plugin, add `share_plus` as a [dependency in your pubspec.yaml file](https://plus.fluttercommunity.dev/docs/overview).
To use this plugin, add `share_plus` as a dependency in your `pubspec.yaml` file.
More information can be found in the official documentation.

Import the library.
Then, import the library in your Dart file.

```dart
import 'package:share_plus/share_plus.dart';
Expand Down