Share Plus

https://pub.dev/packages/share_plus
Admin
A Flutter plugin that enables sharing content from your app via the platform's native share dialog,...
Tokens:16,490
Snippets:117
Trust Score:9.9
Update:1 month ago
Show doc for...
Tokens:
Raw
### share_plus example main.dart - app setup and share input fields

Source: https://pub.dev/packages/share_plus/example

The main entry point of the share_plus example app. It sets up the MaterialApp and the home page with text fields for share text, subject, title, URI, and filename, plus an image preview area and an 'Add image' button. The code is truncated at the point where the image picker logic begins.

```dart
// Copyright 2019 The Flutter Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

// ignore_for_file: public_member_api_docs

import 'dart:convert';
import 'dart:io';
import 'package:file_selector/file_selector.dart'
    hide XFile; // hides to test if share_plus exports XFile
import 'package:flutter/foundation.dart';
import 'package:flutter/material.dart';
import 'package:flutter/services.dart';
import 'package:image_picker/image_picker.dart'
    hide XFile; // hides to test if share_plus exports XFile
import 'package:share_plus/share_plus.dart';

import 'excluded_activity_type.dart';
import 'image_previews.dart';

void main() {
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Share Plus Plugin Demo',
      theme: ThemeData(
        useMaterial3: true,
        colorSchemeSeed: const Color(0x9f4376f8),
      ),
      home: const MyHomePage(),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({super.key});

  @override
  State<StatefulWidget> createState() => MyHomePageState();
}

class MyHomePageState extends State<MyHomePage> {
  String text = '';
  String subject = '';
  String title = '';
  String uri = '';
  String fileName = '';
  List<String> imageNames = [];
  List<String> imagePaths = [];
  List<CupertinoActivityType> excludedCupertinoActivityType = [];

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: const Text('Share Plus Plugin Demo'), elevation: 4),
      body: SingleChildScrollView(
        padding: const EdgeInsets.all(24),
        child: Column(
          crossAxisAlignment: CrossAxisAlignment.start,
          mainAxisSize: MainAxisSize.min,
          children: <Widget>[
            TextField(
              decoration: const InputDecoration(
                border: OutlineInputBorder(),
                labelText: 'Share text',
                hintText: 'Enter some text and/or link to share',
              ),
              maxLines: null,
              onChanged: (String value) => setState(() {
                text = value;
              }),
            ),
            const SizedBox(height: 16),
            TextField(
              decoration: const InputDecoration(
                border: OutlineInputBorder(),
                labelText: 'Share subject',
                hintText: 'Enter subject to share (optional)',
              ),
              maxLines: null,
              onChanged: (String value) => setState(() {
                subject = value;
              }),
            ),
            const SizedBox(height: 16),
            TextField(
              decoration: const InputDecoration(
                border: OutlineInputBorder(),
                labelText: 'Share title',
                hintText: 'Enter title to share (optional)',
              ),
              maxLines: null,
              onChanged: (String value) => setState(() {
                title = value;
              }),
            ),
            const SizedBox(height: 16),
            TextField(
              decoration: const InputDecoration(
                border: OutlineInputBorder(),
                labelText: 'Share uri',
                hintText: 'Enter the uri you want to share',
              ),
              maxLines: null,
              onChanged: (String value) {
                setState(() => uri = value);
              },
            ),
            const SizedBox(height: 16),
            TextField(
              decoration: const InputDecoration(
                border: OutlineInputBorder(),
                labelText: 'Share Text as File',
                hintText: 'Enter the filename you want to share your text as',
              ),
              maxLines: null,
              onChanged: (String value) {
                setState(() => fileName = value);
              },
            ),
            const SizedBox(height: 16),
            ImagePreviews(imagePaths, onDelete: _onDeleteImage),
            ElevatedButton.icon(
              label: const Text('Add image'),
              onPressed: () async {
                // Using `package:image_picker` to get image from gallery.
                if (!kIsWeb &&
                    (Platform.isMacOS ||
                        Platform.isLinux ||
                        Platform.isWindows)) {
```

--------------------------------

### Add share_plus_platform_interface with flutter pub add

Source: https://pub.dev/packages/share_plus_platform_interface/install

Run this command in your Flutter project to add the share_plus_platform_interface package. This will also run an implicit `flutter pub get`.

```bash
 $ flutter pub add share_plus_platform_interface
```

--------------------------------

### Add and import share_plus_web

Source: https://pub.dev/packages/share_plus_web/install

Use these commands to add the share_plus_web package to your Flutter project and import it in your Dart code. The first command adds the dependency and runs an implicit flutter pub get. The second shows the resulting pubspec.yaml entry. The third imports the package for use.

```bash
 $ flutter pub add share_plus_web
```

```yaml
dependencies:
  share_plus_web: ^3.1.0
```

```dart
import 'package:share_plus_web/share_plus_web.dart';
```

--------------------------------

### Add and import share_plus_linux

Source: https://pub.dev/packages/share_plus_linux/install

Use these commands to add the share_plus_linux package to your Flutter project and import it in your Dart code. The first command adds the dependency and runs an implicit `flutter pub get`. The second shows the resulting line in pubspec.yaml. The third imports the package for use.

```shell
 $ flutter pub add share_plus_linux
```

```yaml
dependencies:
  share_plus_linux: ^3.0.1
```

```dart
import 'package:share_plus_linux/share_plus_linux.dart';
```

--------------------------------

### Share with result using context

Source: https://pub.dev/packages/share_plus/example

Starts the share-with-result flow, using a builder to obtain the context immediately surrounding the button so that `findRenderObject` returns the button's RenderBox after it is built.

```dart
void _onShareWithResult(BuildContext context) async {
  // A builder is used to retrieve the context immediately
  // surrounding the ElevatedButton.
  //
  // The context's `findRenderObject` returns the first
  // RenderObject in its descendent tree when it's not
  // a RenderObjectWidget. The ElevatedButton's RenderObject
  // has its position and size after it's built.
  final box = context.findRenderObject() as RenderBox?;
```

--------------------------------

### Add share_plus dependency with flutter pub add

Source: https://pub.dev/packages/share_plus/install

Run this command in your Flutter project to add the share_plus package. It will update pubspec.yaml and run flutter pub get.

```bash
$ flutter pub add share_plus
```

--------------------------------

### Share with sharePositionOrigin on iPad using Builder and RenderBox

Source: https://pub.dev/packages/share_plus

Use a Builder to get the widget's context, then obtain its RenderBox to compute the sharePositionOrigin. This anchors the iPad share sheet popover to the tapped widget. If omitted, the popover centers on screen; earlier versions could crash or leave the UI unresponsive.

```Dart
// Use Builder to get the widget context
Builder(
  builder: (BuildContext context) {
    return ElevatedButton(
      onPressed: () => _onShare(context),
          child: const Text('Share'),
     );
  },
),

// _onShare method:
final box = context.findRenderObject() as RenderBox?;

await SharePlus.instance.share(
  ShareParams(
    text: text,
    sharePositionOrigin: box!.localToGlobal(Offset.zero) & box.size,
  )
);
```

--------------------------------

### Select image with file_selector or image_picker

Source: https://pub.dev/packages/share_plus/example

Handles image selection for sharing: uses `package:file_selector` on desktop platforms (Windows, macOS, Linux) where `package:image_picker` is unsupported, and falls back to `ImagePicker` on other platforms. The selected file path and name are added to the state lists.

```dart
// Using `package:file_selector` on windows, macos & Linux, since `package:image_picker` is not supported.
const XTypeGroup typeGroup = XTypeGroup(
  label: 'images',
  extensions: <String>['jpg', 'jpeg', 'png', 'gif'],
);
final file = await openFile(
  acceptedTypeGroups: <XTypeGroup>[typeGroup],
);
if (file != null) {
  setState(() {
    imagePaths.add(file.path);
    imageNames.add(file.name);
  });
}
} else {
  final imagePicker = ImagePicker();
  final pickedFile = await imagePicker.pickImage(
    source: ImageSource.gallery,
  );
  if (pickedFile != null) {
    setState(() {
      imagePaths.add(pickedFile.path);
      imageNames.add(pickedFile.name);
    });
  }
}
},
```

--------------------------------

### Add share_plus_windows with flutter pub add

Source: https://pub.dev/packages/share_plus_windows/install

Run this command in your Flutter project to add the share_plus_windows package as a dependency.

```bash
 $ flutter pub add share_plus_windows
```

--------------------------------

### Share XFile from assets button

Source: https://pub.dev/packages/share_plus/example

Builds a button that calls `_onShareXFileFromAssets` with the current context to share an XFile from assets.

```dart
Builder(
  builder: (BuildContext context) {
    return ElevatedButton(
      style: ElevatedButton.styleFrom(
        foregroundColor: Theme.of(context).colorScheme.onPrimary,
        backgroundColor: Theme.of(context).colorScheme.primary,
      ),
      onPressed: () {
        _onShareXFileFromAssets(context);
      },
      child: const Text('Share XFile from Assets'),
    );
  },
),
```

--------------------------------

### Share text, URIs, and files with SharePlus and display result SnackBar

Source: https://pub.dev/packages/share_plus/example

Shows how to share text, URIs, and files using SharePlus.instance.share with ShareParams. The first block handles image files, URIs, and plain text with optional subject/title and excludes AirDrop. The second block shares an asset as an XFile from data with downloadFallbackEnabled and fileNameOverrides. The third block builds a SnackBar that displays the share result status and, on success, the raw share target.

```dart
final scaffoldMessenger = ScaffoldMessenger.of(context);
    ShareResult shareResult;
    if (imagePaths.isNotEmpty) {
      final files = <XFile>[];
      for (var i = 0; i < imagePaths.length; i++) {
        files.add(XFile(imagePaths[i], name: imageNames[i]));
      }
      shareResult = await SharePlus.instance.share(
        ShareParams(
          text: text.isEmpty ? null : text,
          subject: subject.isEmpty ? null : subject,
          title: title.isEmpty ? null : title,
          files: files,
          sharePositionOrigin: box!.localToGlobal(Offset.zero) & box.size,
          excludedCupertinoActivities: [CupertinoActivityType.airDrop],
        ),
      );
    } else if (uri.isNotEmpty) {
      shareResult = await SharePlus.instance.share(
        ShareParams(
          uri: Uri.parse(uri),
          subject: subject.isEmpty ? null : subject,
          title: title.isEmpty ? null : title,
          sharePositionOrigin: box!.localToGlobal(Offset.zero) & box.size,
          excludedCupertinoActivities: excludedCupertinoActivityType,
        ),
      );
    } else {
      shareResult = await SharePlus.instance.share(
        ShareParams(
          text: text.isEmpty ? null : text,
          subject: subject.isEmpty ? null : subject,
          title: title.isEmpty ? null : title,
          sharePositionOrigin: box!.localToGlobal(Offset.zero) & box.size,
          excludedCupertinoActivities: excludedCupertinoActivityType,
        ),
      );
    }
    scaffoldMessenger.showSnackBar(getResultSnackBar(shareResult));
  }
```

```dart
void _onShareXFileFromAssets(BuildContext context) async {
    final box = context.findRenderObject() as RenderBox?;
    final scaffoldMessenger = ScaffoldMessenger.of(context);
    try {
      final data = await rootBundle.load('assets/flutter_logo.png');
      final buffer = data.buffer;
      final shareResult = await SharePlus.instance.share(
        ShareParams(
          files: [
            XFile.fromData(
              buffer.asUint8List(data.offsetInBytes, data.lengthInBytes),
              name: 'flutter_logo.png',
              mimeType: 'image/png',
            ),
          ],
          sharePositionOrigin: box!.localToGlobal(Offset.zero) & box.size,
          downloadFallbackEnabled: true,
          excludedCupertinoActivities: excludedCupertinoActivityType,
        ),
      );

      scaffoldMessenger.showSnackBar(getResultSnackBar(shareResult));
    } catch (e) {
      scaffoldMessenger.showSnackBar(SnackBar(content: Text('Error: $e')));
    }
  }
```

```dart
SnackBar getResultSnackBar(ShareResult result) {
    return SnackBar(
      content: Column(
        mainAxisSize: MainAxisSize.min,
        crossAxisAlignment: CrossAxisAlignment.start,
        children: [
          Text("Share result: ${result.status}"),
          if (result.status == ShareResultStatus.success)
            Text("Shared to: ${result.raw}"),
        ],
      ),
    );
  }
```

--------------------------------

### Share text as XFile button

Source: https://pub.dev/packages/share_plus/example

Builds a button that shares text as an XFile, disabled when either the file name or text is empty.

```dart
Builder(
  builder: (BuildContext context) {
    return ElevatedButton(
      style: ElevatedButton.styleFrom(
        foregroundColor: Theme.of(context).colorScheme.onPrimary,
        backgroundColor: Theme.of(context).colorScheme.primary,
      ),
      onPressed: fileName.isEmpty || text.isEmpty
          ? null
          : () => _onShareTextAsXFile(context),
      child: const Text('Share text as XFile'),
    );
  },
),
```

--------------------------------

### Configure share sheet title

Source: https://pub.dev/packages/share_plus

Set a title for the share sheet where supported.

```dart
ShareParams(
  // rest of params
  title: 'Title',
)
```

--------------------------------

### Import share_plus_windows in Dart

Source: https://pub.dev/packages/share_plus_windows/install

Use this import statement in your Dart code to access the share_plus_windows package.

```dart
import 'package:share_plus_windows/share_plus_windows.dart';
```

--------------------------------

### BSD-style license for share_plus_web

Source: https://pub.dev/packages/share_plus_web/license

The license text for share_plus_web, a BSD-style license with copyright held by The Chromium Authors. It permits redistribution and use in source and binary forms with conditions, and disclaims warranty and liability.

```text
// Copyright 2017 The Chromium Authors. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//    * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//    * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//    * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

```

--------------------------------

### MIT License for share_plus_windows

Source: https://pub.dev/packages/share_plus_windows/license

The MIT License text for the share_plus_windows package, copyright 2020 The Flutter Community Plus Plugin Authors. It grants permission to use, copy, modify, merge, publish, distribute, sublicense, and sell copies of the software, subject to including the copyright notice and permission notice in all copies or substantial portions. The software is provided 'AS IS' without warranty of any kind.

```text
MIT License

Copyright (c) 2020 The Flutter Community Plus Plugin Authors

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

```

--------------------------------

### Updated SharePlus instance methods

Source: https://pub.dev/packages/share_plus

The new implementation using SharePlus.instance.share with ShareParams objects.

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

SharePlus.instance.share(
  ShareParams(text: "Shared text"),
);

SharePlus.instance.share(
  ShareParams(uri: "http://example.com"),
);

SharePlus.instance.share(
  ShareParams(files: files),
);
```

--------------------------------

### Share a single file

Source: https://pub.dev/packages/share_plus

Share a single file by providing the files list in ShareParams using XFile.

```dart
import 'package:share_plus/share_plus.dart';
import 'package:cross_file/cross_file.dart';

final params = ShareParams(
  text: 'Great picture',
  files: [XFile('${directory.path}/image.jpg')],
);

final result = await SharePlus.instance.share(params);

if (result.status == ShareResultStatus.success) {
    print('Thank you for sharing the picture!');
}
```

--------------------------------

### Configure email subject

Source: https://pub.dev/packages/share_plus

Set a subject for email sharing where supported.

```dart
ShareParams(
  // rest of params
  subject: 'Subject',
)
```

--------------------------------

### Share multiple files

Source: https://pub.dev/packages/share_plus

Share multiple files by including them in the files list within ShareParams.

```dart
import 'package:share_plus/share_plus.dart';
import 'package:cross_file/cross_file.dart';

final params = ShareParams(
  files: [
    XFile('${directory.path}/image1.jpg'),
    XFile('${directory.path}/image2.jpg'),
  ],
);

final result = await SharePlus.instance.share(params);

if (result.status == ShareResultStatus.dismissed) {
    print('Did you not like the pictures?');
}
```

--------------------------------

### Import share_plus_macos

Source: https://pub.dev/packages/share_plus_macos/install

Imports the share_plus_macos package in your Dart code to use its API.

```dart
import 'package:share_plus_macos/share_plus_macos.dart';
```

--------------------------------

### Add share_plus_macos dependency

Source: https://pub.dev/packages/share_plus_macos/install

Adds the share_plus_macos package to your Flutter project. Run this command in your project root.

```bash
 $ flutter pub add share_plus_macos
```

--------------------------------

### pubspec.yaml dependency entry

Source: https://pub.dev/packages/share_plus_macos/install

The resulting pubspec.yaml entry after running the add command. It specifies the version constraint ^3.0.1.

```yaml
dependencies:
  share_plus_macos: ^3.0.1
```

--------------------------------

### Deprecated Share static methods

Source: https://pub.dev/packages/share_plus

The original implementation using static methods from the share package.

```dart
import 'package:share/share.dart';

Share.share("Shared text");

Share.shareUri("http://example.com");

Share.shareXFiles(files);
```

--------------------------------

### Import share_plus_platform_interface in Dart

Source: https://pub.dev/packages/share_plus_platform_interface/install

Use this import statement in your Dart code to access the share_plus_platform_interface package.

```dart
import 'package:share_plus_platform_interface/share_plus_platform_interface.dart';
```

--------------------------------

### Share text content

Source: https://pub.dev/packages/share_plus

Use the share() method with ShareParams to share text content.

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

SharePlus.instance.share(
  ShareParams(text: 'check out my website https://example.com')
);
```

--------------------------------

### Share URI

Source: https://pub.dev/packages/share_plus

Share a URI. Note that metadata fetching from URIs is only supported on iOS.

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

final params = ShareParams(uri: uri);

SharePlus.instance.share(params);
```

--------------------------------

### Share dynamically generated data

Source: https://pub.dev/packages/share_plus

Share files generated from data using XFile.fromData and specify the filename with fileNameOverrides.

```dart
import 'package:share_plus/share_plus.dart';
import 'package:cross_file/cross_file.dart';
import 'dart:convert';

final params = ShareParams(
  files: [XFile.fromData(utf8.encode(text), mimeType: 'text/plain')],
  fileNameOverrides: ['myfile.txt']
);

SharePlus.instance.share(params);
```

--------------------------------

### pubspec.yaml dependency entry for share_plus

Source: https://pub.dev/packages/share_plus/install

This line is added to your package's pubspec.yaml after running the flutter pub add command. It specifies the version constraint ^13.3.0.

```yaml
dependencies:
  share_plus: ^13.3.0
```

--------------------------------

### Add dependency to pubspec.yaml

Source: https://pub.dev/packages/share_plus_platform_interface/install

This is the line that will be added to your package's pubspec.yaml after running the `flutter pub add` command.

```yaml
dependencies:
  share_plus_platform_interface: ^7.2.0
```

--------------------------------

### Import share_plus in Dart code

Source: https://pub.dev/packages/share_plus/install

Use this import statement in your Dart code to access the share_plus plugin's API.

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

--------------------------------

### Share button with disabled state

Source: https://pub.dev/packages/share_plus/example

Builds a 'Share' button that is disabled when both text and image paths are empty, and triggers `_onShareWithResult` with the current context when enabled.

```dart
Builder(
  builder: (BuildContext context) {
    return ElevatedButton(
      style: ElevatedButton.styleFrom(
        foregroundColor: Theme.of(context).colorScheme.onPrimary,
        backgroundColor: Theme.of(context).colorScheme.primary,
      ),
      onPressed: text.isEmpty && imagePaths.isEmpty
          ? null
          : () => _onShareWithResult(context),
      child: const Text('Share'),
    );
  },
),
```

--------------------------------

### Select excluded Cupertino activity type

Source: https://pub.dev/packages/share_plus/example

Navigates to `ExcludedCupertinoActivityTypePage` to select a Cupertino activity type to exclude, and updates the stored value if a result is returned.

```dart
void _onSelectExcludedActivityType() async {
  final result = await Navigator.of(context).push(
    MaterialPageRoute(
      builder: (context) => ExcludedCupertinoActivityTypePage(
        excludedActivityType: excludedCupertinoActivityType,
      ),
    ),
  );
  if (result != null) {
    excludedCupertinoActivityType = result;
  }
}
```

--------------------------------

### Handle share result status

Source: https://pub.dev/packages/share_plus

Check the ShareResultStatus returned by the share() method to verify if the user successfully shared the content.

```dart
final result = await SharePlus.instance.share(params);

if (result.status == ShareResultStatus.success) {
    print('Thank you for sharing my website!');
}
```

--------------------------------

### Disable web download fallback

Source: https://pub.dev/packages/share_plus

Disable the automatic file downloading fallback mechanism on web by setting downloadFallbackEnabled to false.

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

ShareParams(
  // rest of params
  downloadFallbackEnabled: false,
)
```
Tokens:
Raw