1# @ohos.file.AlbumPickerComponent (Album Picker组件)
2
3应用可以在布局中嵌入AlbumPickerComponent组件,通过此组件,应用无需申请权限,即可访问公共目录中的相册列表。
4
5需配合[PhotoPickerComponent](ohos-file-PhotoPickerComponent.md)一起使用,用户通过AlbumPickerComponent组件选择对应相册并通知PhotoPickerComponent组件刷新成对应相册的图片和视频。
6
7> **说明:**
8>
9> 该组件从API version 12开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
10
11## 导入模块
12
13```ts
14import { AlbumPickerComponent, AlbumPickerOptions, AlbumInfo, photoAccessHelper } from '@kit.MediaLibraryKit';
15import { EmptyAreaClickCallback } from '@ohos.file.AlbumPickerComponent';
16```
17
18## 属性
19
20支持[通用属性](../apis-arkui/arkui-ts/ts-universal-attributes-size.md)。
21
22## AlbumPickerComponent
23
24AlbumPickerComponent({
25  albumPickerOptions?: AlbumPickerOptions,
26  onAlbumClick?: (albumInfo: AlbumInfo) => boolean,
27  onEmptyAreaClick?: EmptyAreaClickCallback
28})
29
30应用可以在布局中嵌入AlbumPickerComponent组件,通过此组件,应用无需申请权限,即可访问公共目录中的的相册列表。
31
32**装饰器类型**:@Component
33
34**原子化服务API**:从API version 12开始,该接口支持在原子化服务中使用。
35
36**系统能力**:SystemCapability.FileManagement.PhotoAccessHelper.Core
37
38**参数:**
39
40| 名称                 | 类型                                                  | 必填  | 说明                              |
41|--------------------|-----------------------------------------------------|-----|---------------------------------|
42| albumPickerOptions | [AlbumPickerOptions](#albumpickeroptions)           | 否   | AlbumPicker的配置信息。               |
43| onAlbumClick       | (albumInfo: [AlbumInfo](#albuminfo)) => boolean     | 否   | 用户选择某个相册时产生的回调事件,将相册uri给到应用。    |
44| onEmptyAreaClick<sup>13+</sup>   | [EmptyAreaClickCallback](#emptyareaclickcallback13) | 否   | 点击相册组件空白区域时产生的回调事件,将该次点击通知给应用。 |
45
46## AlbumPickerOptions
47
48Album Picker配置选项。
49
50**原子化服务API**:从API version 12开始,该接口支持在原子化服务中使用。
51
52**系统能力**:SystemCapability.FileManagement.PhotoAccessHelper.Core
53
54| 名称             | 类型  | 必填  | 说明                                                          |
55|----------------|-------|-----|-------------------------------------------------------------|
56| themeColorMode | [PickerColorMode](ohos-file-PhotoPickerComponent.md#pickercolormode) | 否   | 相册页主题颜色,包括跟随系统、浅色模式以及深色模式,默认为跟随系统。                          |
57| filterType<sup>13+</sup>     | [photoAccessHelper.PhotoViewMIMETypes](js-apis-photoAccessHelper.md#photoviewmimetypes) | 否   | 相册组件过滤参数,可筛选只显示图片、视频或者图片和视频。若未配置此参数,则某个具体相册中显示图片和视频类型的所有资源。 |
58
59## EmptyAreaClickCallback<sup>13+</sup>
60
61type EmptyAreaClickCallback = () => void
62
63点击相册组件空白区域时产生的回调事件。
64
65**原子化服务API:** 从API version 13开始,该接口支持在原子化服务中使用。
66
67**系统能力**:SystemCapability.FileManagement.PhotoAccessHelper.Core
68
69## AlbumInfo
70
71相册相关信息。
72
73**原子化服务API**:从API version 12开始,该接口支持在原子化服务中使用。
74
75**系统能力**:SystemCapability.FileManagement.PhotoAccessHelper.Core
76
77| 名称  | 类型  | 必填  | 说明    |
78|------|------|-----|---------|
79| uri  | string | 否   | 相册的uri。 |
80| albumName  | string | 否   | 相册的名称。 |
81
82## 示例
83
84```ts
85// xxx.ets
86import { AlbumPickerComponent, AlbumPickerOptions, AlbumInfo, PickerColorMode, photoAccessHelper } from '@kit.MediaLibraryKit';
87import { EmptyAreaClickCallback } from '@ohos.file.AlbumPickerComponent';
88
89@Entry
90@Component
91struct PickerDemo {
92  albumPickerOptions: AlbumPickerOptions = new AlbumPickerOptions();
93  private emptyAreaClickCallback: EmptyAreaClickCallback = (): void => this.onEmptyAreaClick();
94
95  aboutToAppear() {
96    this.albumPickerOptions.themeColorMode = PickerColorMode.AUTO;
97    this.albumPickerOptions.filterType = photoAccessHelper.PhotoViewMIMETypes.IMAGE_VIDEO_TYPE;
98  }
99  
100  private onAlbumClick(albumInfo: AlbumInfo): boolean {
101    if (albumInfo?.uri) {
102      // 通过pickerController向PhotoPickerComponent发送消息,通知其刷新
103    }
104    if (albumInfo?.albumName) {
105      // 基于获取到的albumName后续逻辑处理
106    }
107    return true;
108  }
109  
110  private onEmptyAreaClick(): void {
111    // 点击组件空白区域回调
112  }
113
114  build() {
115    Stack() {
116      AlbumPickerComponent({
117        albumPickerOptions: this.albumPickerOptions,
118        onAlbumClick:(albumInfo: AlbumInfo): boolean => this.onAlbumClick(albumInfo),
119        onEmptyAreaClick(): this.emptyAreaClickCallback,
120      }).height('100%').width('100%')
121    }
122  }
123}
124