Configuration
selectModeโ
Mode of selection in the picker.
- Type: string
- Default:
multiple - Required: No
- Options:
single: Single selection modemultiple: Multiple selection mode
selectedAssetsโ
Keep previous selection in Multiple Image Picker
See Result
- Type: Result[]
- Default:
[] - Required: No
allowedLimitโ
Display additional select more media when permission on iOS is limited.
- Type: boolean
- Default:
true - Required: No
- Platform: iOS
allowSwipeToSelectโ
Allow swiping to select items.
- Type: boolean
- Default:
true - Required: No
- Platform: iOS, Android
isHiddenOriginalButtonโ
Hide the original button.
- Type: boolean
- Default:
false - Required: No
- Platform: iOS, Android
maxSelectโ
Maximum number of items that can be selected.
- Type: number
- Default:
20 - Required: No
- Platform: iOS, Android
maxVideoโ
Maximum number of videos allowed.
- Type: number
- Default:
20 - Required: No
- Platform: iOS, Android
Camera ๐ธโ
Configuration camera functionality.
- Type: object
- Default:
{} - Required: No
- Platform: iOS, Android
cameraDeviceโ
Camera device to be used.
- Type:
string - Default:
back - Required: No
- Platform: iOS
- Options:
back: Back camerafront: Front camera
videoMaximumDurationโ
Maximum video duration in seconds.
- Type: number
- Default: 60
- Required: No
- Platform: iOS, Android
Crop ๐ชโ
Configuration for image cropping functionality.
- Type: object
- Default:
undefined - Required: No
- Platform: iOS, Android
circleโ
Enable circular crop mask.
- Type: boolean
- Default:
false - Required: No
- Platform: iOS, Android
ratioโ
Aspect ratios for cropping. Android: Maximum: 4 items
- Type:
array - Default:
undefined - Required: No
- Platform: iOS, Android
- Properties:
title: string - Display title for the ratio (e.g., "Square", "16:9")width: number - Width value for the aspect ratioheight: number - Height value for the aspect ratio
defaultRatioโ
Default ratio to be selected when opening the crop interface.
- Type:
object - Default:
undefined - Required: No
- Platform: iOS, Android
- Properties:
title: string - Display title for the ratio (e.g., "Square", "16:9")width: number - Width value for the aspect ratioheight: number - Height value for the aspect ratio
freeStyleโ
Enable free style cropping.
- Type:
boolean - Default:
false - Required: No
- Platform: iOS, Android
UI Customize ๐โ
themeโ
Theme mode for the picker.
- Type: string
- Default:
system - Required: No
- Platform: iOS, Android
- Options:
light: Light themedark: Dark themesystem: System default theme
primaryColorโ
Primary color for the picker UI elements.
- Type: ColorValue
- Default: ๐ฆ
#2979ff - Required: No
- Platform: iOS, Android
backgroundDarkโ
Background color for dark mode UI elements.
- Type: ColorValue
- Default: โซ๏ธ
#1A1A1A - Required: No
- Platform: iOS, Android
selectBoxStyleโ
Style of selection box in the picker.
- Type: string
- Default:
number - Required: No
- Options:
number: Show numbers in selection boxtick: Show checkmark in selection box
spacingโ
Spacing between items in the grid.
- Type: number
- Default:
2 - Required: No
- Platform: iOS, Android
numberOfColumnโ
Number of columns in the grid view.
- Type: number
- Default:
4 - Required: No
- Platform: iOS, Android
presentationโ
Modal presentation style for the picker.
- Type: string
- Default:
fullScreenModal - Required: No
- Platform: iOS
- Options:
fullScreenModal: Full screen presentationformSheet: Form sheet presentation
Filter data ๐๏ธโ
mediaTypeโ
Type of media to be displayed in the picker.
- Type: string
- Default:
all - Required: No
- Options:
video: Only show videosimage: Only show imagesall: Show both videos and images
maxVideoDurationโ
Maximum duration for videos in seconds.
- Type: number
- Default:
undefined - Required: No
- Platform: iOS, Android
minVideoDurationโ
Minimum duration for videos in seconds.
- Type: number
- Default:
undefined - Required: No
- Platform: iOS, Android
maxFileSizeโ
Maximum file size in bytes.
- Type: number
- Default:
undefined - Required: No
- Platform: iOS, Android
Preview ๐ โ
isPreviewโ
Enable preview functionality.
- Type: boolean
- Default:
true - Required: No
- Platform: iOS, Android
isShowPreviewListโ
Show preview list.
- Type: boolean
- Default:
false - Required: No
- Platform: iOS
isHiddenPreviewButtonโ
Hide the preview button and button mode.
- Type: boolean
- Default:
false - Required: No
- Platform: iOS, Android
allowHapticTouchPreviewโ
Enable haptic feedback on preview.
- Type: boolean
- Default:
false - Required: No
- Platform: iOS
Localization ๐โ
textโ
Custom text labels for buttons and headers.
- Type: object
- Default:
undefined - Required: No
- Platform: iOS, Android
- Properties:
finish: string - Text for finish/done buttonoriginal: string - Text for original buttonpreview: string - Text for preview buttonedit: string - Text for edit button
languageโ
Interface language for the picker.
-
Type: string
-
Default:
system -
Required: No
-
Options:
system: ๐ System defaultzh-Hans: ๐จ๐ณ Simplified Chinesezh-Hant: ๐น๐ผ Traditional Chineseja: ๐ฏ๐ต Japaneseko: ๐ฐ๐ท Koreanen: ๐ฌ๐ง Englishvi: ๐ป๐ณ Vietnameseru: ๐ท๐บ Russiande: ๐ฉ๐ช Germanfr: ๐ซ๐ท Frenchar: ๐ธ๐ฆ Arabic
iOS Only:
id: ๐ฎ๐ฉ Indonesianth: ๐น๐ญ Thai