mirror of
https://github.com/status-im/react-native.git
synced 2025-01-10 01:25:39 +00:00
ee8496f364
Summary:
Allows developers to specify headers to include in the HTTP request
when fetching a remote image. For example, one might leverage this
when fetching an image from an endpoint that requires authentication:
```
<Image
style={styles.logo}
source={{
uri: 'http://facebook.github.io/react/img/logo_og.png',
headers: {
Authorization: 'someAuthToken'
}
}}
/>
```
Note that the header values must be strings.
Works on iOS and Android.
**Test plan (required)**
- Ran a small example like the one above on iOS and Android and ensured the headers were sent to the server.
- Ran a small example to ensure that \<Image\> components without headers still work.
- Currently using this code in our app.
Adam Comella
Microsoft Corp.
Closes https://github.com/facebook/react-native/pull/7338
Reviewed By: javache
Differential Revision: D3371458
Pulled By: nicklockwood
fbshipit-source-id: cdb24fe2572c3ae3ba82c86ad383af6d85157e20
51 lines
1.4 KiB
Objective-C
51 lines
1.4 KiB
Objective-C
/**
|
|
* Copyright (c) 2015-present, Facebook, Inc.
|
|
* All rights reserved.
|
|
*
|
|
* This source code is licensed under the BSD-style license found in the
|
|
* LICENSE file in the root directory of this source tree. An additional grant
|
|
* of patent rights can be found in the PATENTS file in the same directory.
|
|
*/
|
|
|
|
#import <Foundation/Foundation.h>
|
|
|
|
#import "RCTConvert.h"
|
|
|
|
/**
|
|
* Object containing an image URL and associated metadata.
|
|
*/
|
|
@interface RCTImageSource : NSObject
|
|
|
|
@property (nonatomic, copy, readonly) NSURLRequest *request;
|
|
@property (nonatomic, assign, readonly) CGSize size;
|
|
@property (nonatomic, assign, readonly) CGFloat scale;
|
|
|
|
/**
|
|
* Create a new image source object.
|
|
* Pass a size of CGSizeZero if you do not know or wish to specify the image
|
|
* size. Pass a scale of zero if you do not know or wish to specify the scale.
|
|
*/
|
|
- (instancetype)initWithURLRequest:(NSURLRequest *)request
|
|
size:(CGSize)size
|
|
scale:(CGFloat)scale;
|
|
|
|
/**
|
|
* Create a copy of the image source with the specified size and scale.
|
|
*/
|
|
- (instancetype)imageSourceWithSize:(CGSize)size scale:(CGFloat)scale;
|
|
|
|
@end
|
|
|
|
@interface RCTImageSource (Deprecated)
|
|
|
|
@property (nonatomic, strong, readonly) NSURL *imageURL
|
|
__deprecated_msg("Use request.URL instead.");
|
|
|
|
@end
|
|
|
|
@interface RCTConvert (ImageSource)
|
|
|
|
+ (RCTImageSource *)RCTImageSource:(id)json;
|
|
|
|
@end
|