All files / src/types image-set.js

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
6x
 
 
 
 
 
/* * *  *  * *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  * */
/* Copyright (c) 2018 Mobify Research & Development Inc. All rights reserved. */
/* * *  *  * *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  *  * */
 
import PropTypes from 'prop-types'
import {Image} from './image'
import {VariationProperty} from './variation-property'
 
/**
 * @memberOf module:types
 * @typedef {Object} ImageSet
 * @property {Array.<module:types.Image>} images The images.
 * @property {Array.<module:types.VariationProperty>} variationProperties The variation properties that apply to the images.
 * @property {String} sizeType The images size type (ex. 'small', 'medium', 'large', 'swatch').
 */
export const ImageSet = {
    images: PropTypes.arrayOf(PropTypes.shape(Image)),
    variationProperties: PropTypes.arrayOf(PropTypes.shape(VariationProperty)),
    sizeType: PropTypes.string
}