Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/ko1o/PYPhotoBrowser

An easy way to browse photo(image) for iOS.
https://github.com/ko1o/PYPhotoBrowser
Last synced: 3 months ago
JSON representation
An easy way to browse photo(image) for iOS.
Host: GitHub
URL: https://github.com/ko1o/PYPhotoBrowser
Owner: ko1o
License: mit
Created: 2016-06-02T11:16:57.000Z (over 8 years ago)
Default Branch: master
Last Pushed: 2020-01-03T11:47:53.000Z (almost 5 years ago)
Last Synced: 2024-05-17T22:00:46.728Z (6 months ago)
Language: Objective-C
Homepage:
Size: 13.1 MB
Stars: 2,016
Watchers: 77
Forks: 417
Open Issues: 155
Metadata Files:
- Readme: README.md
Awesome Lists containing this project

Awesome-iOS - PYPhotoBrowser - An easy way to browse photo(image) for iOS. (UI Components)
README

        # PYPhotoBrowser

[![Build Status](https://travis-ci.org/iphone5solo/PYPhotoBrowser.svg?branch=master)](https://travis-ci.org/iphone5solo/PYPhotoBrowser)

[![Pod Version](http://img.shields.io/cocoapods/v/PYPhotoBrowser.svg?style=flat)](http://cocoadocs.org/docsets/PYPhotoBrowser/)

[![Pod Platform](http://img.shields.io/cocoapods/p/PYPhotoBrowser.svg?style=flat)](http://cocoadocs.org/docsets/PYPhotoBrowser/)

[![Pod License](http://img.shields.io/cocoapods/l/PYPhotoBrowser.svg?style=flat)](https://opensource.org/licenses/MIT)

- An easy way to browse photo(image) for iOS.

- iOS 中使用简单的图片浏览器。

## QQ chat room

 

## Contents

* Getting Started

  * [Renderings【效果图】](#效果图)

  * [Who is using PYPhotoBrowser【哪些app使用PYPhotoBrowser】](#哪些app使用)

  * [Status 【支持哪些状态】](#支持哪些状态)

  * [Layouts【支持哪些布局】](#支持哪些布局)

  * [Gestures【支持哪些手势】](#支持哪些手势)

  * [What place will use this framework【什么地方用到这个框架】](#什么地方用到这个框架啊啊)

  * [Dependency 【依赖哪些第三方框架】](#依赖哪些第三方框架)

  * [Classes【PYPhotosView框架的主要类】](#PYPhotosView框架的主要类)

  

* 框架使用

  * [How to use【如何使用PYPhotosView】](#如何使用PYPhotosView)

  * [Details 【具体使用(详情见示例程序PYPhotosViewExample)】](#具体使用（详情见示例程序PYPhotosViewExample）)

  * [Custom【自定义photosView】](#自定义photosView)

  

* [期待](#期待什么)

## 效果图

- **图片已发布（网络图片浏览、流水布局)**

  ![(img)](https://github.com/iphone5solo/learngit/raw/master/imagesForPhotosView/images/.gif)

- **图片未发布（本地图片上传\发布\预览）**

  ![(img)](https://github.com/iphone5solo/learngit/raw/master/imagesForPhotosView/images/PYPhotosViewWillcompose.gif)

## 哪些app使用PYPhotoBrowser（陆续更新）

[香脉](https://itunes.apple.com/cn/app/xiang-mai/id1148870886?mt=8)

[汕医移动办公](https://itunes.apple.com/cn/app/shan-yi-yi-dong-ban-gong/id1148395189?mt=8)

[爱牛股](https://itunes.apple.com/cn/app/ai-niu-gu-da-shu-ju-zhen-gu/id1158645929?mt=8)

[惠心名刀](https://itunes.apple.com/cn/app/hui-xin-ming-dao/id1154410531?mt=8)

## 支持哪些状态

- **已发布（网络图片浏览）**

![(img)](https://github.com/iphone5solo/learngit/raw/master/imagesForPhotosView/images/imagestatedidcompose.png)

- **未发布（本地图片上传\发布\预览）**

  ![(img)](https://github.com/iphone5solo/learngit/raw/master/imagesForPhotosView/images/imgaestatewillcompose.png)

## 支持哪些布局

- `流水布局` 、 `线性布局`

## 支持哪些手势

- `单击` 、`双击` 、`捏合` 、`旋转`、`拖拽`、`侧滑`

## 什么地方用到这个框架

- 主要用于社交app,用于呈现一组图片

- 以下是各个流行社交app的部分截图

![(img1)](https://github.com/iphone5solo/learngit/raw/master/imagesForPhotosView/images/IMG_0225.PNG)

![(img1)](https://github.com/iphone5solo/learngit/raw/master/imagesForPhotosView/images/IMG_0226.PNG)

![(img1)](https://github.com/iphone5solo/learngit/raw/master/imagesForPhotosView/images/IMG_0227.PNG)

![(img1)](https://github.com/iphone5solo/learngit/raw/master/imagesForPhotosView/images/IMG_0228.PNG)

![(img1)](https://github.com/iphone5solo/learngit/raw/master/imagesForPhotosView/images/IMG_0229.PNG)

![(img1)](https://github.com/iphone5solo/learngit/raw/master/imagesForPhotosView/images/IMG_0230.PNG)

## 依赖哪些第三方框架

* 图片浏览依赖框架

	- `MBProgressHUD`

	- `SDWebImage`

	- `DACircularProgress`

	- `FLAnimatedImage` 

	

## PYPhotoBrowser框架的主要类

### PYPhotosView（快速使用）

```objc

@interface PYPhotosView : UIScrollView

/** 代理 */

@property (nonatomic, weak) id delegate;

/** 网络图片模型数组 */

@property (nonatomic, copy) NSArray *photos;

/** 网络图片地址数组（缩略图） */

@property (nonatomic, copy) NSArray *thumbnailUrls;

/** 网络图片地址数组（原图） */

@property (nonatomic, copy) NSArray *originalUrls;

/** 本地相册图片数组(默认最多为九张,当传入图片数组长度超过九张时，取前九张) */

@property (nonatomic, strong) NSMutableArray *images;

/** 所有图片的状态（默认为已发布状态） */

@property (nonatomic, assign) PYPhotosViewState photosState;

/** 图片布局（默认为流水布局） */

@property (nonatomic, assign) PYPhotosViewLayoutType layoutType;

/** 图片分页指示类型(默认为pageControll。当图片超过九张，改为label显示) */

@property (nonatomic, assign) PYPhotosViewPageType pageType;

/** 图片间距（默认为5） */

@property (nonatomic, assign) CGFloat photoMargin;

/** 图片的宽 (默认为70) */

@property (nonatomic, assign) CGFloat photoWidth;

/** 图片的高 (默认为70) */

@property (nonatomic, assign) CGFloat photoHeight;

/** 每行最多个数（默认为3）, 当图片布局为线性布局时，此设置失效 */

@property (nonatomic, assign) NSInteger photosMaxCol;

/** 当图片上传前，最多上传的张数，默认为9 */

@property (nonatomic, assign) NSInteger imagesMaxCountWhenWillCompose;

/** 快速创建photosView对象 */

+ (instancetype)photosView;

/** photos : 保存图片链接的数组 */

+ (instancetype)photosViewWithThumbnailUrls:(NSArray *)thumbnailUrls originalUrls:(NSArray *)originalUrls;

/** images : 存储本地图片的数组 */

+ (instancetype)photosViewWithImages:(NSMutableArray *)images;

/**

 * thumbnailUrls : 保存图片(缩略图)链接的数组

 * originalUrls : 保存图片(原图)链接的数组

 * type : 布局类型（默认为流水布局）

 */

+ (instancetype)photosViewWithThumbnailUrls:(NSArray *)thumbnailUrls originalUrls:(NSArray *)originalUrls layoutType:(PYPhotosViewLayoutType)type;

/** 

 * thumbnailUrls : 保存图片(缩略图)链接的数组

 * originalUrls : 保存图片(原图)链接的数组

 * maxCol : 每行最多显示图片的个数

 */

+ (instancetype)photosViewWithThumbnailUrls:(NSArray *)thumbnailUrls originalUrls:(NSArray *)originalUrls photosMaxCol:(NSInteger)maxCol;

/** 根据图片个数和图片状态自动计算出PYPhontosView的size */

- (CGSize)sizeWithPhotoCount:(NSInteger)count photosState:(NSInteger)state;

/**

 * 刷新图片(未发布)

 * images : 新的图片数组

 */

- (void)reloadDataWithImages:(NSMutableArray *)images;

@end

```

### PYPhotoBrowseView（自定义）

```objc

@protocol PYPhotoBrowseViewDelegate 

@optional

/**

 * 图片浏览将要显示时调用

 */

- (void)photoBrowseView:(PYPhotoBrowseView *)photoBrowseView willShowWithImages:(NSArray *)images index:(NSInteger)index;

/**

 * 图片浏览已经显示时调用

 */

- (void)photoBrowseView:(PYPhotoBrowseView *)photoBrowseView didShowWithImages:(NSArray *)images index:(NSInteger)index;

/**

 * 图片浏览将要隐藏时调用

 */

- (void)photoBrowseView:(PYPhotoBrowseView *)photoBrowseView willHiddenWithImages:(NSArray *)images index:(NSInteger)index;

/**

 * 图片浏览已经隐藏时调用

 */

- (void)photoBrowseView:(PYPhotoBrowseView *)photoBrowseView didHiddenWithImages:(NSArray *)images index:(NSInteger)index;

/**

 * 图片单击时调用

 */

- (void)photoBrowseView:(PYPhotoBrowseView *)photoBrowseView didSingleClickedImage:(UIImage *)image index:(NSInteger)index;

/**

 * 图片长按时调用

 */

- (void)photoBrowseView:(PYPhotoBrowseView *)photoBrowseView didLongPressImage:(UIImage *)image index:(NSInteger)index;

@end

@protocol PYPhotoBrowseViewDataSource 

@optional

/** 返回将要浏览的图片（UIImage）数组 */

- (NSArray *)imagesForBrowse;

/** 返回将要浏览的图片链接(NSString)数组, 如果实现了- (NSArray *)imagesForBrowse;方法，则忽略此方法 */

- (NSArray *)imagesURLForBrowse;

/** 返回默认显示图片的索引(默认为0) */

- (NSInteger)currentIndex;

/** 默认显示图片相对于主窗口的位置 */

- (CGRect)frameFormWindow;

/** 消失回到相对于住窗口的指定位置 */

- (CGRect)frameToWindow;

@end

@interface PYPhotoBrowseView  : UIWindow 

/** 代理 */

@property (nonatomic, weak) id delegate;

/** 数据源代理 */

@property (nonatomic, weak) id dataSource;

/** 用来浏览的图片（UIImage）数组

 * 建议传入的UIImage是已下载的。如果是异步下载，请使用imagesURL

 * 如果设置了这个属性imagesURL失效

 */

@property (nonatomic, copy) NSArray *images;

/** 用来浏览的图片链接（NSString）数组*/

@property (nonatomic, copy) NSArray *imagesURL;

/** 用来浏览的图片的控件（UIImageView）数组 */

@property (nonatomic, copy) NSArray *sourceImgageViews;

/** 用来记录当前下标 */

@property (nonatomic, assign) NSInteger currentIndex;

/** 默认显示图片相对于主窗口的位置(即从窗口的哪个位置显示)，

 * 注意：设置此属性时，showFromView属性失效

 */

@property (nonatomic, assign) CGRect frameFormWindow;

/** 传入从哪张图片(UIImageView)开始慢慢放大显示 */

@property (nonatomic, strong) UIView *showFromView;

/** 消失回到相对于住窗口的指定位置(即消失在窗口的哪个位置)

 * 注意：设置此属性时，hiddenToView属性失效

 */

@property (nonatomic, assign) CGRect frameToWindow;

/** 传入慢慢缩小到哪张图片(UIImageView)然后消失 */

@property (nonatomic, strong) UIView *hiddenToView;

/** 当屏幕旋转时，是否自动旋转图片 默认为YES */

@property (nonatomic, assign) BOOL autoRotateImage;

/**

 * 浏览图片

 */

- (void)show;

/**

 * 隐藏

 */

- (void)hidden;

@end

```

## 如何使用PYPhotoBrowser

* 使用Cocoapods:

  - `pod "PYPhotoBrowser"`

  - 导入主头文件`#import `

* 手动导入：

  - 将`PYPhotoBrowser`文件夹中的所有文件拽入项目中

  - 导入主头文件`#import "PYPhotoBrowser.h"`

  - `使用注意:`如果项目本来就有依赖的第三方框架：`MBProgressHUD、SDWebImage、DACircularProgress`就不必重复导入, 如果没有，选择`Dependency`文件夹中，项目不存在的框架拽入项目。

  

  

### 具体使用（详情见示例程序PYPhotosViewExample）

- **已发布（网络图片浏览）**

    示例代码：

```objc

    // 1. 创建缩略图图片链接数组

    NSMutableArray *thumbnailImageUrls = [NSMutableArray array];

    // 添加图片(缩略图)链接

    [thumbnailImageUrls addObject:@"http://ww3.sinaimg.cn/thumbnail/006ka0Iygw1f6bqm7zukpj30g60kzdi2.jpg"];

    [thumbnailImageUrls addObject:@"http://ww1.sinaimg.cn/thumbnail/61b69811gw1f6bqb1bfd2j20b4095dfy.jpg"];

    [thumbnailImageUrls addObject:@"http://ww1.sinaimg.cn/thumbnail/54477ddfgw1f6bqkbanqoj20ku0rsn4d.jpg"];

    [thumbnailImageUrls addObject:@"http://ww4.sinaimg.cn/thumbnail/006ka0Iygw1f6b8gpwr2tj30bc0bqmyz.jpg"];

    [thumbnailImageUrls addObject:@"http://ww2.sinaimg.cn/thumbnail/9c2b5f31jw1f6bqtinmpyj20dw0ae76e.jpg"];

    [thumbnailImageUrls addObject:@"http://ww1.sinaimg.cn/thumbnail/536e7093jw1f6bqdj3lpjj20va134ana.jpg"];

    [thumbnailImageUrls addObject:@"http://ww1.sinaimg.cn/thumbnail/75b1a75fjw1f6bqn35ij6j20ck0g8jtf.jpg"];

    [thumbnailImageUrls addObject:@"http://ww2.sinaimg.cn/thumbnail/005NFHyQgw1f6bn8bha0eg308w0gib2d.gif"];

    [thumbnailImageUrls addObject:@"http://ww1.sinaimg.cn/thumbnail/86afb21egw1f6bq3lq0itj20gg0c2myt.jpg"];

    

    // 1.2 创建原图图片链接数组

    NSMutableArray *originalImageUrls = [NSMutableArray array];

    // 添加图片(原图)链接

    [originalImageUrls addObject:@"http://ww3.sinaimg.cn/large/006ka0Iygw1f6bqm7zukpj30g60kzdi2.jpg"];

    [originalImageUrls addObject:@"http://ww1.sinaimg.cn/large/61b69811gw1f6bqb1bfd2j20b4095dfy.jpg"];

    [originalImageUrls addObject:@"http://ww1.sinaimg.cn/large/54477ddfgw1f6bqkbanqoj20ku0rsn4d.jpg"];

    [originalImageUrls addObject:@"http://ww4.sinaimg.cn/large/006ka0Iygw1f6b8gpwr2tj30bc0bqmyz.jpg"];

    [originalImageUrls addObject:@"http://ww2.sinaimg.cn/large/9c2b5f31jw1f6bqtinmpyj20dw0ae76e.jpg"];

    [originalImageUrls addObject:@"http://ww1.sinaimg.cn/large/536e7093jw1f6bqdj3lpjj20va134ana.jpg"];

    [originalImageUrls addObject:@"http://ww1.sinaimg.cn/large/75b1a75fjw1f6bqn35ij6j20ck0g8jtf.jpg"];

    [originalImageUrls addObject:@"http://ww2.sinaimg.cn/large/005NFHyQgw1f6bn8bha0eg308w0gib2d.gif"];

    [originalImageUrls addObject:@"http://ww1.sinaimg.cn/large/86afb21egw1f6bq3lq0itj20gg0c2myt.jpg"];

  

  // 2. 创建一个photosView

  PYPhotosView *photosView = [PYPhotosView photosViewWithThumbnailUrls:thumbnailImageUrls originalUrls:originalImageUrls];

  

  // 3. 添加photosView

  [self.view addSubview:photosView];

  

```

  

- **未发布（本地图片上传\发布\预览）**

   示例代码：

```objc

    

    // 1. 创建本地图片数组

    NSMutableArray *imagesM = [NSMutableArray array];

    for (int i = 0; i < arc4random_uniform(4) + 1; i++) {

        [imagesM addObject:[UIImage imageNamed:[NSString stringWithFormat:@"%02d", i + 1]]];

    }

    

    // 2.1 设置本地图片

  	PYPhotosView *photosView = [PYPhotosView photosViewWithImages:imagesM];

    

    // 3. 设置代理

    photosView.delegate = self;

    

    // 4. 添加photosView

    [self.view addSubview:photosView];

```

- **仅使用图片浏览功能（使用PYPhotoBrowseView类）**

	示例代码：

	

```objc

    // 1. 创建photoBroseView对象

    PYPhotoBrowseView *photoBroseView = [[PYPhotoBrowseView alloc] init];

    

    // 2.1 设置图片源(UIImageView)数组

    photoBroseView.sourceImgageViews = imageViews;

    // 2.2 设置初始化图片下标（即当前点击第几张图片）

    photoBroseView.currentIndex = 2;

    

    // 3.显示(浏览)

    [photoBroseView show];

```

 

## 自定义photosView

### 通过设置photosView的对象属性值即可修改

* 设置布局类型（默认为流水布局）

```objc

// 设置布局为线性布局

photosView.layoutType = PYPhotosViewLayoutTypeLine;

```

* 设置分页指示类型（默认为pageControll指示器）

```objc

// 设置指示类型为文本指示

photosView.pageType = PYPhotosViewPageTypeLabel;

```

* 设置图片间距（默认为5）

```objc

// 设置图片间距为10

photosView.photoMargin = 10;

```

* 设置图片大小（默认70\*70）

```objc

// 设置图片的宽（width）

photosView.photoWidth = 100;

// 设置图片的高（height）

photosView.photoHeight = 60;

```

* 设置每行图片最多个数（默认为3个）

```objc

// 设置图片最多列数

photosView.photosMaxCol = 6;

```

* 设置图片上传前，最多上传的张数（默认为9）

```objc

// 设置图片最多上传的张数

photosView.imagesMaxCountWhenWillCompose = 15;

```

* 设置当屏幕旋转时，图片是否自适应调整（默认为YES）

```objc

// 关闭当屏幕旋转时，图片的自适应

photosView.autoRotateImage = NO;

```

## 期待

- 如果您在使用过程中有任何问题，欢迎[issue me](https://github.com/iphone5solo/PYPhotoBrowser/issues/new)! 很乐意为您解答任何相关问题!

- 与其给我点star，不如向我狠狠地抛来一个BUG！

- 如果想要参与这个项目的维护，可以直接pull request！

- 如果您想要更多的接口来自定义或者建议/意见，欢迎issue me！我会根据大家的需求提供更多的接口！

- 如果您在上线的app中使用到该第三方，欢迎[issue me](https://github.com/iphone5solo/PYPhotoBrowser/issues/new)，让我可以及时统计、更新！