Flutter WeChat Camera Picker

March 6, 2026 · View on GitHub

pub package pub package CodeFactor

Build status GitHub license GitHub stars GitHub forks

Language: English | 中文

A camera picker for Flutter projects based on WeChat's UI, which is also a separate runnable extension to the wechat_assets_picker.

The current WeChat version that UI is based on: 8.0.49. UI designs will be updated at any time following the WeChat update.

See the Migration Guide to learn how to migrate between breaking changes.

Versions compatibility

The package only guarantees that it will work on the stable version of Flutter. We won't update it in real-time to align with other channels of Flutter.

3.3.03.16.03.22.0
4.4.0+
4.2.0+
4.0.0+

Package credits

The package is built from these wonderful packages.

NameFeatures
photo_managerThe basic abstractions and management for assets.
cameraCaptures images and videos.
video_playerPlays videos and audios correspondingly.

Their implementation should be relatively stable in the package. If you've found any issues related to them when using the picker, submit issues to our issue tracker first.

Table of content

Features ✨

  • ♿ Complete a11y support with TalkBack and VoiceOver
  • ♻️ Fully implementable with States override
  • 🎏 Fully customizable theme based on ThemeData
  • 💚 Completely WeChat style (even more)
  • ⚡️ Adjustable performance with different configurations
  • 📷 Picture capturing support
  • 🎥 Video recording support
    • ⏱ Duration limitation support
    • 🔍 Scale when recording support
  • ☀️ Exposure adjust support
  • 🔍️ Scale with pinch support
  • 💱 i18n support
    • ⏪ RTL language support
  • 🖾 Foreground custom widget builder support
  • 🕹️ Intercept saving with a custom process

Screenshots 📸

12345

READ THIS FIRST ‼️

Be aware of the below notices before you start anything:

  • Due to understanding the differences and limitations of a single document, documents will not cover all the contents. If you find nothing related to your expected features and cannot understand about concepts, run the example project and check every option first. It has covered 90% of regular requests with the package.
  • The package deeply integrates with the photo_manager plugin, make sure you understand these two concepts as much as possible:

When you have questions about related APIs and behaviors, check photo_manager's API docs for more details.

Most usages are detailed and covered by the example. Please walk through the example carefully before you have any questions.

Preparing for use 🍭

If you got a resolve conflict error when running flutter pub get, please use dependency_overrides to fix it.

Setup

Run flutter pub add wechat_camera_picker, or add wechat_camera_picker to pubspec.yaml dependencies manually.

dependencies:
  wechat_camera_picker: ^latest_version

The latest stable version is: pub package

The latest dev version is: pub package

Follow these detailed setup guide before runs:

Notes 📝

  1. When using NSPhotoLibraryAddUsageDescription on iOS, it requires using onEntitySaving or onXFileCaptured to handle the captured file, an AssetEntity is not available in this circumstance, obtaining that asset with its ID will lead to a crash.

Then import the package in your code:

import 'package:wechat_camera_picker/wechat_camera_picker.dart';

Usage 📖

Localizations

When you're picking assets, the package will obtain the Locale? from your BuildContext, and return the corresponding text delegate of the current language. Make sure you have a valid Locale in your widget tree that can be accessed from the BuildContext. Otherwise, the default Chinese delegate will be used.

Embedded text delegates languages are:

  • 简体中文 (default)
  • English
  • Tiếng Việt

If you want to use a custom/fixed text delegate, pass it through the CameraPickerConfig.textDelegate.

Simple usage

final AssetEntity? entity = await CameraPicker.pickFromCamera(context);

With configurations

Use CameraPickerConfig for more picking behaviors.

final AssetEntity? entity = await CameraPicker.pickFromCamera(
  context,
  pickerConfig: const CameraPickerConfig(),
);

Fields in CameraPickerConfig:

NameTypeDescriptionDefault Value
enableRecordingboolWhether the picker can record video.false
onlyEnableRecordingboolWhether the picker can only record video. Only available when enableRecording is true .false
enableTapRecordingboolWhether allow the record can start with single tap. Only available when enableRecording is true .false
enableAudioboolWhether Whether the picker should record audio. Only available with recording.true
enableSetExposureboolWhether users can set the exposure point by tapping.true
enableExposureControlOnPointboolWhether users can adjust exposure according to the set point.true
enablePinchToZoomboolWhether users can zoom the camera by pinch.true
enablePullToZoomInRecordboolWhether users can zoom by pulling up when recording video.true
enableScaledPreviewboolWhether the camera preview should be scaled during captures.false
shouldDeletePreviewFileboolWhether the preview file will be delete when pop.false
shouldAutoPreviewVideoboolWhether the video should be played instantly in the preview.true
maximumRecordingDurationDuration?The maximum duration of the video recording process.const Duration(seconds: 15)
minimumRecordingDurationDurationThe minimum duration of the video recording process.const Duration(seconds: 1)
themeThemeData?Theme data for the picker.CameraPicker.themeData(wechatThemeColor)
textDelegateCameraPickerTextDelegate?Text delegate that controls text in widgets.CameraPickerTextDelegate
resolutionPresetResolutionPresetPresent resolution for the camera.ResolutionPreset.ultraHigh
cameraQuarterTurnsintThe number of clockwise quarter turns the camera view should be rotated.0
imageFormatGroupImageFormatGroupDescribes the output of the raw image format.ImageFormatGroup.unknown
preferredLensDirectionCameraLensDirectionWhich lens direction is preferred when first using the camera.CameraLensDirection.back
lockCaptureOrientationDeviceOrientation?Whether the camera should be locked to the specific orientation during captures.null
foregroundBuilderForegroundBuilder?The foreground widget builder which will cover the whole camera preview.null
previewTransformBuilderPreviewTransformBuilder?The widget builder which will transform the camera preview.null
onEntitySavingEntitySaveCallback?The callback type define for saving entity in the viewer.null
onErrorCameraErrorHandler?The error handler when any error occurred during the picking process.null
onXFileCapturedXFileCapturedCallback?The callback type definition when the XFile is captured by the camera.null
onMinimumRecordDurationNotMetVoidCallback?The callback when the recording is not met the minimum recording duration.null
onPickConfirmedvoid Function(AssetEntity)?The callback when picture is taken or video is confirmed.null
permissionRequestOptionPermissionRequestOption?The permission request option when saving the captured file using the photo_manager package.null

Using custom States

All user interfaces can be customized through custom States, including:

  • CameraPickerState
  • CameraPickerViewerState

After overriding States, pass them through the picking method, more specifically:

  • CameraPicker.pickFromCamera(createPickerState: () => CustomCameraPickerState());
  • CameraPickerViewer.pushToViewer(..., createViewerState: () => CustomCameraPickerViewerState());

Frequently asked question 💭

Why the orientation behavior is strange on iOS?

Currently, the preview is not correctly synced on the iOS. You can find more details in this issue: https://github.com/flutter/flutter/issues/89216 . Other than that, please submit issues to describe your question.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Alex Li
Alex Li

💻 🎨 📖 💡 🤔 🚧 💬 👀
Caijinglong
Caijinglong

💡 🤔
Lael
Lael

📖
mjl0602
mjl0602

💻 🤔
AliasWang
AliasWang

💻 🤔
leftcoding
leftcoding

🐛
Luong The Vinh
Luong The Vinh

💻
luomo-pro
luomo-pro

️️️️♿️ 🐛
LeonardoZhu
LeonardoZhu

💻
Nguyen Phuc Loi
Nguyen Phuc Loi

🌍
Amos
Amos

🐛
Tee Yu June
Tee Yu June

💻

This project follows the all-contributors specification. Contributions of any kind are welcome!