storage_manager 0.4.1

storage_manager: ^0.4.1 copied to clipboard

Features #

Storage Manager for online (FireStorage) and offline (Shared Preferences) purposes

Getting started #

Add this import line

import 'package:storage_manager/storage_manager.dart';  

Usage #

This package can save and get images, videos, text (plain or json) and data (bytes) to device local storage (shared_preferences) or Firebase Cloud Storage (firebase_storage) using the latest dependencies

Get methods #

Get a file (image, string, json or bytes) from given a path

  final file = await StorageProvider.get('collectionName/Image.png');  

Get an image from given a path

  Uint8List? image = await StorageProvider.getImage('collectionName/Image.png');  

Get a video from given a path

  Uint8List? video = await StorageProvider.getVideo('collectionName/Video.mp4');  

Get a string from given a path

  String? text = await StorageProvider.getText('collectionName/text.txt');  

To get an image from local storage use:

  final file = await StorageProvider.getLocalImage('collectionName/Image.png');  

To get a video from local storage use:

  final file = await StorageProvider.getLocalVideo('collectionName/Video.mp4');  

To get a string from local storage use:

  final file = await StorageProvider.getLocalText('collectionName/text.txt');  

To get a JSON from local storage use:

  final file = await StorageProvider.getLocalJson('collectionName/json.json');  

Remove methods #

Remove files from storage or local path

  bool success = await StorageProvider.remove('collectionName/Image.png');  

or from storage URL

  bool success = await StorageProvider.removeUrl('url');  

Upload methods #

• Only the save method can save to local storage using the [toLocalStorage] parameter with a dynamic [value]
• The [value] parameter can be a [String], [Uint8List], [File], [JSON] or [XFile] (image_picker)
• The [fileName] parameter is the name of the file to be saved

  StorageProvider.save('/images/image.png', value, toLocalStorage: true);  

Upload a dynamic file (image, video, string, json or bytes) to given a path

  String url = await StorageProvider.save('collectionName/Image.png', image);  

Upload an image to given a path

  String url = await StorageProvider.saveImage('collectionName/Image.png', image);  

Upload a video to given a path

  String url = await StorageProvider.saveVideo('collectionName/Video.mp4', video);  

Upload a JSON to given a path

  String url = await StorageProvider.saveBytes('collectionName/json.json', json);  

You can also save and Image directly to local storage using:

    StorageProvider.saveLocalImage('/images/[fileName]', image);  

or a Video directly to local storage using:

    StorageProvider.saveLocalVideo('/videos/[fileName]', video);  

or a String directly to local storage using:

    StorageProvider.saveLocalText('/texts/[fileName]', text);  

or a JSON directly to local storage using:

    StorageProvider.saveLocalJson('/jsons/[fileName]', json);  

Integrated image picker feature #

Select images from gallery or camera

   if(await StorageProvider.selectImages()){
        List<XFile> images =  StorageProvider.selectedAssets;
   }else{
        print('User cancelled selection');
   }

Upload selected images to given path

    /// You can use the selectedAssets from the previous step or select new ones with image_picker
    List<XFile> images = StorageProvider.selectedAssets;
    List<String> urls = await StorageProvider.save('collectionName', images);  

Select images from gallery and upload them

  String url = await StorageProvider.selectAndUpload();  

Customizations #

You can customize the image picker getSource function

  StorageProvider.configure(
  context: context,
  showProgress: true,
  getImageSource: () async => await showDialog<ImageSource>(
  context: context,
  builder: (context) => SimpleDialog(
    title: const Text("Select image source"),
    children: [
      ListTile(
        title: const Text("Camera"),
        leading: const Icon(Icons.camera_alt),
        onTap: () => Navigator.pop(context, ImageSource.camera),
      ),
      ListTile(
        title: const Text("Gallery"),
        leading: const Icon(Icons.photo),
        onTap: () => Navigator.pop(context, ImageSource.gallery),
      ),
    ],
  ),
  showDataUploadProgress: (uploadTask) async {
    return await showDialog(
      context: context,
      barrierDismissible: true,
      builder: (context) {
        return StreamBuilder<TaskSnapshot>(
          stream: uploadTask.snapshotEvents,
          builder: (context, snapshot) {
            if (snapshot.hasData) {
              return AlertDialog(
                title: const Text('Uploading...'),
                content: ProgressFromUploadTask(
                  task: uploadTask,
                  onDone: () {
                    Navigator.pop(context);
                  },
                ),
              );
            } else {
              return const AlertDialog(
                title: Text('Waiting...'),
                content: LinearProgressIndicator(),
              );
            }
          },
        );
      },
    );
  },
);

Rendering images from storage #

• Flutter web requires an additional script to be added to the index.html file if you want to use Image.network() Include this script in the bottom of your body inside the index.html:

<script type="text/javascript">
    window.flutterWebRenderer = "html";
</script>

Additional information #

This package assumes complete Firebase configuration with Storage and permissions. We recommend flutterfire to configure your project. For more information visit: https://firebase.flutter.dev/docs/overview/

    dart pub global activate flutterfire_cli
    flutterfire configure