Flutter自定义画廊展示插件custom_gallery_display的使用

Flutter自定义画廊展示插件custom_gallery_display的使用

当您尝试添加一个从相册选择图片的包时，您会遇到糟糕的用户体验，因为您有一个传统的相册展示界面。为了改善这个问题，我提供了两种主要的相册视图：

  • 类似于Instagram的相册。
  • 相册图片的网格视图。

此外，您还可以自定义相机以从两个角度拍摄照片和视频。

必要说明

CustomGallery是一个您需要推送的页面。它包含一个Scaffold，不能作为具有另一个Scaffold的子组件添加。

安装

iOS

  • 相机插件可以编译为任何版本的iOS，但其功能需要iOS 10或更高版本。如果编译为iOS 9，请确保在使用任何相机插件功能之前，通过编程方式检查设备上运行的iOS版本。例如，您可以使用device_info_plus插件来检查iOS版本。

在ios/Runner/Info.plist文件中添加两行：

  • 一行键为Privacy - Camera Usage Description并附有使用描述。
  • 另一行键为Privacy - Microphone Usage Description并附有使用描述。

如果您正在以文本形式编辑Info.plist文件，则应添加以下内容：

<key>NSCameraUsageDescription</key>
<string>您的使用描述</string>
<key>NSMicrophoneUsageDescription</key>
<string>您的使用描述</string>

Android

  • 在您的android/app/build.gradle文件中将最小Android SDK版本更改为21（或更高），并将编译SDK更改为31（或更高）。
compileSdkVersion 33
minSdkVersion 21
  • 将以下权限添加到您的AndroidManifest.xml文件中：
<manifest>
    ...
    <application
    ...
    <activity
    ...
    android:requestLegacyExternalStorage="true"
    ...
</activity>
    ...
    </application>
<uses-permission android:name="android.permission.INTERNET"/>
    </manifest>

使用步骤

  1. 依赖

    在您的pubspec.yaml文件中添加依赖项：

    dependencies:
  custom_gallery_display: [last_version]

  2. 安装

    您可以从命令行安装包：

    使用pub：

    $ pub get custom_gallery_display

    使用Flutter：

    $ flutter pub add custom_gallery_display

  3. 导入

    在您的Dart代码中导入：

    import 'package:custom_gallery_display/custom_gallery_display.dart';

示例

示例1：正常显示

CustomGalleryDisplay.normalDisplay(
  multiSelection: true,
  galleryDisplaySettings: GalleryDisplaySettings(
    gridDelegate: const SliverGridDelegateWithFixedCrossAxisCount(
      crossAxisCount: 4,
      crossAxisSpacing: 1.7,
      mainAxisSpacing: 1.5,
    ),
    appTheme: AppTheme(
      focusColor: Colors.black,
      primaryColor: Colors.white,
    ),
  ),
  onDone: (SelectedImagesDetails details) async {
    bool multiSelectionMode = details.multiSelectionMode;
    List<SelectedByte> selectedFiles = details.selectedFiles;
    double aspectRatio = details.aspectRatio;
  },
);

示例2：Instagram风格显示

CustomGalleryDisplay.instagramDisplay(
  displaySource: DisplaySource.both,
  pickerSource: PickerSource.both,
  multiSelection: true,
  cropImage: true, // 默认为true
  galleryDisplaySettings: GalleryDisplaySettings(
    gridDelegate: const SliverGridDelegateWithFixedCrossAxisCount(
      crossAxisCount: 4,
      crossAxisSpacing: 1.7,
      mainAxisSpacing: 1.5,
    ),
  ),
  onDone: (SelectedImagesDetails details) async {
    bool multiSelectionMode = details.multiSelectionMode;
    List<SelectedByte> selectedFiles = details.selectedFiles;
    double aspectRatio = details.aspectRatio;
  },
);

示例3：带有阿拉伯文字的Instagram风格显示

CustomGalleryDisplay.instagramDisplay(
  displaySource: DisplaySource.both,
  pickerSource: PickerSource.both,
  multiSelection: true,
  cropImage: false,
  galleryDisplaySettings: GalleryDisplaySettings(
    appTheme: AppTheme(
      primaryColor: Colors.black,
      focusColor: Colors.white,
    ),
    tabsTexts: TabsTexts(
      videoText: "فيديو",
      photoText: "الصور",
      galleryText: "المعرض",
      deletingText: "حذف",
      clearImagesText: "الغاء الصور المحدده",
      limitingText: "اقصي حد للصور هو 10",
    ),
  ),
  onDone: (SelectedImagesDetails details) async {
    bool multiSelectionMode = details.multiSelectionMode;
    List<SelectedByte> selectedFiles = details.selectedFiles;
    double aspectRatio = details.aspectRatio;
  },
);

示例4：带有中文文字的Instagram风格显示

CustomGalleryDisplay.instagramDisplay(
  displaySource: DisplaySource.both,
  pickerSource: PickerSource.both,
  multiSelection: true,
  cropImage: false,
  galleryDisplaySettings: GalleryDisplaySettings(
    appTheme: AppTheme(
      primaryColor: Colors.black,
      focusColor: Colors.white,
    ),
    tabsTexts: TabsTexts(
      videoText: "視頻",
      photoText: "照片",
      galleryText: "畫廊",
      deletingText: "刪除",
      clearImagesText: "清除所選圖像",
      limitingText: "限制為 10 張照片或視頻",
    ),
  ),
  onDone: (SelectedImagesDetails details) async {
    bool multiSelectionMode = details.multiSelectionMode;
    List<SelectedByte> selectedFiles = details.selectedFiles;
    double aspectRatio = details.aspectRatio;
  },
);

完整示例代码

import 'dart:io';

import 'package:custom_gallery_display/custom_gallery_display.dart';
import 'package:flutter/cupertino.dart';
import 'package:flutter/material.dart';
import 'package:video_player/video_player.dart';

Future<void> main() async {
  WidgetsFlutterBinding.ensureInitialized();
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({Key? key}) : super(key: key);
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Custom gallery display',
      debugShowCheckedModeBanner: false,
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: const MyHomePage(),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({Key? key}) : super(key: key);
  [@override](/user/override)
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return Container(
      color: Colors.white,
      child: SafeArea(
        child: Column(
            crossAxisAlignment: CrossAxisAlignment.center,
            mainAxisAlignment: MainAxisAlignment.center,
            children: [
              normal1(context),
              normal2(context),
              normal3(context),
              instagram1(context),
              instagram2(context),
              instagram3(context),
              instagram4(context),
              camera1(context),
              camera2(context),
            ]),
      ),
    );
  }

  ElevatedButton normal1(BuildContext context) {
    return ElevatedButton(
      onPressed: () async {
        Navigator.of(context).push(CupertinoDialogRoute(
            builder: (context) => CustomGalleryDisplay.normalDisplay(
                multiSelection: true,
                galleryDisplaySettings: GalleryDisplaySettings(
                  gridDelegate: const SliverGridDelegateWithFixedCrossAxisCount(
                      crossAxisCount: 4,
                      crossAxisSpacing: 1.7,
                      mainAxisSpacing: 1.5),
                  appTheme: AppTheme(
                      focusColor: Colors.black, primaryColor: Colors.white),
                ),
                onDone: (SelectedImagesDetails details) async {
                  displayDetails(details);
                }),
            context: context));
      },
      child: const Text("Normal 1"),
    );
  }

  ElevatedButton normal2(BuildContext context) {
    return ElevatedButton(
      onPressed: () async {
        Navigator.of(context).push(CupertinoDialogRoute(
            builder: (context) => CustomGalleryDisplay.normalDisplay(
                displaySource: DisplaySource.both,
                pickerSource: PickerSource.image,
                multiSelection: true,
                onDone: (SelectedImagesDetails details) async {
                  displayDetails(details);
                }),
            context: context));
      },
      child: const Text("Normal 2"),
    );
  }

  ElevatedButton normal3(BuildContext context) {
    return ElevatedButton(
      onPressed: () async {
        Navigator.of(context).push(CupertinoDialogRoute(
            builder: (context) => CustomGalleryDisplay.normalDisplay(
                displaySource: DisplaySource.both,
                pickerSource: PickerSource.both,
                galleryDisplaySettings: GalleryDisplaySettings(
                    appTheme: AppTheme(
                        focusColor: Colors.black, primaryColor: Colors.white),
                    tabsTexts: _arabicTabsTexts(),
                    gridDelegate: _sliverGrid3Delegate()),
                multiSelection: true,
                onDone: (SelectedImagesDetails details) async {
                  displayDetails(details);
                }),
            context: context));
      },
      child: const Text("Normal 3"),
    );
  }

  ElevatedButton instagram1(BuildContext context) {
    return ElevatedButton(
      onPressed: () async {
        Navigator.of(context).push(CupertinoDialogRoute(
            builder: (context) => CustomGalleryDisplay.instagramDisplay(
                displaySource: DisplaySource.gallery,
                pickerSource: PickerSource.image,
                multiSelection: true,
                onDone: (SelectedImagesDetails details) async {
                  displayDetails(details);
                }),
            context: context));
      },
      child: const Text("Preview 1"),
    );
  }

  ElevatedButton instagram2(BuildContext context) {
    return ElevatedButton(
      onPressed: () async {
        Navigator.of(context).push(CupertinoDialogRoute(
            builder: (context) => CustomGalleryDisplay.instagramDisplay(
                displaySource: DisplaySource.both,
                pickerSource: PickerSource.image,
                multiSelection: true,
                cropImage: false,
                onDone: (SelectedImagesDetails details) async {
                  displayDetails(details);
                }),
            context: context));
      },
      child: const Text("Preview 2"),
    );
  }

  SliverGridDelegateWithFixedCrossAxisCount _sliverGrid3Delegate() {
    return const SliverGridDelegateWithFixedCrossAxisCount(
      crossAxisCount: 3,
      crossAxisSpacing: 1.7,
      mainAxisSpacing: 1.5,
      childAspectRatio: .5,
    );
  }

  TabsTexts _arabicTabsTexts() {
    return TabsTexts(
      videoText: "فيديو",
      galleryText: "المعرض",
      deletingText: "حذف",
      noImagesFounded: "لم يتم العثور علي صور",
      acceptAllPermissions: "أقبل جميع الاذونات",
      holdButtonText: "استمر بالضغط علي الزر",
      photoText: "الصور",
      clearImagesText: "الغاء الصور المحدده",
      limitingText: "اقصي حد للصور هو 10",
    );
  }

  TabsTexts _chineseTabsTexts() {
    return TabsTexts(
      videoText: "視頻",
      photoText: "照片",
      galleryText: "畫廊",
      deletingText: "刪除",
      clearImagesText: "清除所選圖像",
      limitingText: "限制為 10 張照片或視頻",
    );
  }

  ElevatedButton instagram3(BuildContext context) {
    return ElevatedButton(
      onPressed: () async {
        Navigator.of(context).push(CupertinoDialogRoute(
            builder: (context) => CustomGalleryDisplay.instagramDisplay(
                displaySource: DisplaySource.both,
                pickerSource: PickerSource.both,
                multiSelection: true,
                onDone: (SelectedImagesDetails details) async {
                  displayDetails(details);
                }),
            context: context));
      },
      child: const Text("Preview 3"),
    );
  }

  ElevatedButton instagram4(BuildContext context) {
    return ElevatedButton(
      onPressed: () async {
        Navigator.of(context).push(CupertinoDialogRoute(
            builder: (context) => CustomGalleryDisplay.instagramDisplay(
                displaySource: DisplaySource.both,
                pickerSource: PickerSource.both,
                multiSelection: true,
                cropImage: false,
                galleryDisplaySettings: GalleryDisplaySettings(
                    appTheme: AppTheme(
                        primaryColor: Colors.black, focusColor: Colors.white),
                    tabsTexts: _chineseTabsTexts()),
                onDone: (SelectedImagesDetails details) async {
                  displayDetails(details);
                }),
            context: context));
      },
      child: const Text("Preview 4"),
    );
  }

  ElevatedButton camera1(BuildContext context) {
    return ElevatedButton(
      onPressed: () async {
        Navigator.of(context).push(CupertinoDialogRoute(
            builder: (context) => CustomGalleryDisplay.normalDisplay(
                displaySource: DisplaySource.camera,
                pickerSource: PickerSource.image,
                onDone: (SelectedImagesDetails details) async {
                  displayDetails(details);
                }),
            context: context));
      },
      child: const Text("Camera 1"),
    );
  }

  ElevatedButton camera2(BuildContext context) {
    return ElevatedButton(
      onPressed: () async {
        Navigator.of(context).push(CupertinoDialogRoute(
            builder: (context) => CustomGalleryDisplay.normalDisplay(
                displaySource: DisplaySource.camera,
                pickerSource: PickerSource.both,
                multiSelection: true,
                onDone: (SelectedImagesDetails details) async {
                  displayDetails(details);
                }),
            context: context));
      },
      child: const Text("camera 2"),
    );
  }

  Future<void> displayDetails(SelectedImagesDetails details) async {
    await Navigator.of(context).push(
      CupertinoPageRoute(
        builder: (context) {
          return DisplayImages(
              selectedBytes: details.selectedFiles,
              details: details,
              aspectRatio: details.aspectRatio);
        },
      ),
    );
  }
}

class DisplayImages extends StatefulWidget {
  final List<SelectedByte> selectedBytes;
  final double aspectRatio;
  final SelectedImagesDetails details;
  const DisplayImages({
    Key? key,
    required this.details,
    required this.selectedBytes,
    required this.aspectRatio,
  }) : super(key: key);

  [@override](/user/override)
  State<DisplayImages> createState() => _DisplayImagesState();
}

class _DisplayImagesState extends State<DisplayImages> {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: const Text('Selected images/videos')),
      body: ListView.builder(
        itemBuilder: (context, index) {
          SelectedByte selectedByte = widget.selectedBytes[index];
          if (!selectedByte.isThatImage) {
            return _DisplayVideo(selectedByte: selectedByte);
          } else {
            return SizedBox(
              width: double.infinity,
              child: Image.file(selectedByte.selectedFile),
            );
          }
        },
        itemCount: widget.selectedBytes.length,
      ),
    );
  }
}

class _DisplayVideo extends StatefulWidget {
  final SelectedByte selectedByte;
  const _DisplayVideo({Key? key, required this.selectedByte}) : super(key: key);

  [@override](/user/override)
  State<_DisplayVideo> createState() => _DisplayVideoState();
}

class _DisplayVideoState extends State<_DisplayVideo> {
  late VideoPlayerController controller;
  late Future<void> initializeVideoPlayerFuture;

  [@override](/user/override)
  void initState() {
    super.initState();
    File file = widget.selectedByte.selectedFile;
    controller = VideoPlayerController.file(file);
    initializeVideoPlayerFuture = controller.initialize();
    controller.setLooping(true);
  }

  [@override](/user/override)
  void dispose() {
    controller.dispose();
    super.dispose();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return FutureBuilder(
      future: initializeVideoPlayerFuture,
      builder: (context, snapshot) {
        if (snapshot.connectionState == ConnectionState.done) {
          return Stack(
            alignment: Alignment.center,
            children: [
              AspectRatio(
                aspectRatio: controller.value.aspectRatio,
                child: VideoPlayer(controller),
              ),
              Align(
                alignment: Alignment.center,
                child: GestureDetector(
                  onTap: () {
                    setState(() {
                      if (controller.value.isPlaying) {
                        controller.pause();
                      } else {
                        controller.play();
                      }
                    });
                  },
                  child: Icon(
                    controller.value.isPlaying ? Icons.pause : Icons.play_arrow,
                    color: Colors.white,
                    size: 45,
                  ),
                ),
              )
            ],
          );
        } else {
          return const Center(
            child: CircularProgressIndicator(strokeWidth: 1),
          );
        }
      },
    );
  }
}

更多关于Flutter自定义画廊展示插件custom_gallery_display的使用的实战教程也可以访问 https://www.itying.com/category-92-b0.html

1 回复

更多关于Flutter自定义画廊展示插件custom_gallery_display的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html


custom_gallery_display 是一个用于在 Flutter 应用中展示图片画廊的自定义插件。该插件允许开发者以灵活的方式展示图片，支持自定义布局、过渡动画、手势操作等功能。以下是如何使用 custom_gallery_display 插件的基本步骤和示例代码。

1. 添加依赖

首先，你需要在 pubspec.yaml 文件中添加 custom_gallery_display 插件的依赖。

dependencies:
  flutter:
    sdk: flutter
  custom_gallery_display: ^1.0.0  # 请确保使用最新版本

然后运行 flutter pub get 来获取依赖。

2. 导入插件

在你的 Dart 文件中导入 custom_gallery_display 插件。

import 'package:custom_gallery_display/custom_gallery_display.dart';

3. 使用 CustomGalleryDisplay

CustomGalleryDisplay 是插件的主要组件，用于展示图片画廊。你可以通过传递一个图片列表来初始化它。

class GalleryScreen extends StatelessWidget {
  final List<String> imageUrls = [
    'https://example.com/image1.jpg',
    'https://example.com/image2.jpg',
    'https://example.com/image3.jpg',
  ];

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Custom Gallery Display'),
      ),
      body: CustomGalleryDisplay(
        imageUrls: imageUrls,
        initialIndex: 0, // 初始显示的图片索引
        onPageChanged: (index) {
          print('当前显示的图片索引: $index');
        },
      ),
    );
  }
}

4. 自定义选项

CustomGalleryDisplay 提供了多个可选参数，允许你自定义画廊的外观和行为。

  • initialIndex: 初始显示的图片索引。
  • onPageChanged: 当用户滑动到不同图片时触发的回调。
  • backgroundDecoration: 设置画廊的背景装饰。
  • indicatorColor: 设置图片指示器的颜色。
  • indicatorBackgroundColor: 设置指示器背景的颜色。
  • showIndicator: 是否显示图片指示器。
  • enableSwipe: 是否启用滑动手势。

5. 示例代码

以下是一个完整的示例，展示了如何使用 CustomGalleryDisplay 插件来创建一个图片画廊。

import 'package:flutter/material.dart';
import 'package:custom_gallery_display/custom_gallery_display.dart';

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

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Custom Gallery Display Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: GalleryScreen(),
    );
  }
}

class GalleryScreen extends StatelessWidget {
  final List<String> imageUrls = [
    'https://via.placeholder.com/150',
    'https://via.placeholder.com/300',
    'https://via.placeholder.com/450',
  ];

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Custom Gallery Display'),
      ),
      body: CustomGalleryDisplay(
        imageUrls: imageUrls,
        initialIndex: 0,
        onPageChanged: (index) {
          print('当前显示的图片索引: $index');
        },
        backgroundDecoration: BoxDecoration(
          color: Colors.black,
        ),
        indicatorColor: Colors.white,
        indicatorBackgroundColor: Colors.black54,
        showIndicator: true,
        enableSwipe: true,
      ),
    );
  }
}
回到顶部