Skip to main content

Framework

Elements

Button

import { Button } from '@elements';

<Button text="Button Text" textProps={{ safelyTranslation: true }} />
} = pages;

Properties

PropertyDescriptionTypeDefault
classNameThe style used by the componentstring,Array‘forms.button.regular’
textThe text on the buttonstringundefined
activeOpacityThe opacity value when the component is activenumber0.2
textClassNameThe style used for button textstring,Array‘forms.button.buttonText’
iconClassNameThe style used for button iconstring,Array‘’
textPropsThe properties used by button textTextPropsDefault text props
onPressThe function to be called after pressing the buttonfunctionundefined
validationValidation messagesstring,Array[]
validationClassNameThe style used for validation messagesstring,Array‘forms.button.buttonValidationText’
disabledDisables the button componentbooleanfalse
disabledClassNameThe style used when the button component is disabledstring,Array‘forms.button.disabled’

CheckBox

import { CheckBox } from '@elements';

<CheckBox
value={true}
content={() => (
<View className="forms.checkBox.labelContainer">
<Text safelyTranslation className="forms.checkBox.labelText">Label</Text>
</View>
)}
/>

Properties

PropertyDescriptionTypeDefault
onStatusChangeThe function to be called after changing the CheckBox statusfunctionundefined
boxClickableIf false, the CheckBox is disabledbooleantrue
validationValidation messagesstring,Array[]
validationClassNameThe style to be used for validation messagesstring,Array'forms.checkBox.validationText’
defaultValueDefault valuebooleanfalse
modalTitleThe title of the modal pagestringModalComponent.title
modalContentThe content of the modal pageReact.Componentundefined
modalFooterVisibleIndicates whether the footer component on the displayed modal page is visiblebooleanModalComponent.modalFooterVisible
modalApproveThe approval text on the modal pagestringModalComponent.approveText
modalDisapproveThe disapproval text on the modal pagestringModalComponent.disapproveText
valueThe value of the CheckBoxbooleanfalse
isSelectableIf false, CheckBox is disabled.booleantrue
circleRenders the CheckBox component as a circlebooleanfalse
contentThe label content next to the CheckBox(openModal: function) ⇒ React.Componentundefined

Container

import { Container } from '@elements';

<Container>
<Text safelyTranslation>Hello World</Text>
</Container>

Properties

PropertyDescriptionTypeDefault
classNameThe style used by the componentstring, Array‘’
bgImageNameThe name of the component’s background imagestringundefined
bgImageSourceThe source object of the component’s background imageobjectundefined
childrenThe content to be displayed within the componentReact.Componentundefined
defaultStyleThe default style object of the componentStyleProp (ViewStyle)undefined
topBgChanges the SafeArea background color within the component. It also changes the StatusBar background if the device is Android.string'#fff’
excludeEdgesArray[]
barStylebarStyle feature for the StatusBarstring'dark-content’
statusBarTransparentMakes the StatusBar background transparent if the device is Androidbooleanfalse

Content

import { Content } from '@elements';

<Content>
<Text safelyTranslation>Hello World</Text>
</Content>

Properties

PropertyDescriptionTypeDefault
childrenThe content to be displayed within the componentReact.Componentundefined
classNameThe style used by the componentstring, Array‘’
scrollTopContainerClassNameThe style used by the Scroll Top componentstring, Array‘’
scrollTopIconClassNameThe style used by the icon within the Scroll Top componentstring, Array‘’
optionsComponent settingsobjectContentOptions
scrollEnableIf true, the content is displayed within a ScrollView.booleantrue

ContentOptions

{
scrollTop: false,
bounces: true,
showScrollIndicator: true,
pagingEnabled: false,
nestedScrollEnabled: false,
}

Datepicker

import { DatePicker } from '@elements';
<DatePicker />

Properties

PropertyDescriptionTypeDefault
onChangeThe function to be called when the value changesfunctionundefined
placeholderPlaceholderstringundefined
valueThe value of the componentDateundefined
maximumDateThe maximum value of the componentDateundefined
validationValidation messagesstring, Array[]
validationClassNameThe style used by the validation messagesstring, Array'forms.checkBox.validationText’
iconNameThe name of the icon to the right of the componentstringundefined
titleThe title of the displayed Datepickerstringundefined
iconVisibleIndicates whether the icon to the right of the component is visiblebooleantrue
seperatorThe character between day-month-year while formatting the value of the componentstring‘.’

HtmlContent

import { HtmlContent } from '@elements';
<HtmlContent content="<div>Hello World</div>" />

Properties

PropertyDescriptionTypeDefault
contentThe HTML content to be displayedstringundefined
onLinkPressThe function to be called after clicking the links within the HTMLfunctionundefined

Icon

import { Icon } from '@elements';

<Icon name="globe" />

Properties

PropertyDescriptionTypeDefault
nameThe name of the iconstringundefined
classNameThe style used by the componentstring, Array‘’
defaultStyleThe default style object of the componentStyleProp (ViewStyle)undefined
onPressThe function to be called upon clicking the componentfunctionundefined
sizeThe size of the iconnumber12

IconButton

import { IconButton } from '@elements';

<IconButton icon="globe" />

Properties

PropertyDescriptionTypeDefault
iconThe name of the iconstringundefined
classNameThe style used by the componentstring, Array‘’
iconClassNameThe style used by the iconstring, Array‘’
onPressThe function to be called upon clicking the componentfunctionundefined
disabledIndicates whether the button is activebooleanfalse
badgeThe component displayed within the buttonReact.Componentundefined

Image

import { Image } from '@elements';

<Image
source={{
uri: 'https://picsum.photos/200/300',
}}
defaultStyle={{ width: 100, height: 100 }}
/>

Properties

PropertyDescriptionTypeDefault
sourceThe object that indicates image sourceobjectundefined
classNameThe style used by the componentstring, Array‘’
defaultStyleThe default style object of the componentStyleProp (ViewStyle)undefined

ImagePicker

import { Input } from '@elements';

<Input />

Properties

PropertyDescriptionTypeDefault
placeholderPlaceholderstringundefined
containerClassNameThe style used by the container that wraps the Inputstring, Array‘’
classNameThe style used by the componentstring, Array‘forms.input.regular’
disabledClassNameThe style used when the component is inactivestring, Array‘forms.input.disabled
validationValidation messagesstring, Array[]
validationClassNameThe style used by the validation messagesstring, Array'forms.input.inputValidationText’
labelThe title seen above the Inputstringundefined
labelWrapperClassNameThe style used by the container that wraps the title on the componentstring, Arrayundefined
labelClassNameThe style used by the title on the componentstring, Array'forms.input.inputLabelText'
mask
maskOptions
maskType
valueThe value of the componentstringundefined
editableIndicates whether the component can be editedbooleantrue
fwRef
secureTextEntryDisplays the content of the component as the password fieldbooleanfalse
secureTextIconClassNameThe style used by the Show/Hide Password iconstring, Array'forms.input.secureTextIcon'
secureTextIconWrapperClassNameThe style used by the component that wraps the Show/Hide Password iconstring, ArrayDe'forms.input.secureTextIconWrapper'fault
passwordVisibleIconThe name of the Show Password iconstring‘eye’
passwordHideIconThe name of the Hide Password iconstring'eye-blocked’
optionsThe settings used by the componentobjectoptions: {placeholderColor: ‘#FFF’,}

Picker

import { Picker } from '@elements';

<Picker
data={[
{ label: 'Option 1', value: 1 },
{ label: 'Option 2', value: 2 },
]}
selectedItem={1}
placeholder="Select an option"
headerTitle={{ tr: 'Select an option' }}
/>

Properties

PropertyDescriptionTypeDefault
placeholderPlaceholderstringundefined
selectedItemThe selected itemanyundefined
headerTitleThe title of the displayed modalobjectundefined
dataThe data array with the optionsArray[]
labelThe title on the pickerstringundefined
onSelectThe function to be called when an option is selectedfunctionundefined
threeDotTextThe three-dot setting when options don’t fit the pickerbooleanundefined
visibleOnEmptyNo picker is shown if there are no options.booleantrue
validationValidation messagesstring, Array[]
validationClassNameThe style to be used by the validation messagesTystring, Arraype'forms.picker.validationText',
iconNameThe name of the icon to the right of the pickerstringundefined

RadioGroup

import { RadioGroup } from '@elements';

<RadioGroup
options={[
{ label: 'Option 1', value: 1 },
{ label: 'Option 2', value: 2 },
]}
value={2}
/>

Properties

PropertyDescriptionTypeDefault
optionsThe options to be displayedArray[]
onSelectThe function to be called when an option is selectedfunctionundefined
valueThe selected itemanyundefined
titleThe title seen on RadioGroupobjectundefined
validationValidation messagesstring, Array[]
validationClassNameThe style to be used by the validation messagesstring, Array'forms.radioButton.validationText'

SafeArea

import { SafeArea } from '@elements';

<SafeArea>
<Text safelyTranslation>Hello World</Text>
</SafeArea>

Properties

PropertyDescriptionTypeDefault
childrenThe component to be shown within the componentReact.Componentundefined
classNameThe style used by the componentstring‘’
defaultStyleThe default style object of the componentStyleProp (ViewStyle)undefined

SafeAreaView

import { SafeAreaView } from '@elements';

<SafeAreaView>
<Text safelyTranslation>Hello World</Text>
</SafeAreaView>

Properties

PropertyDescriptionTypeDefault
childrenThe component to be shown within the componentReact.Componentundefined
classNameThe style used by the componentstring‘’

ScrollView

import { ScrollView } from '@elements';

<ScrollView>
<Text safelyTranslation>Hello World</Text>
</ScrollView>

Properties

PropertyDescriptionTypeDefault
childrenThe component to be shown within the componentReact.Componentundefined
classNameThe style used by the componentstring‘’
defaultStyleThe default style object of the componentStyleProp (ViewStyle)null
fwRefThe reference indicating the component--

Spinner

import { Spinner } from '@elements';

<Spinner />

Properties

PropertyDescriptionTypeDefault
colorThe color of the Spinnerstring‘black’
containerClassNameThe style used by the component that wraps the Spinnerstring‘’
childrenThe component to be shown within the componentReact.Componentundefined
transparentMakes the component that wraps the Spinner transparentbooleanfalse
styleNameThe style of the component that wraps the Spinner‘center’, ‘centerPadding’, ‘centerFullHeight’‘center’
indicatorSizeThe size of the ActivityIndicatorstring‘small’

Switch

import { Switch } from '@elements';

<Switch />

Properties

PropertyDescriptionTypeDefault
activeClassNameThe style used when the component is activestring'forms.switch.switchActive'
classNameThe style used by the componentstring'forms.switch.switchPassive'
valueThe value of the componentbooleanundefined
fwRefThe reference indicating the component--

TabView

import { TabView } from '@elements';

<TabView>
<Comp1 tabLabel="Tab 1" />
<Comp2 tabLabel="Tab 2" />
</TabView>

Properties

PropertyDescriptionTypeDefault
childrenThe component to be shown within the componentReact.Componentundefined
classNameThe style used by the componentstring'forms.switch.switchPassive'
valueThe value of the componentbooleanundefined
bgColorThe background color of the componentstring‘transparent’
txColorThe color of the tab textstring‘#000’
activeTxColorThe color of the text when the tab is activestring‘#000’
underLineClassNameThe style used by the indicator under the tabstring‘’
textClassNameThe style of the tab textstring‘’

Components

StaticPages

EmptyView

<EmptyView
navigation={navigation}
route={route}
moduleName="RN_EXPO_BARCODE_SCANNER_BUILD"
/>
Properties
PropertyDescriptionTypeDefault
moduleNameThe name of the unsupported modulestringundefined
navigationNavigation objectobjectundefined
routeDescriptionRoute objectundefined

ActionSheet

<ActionSheet
onPress={(buttonIndex) => events[buttonIndex]()}
options={options}
visible={isModalOpen}
icons={[<Icon name='xxxx' />]}
destructiveButtonIndex={0}
cancelButtonIndex={2}
title={$T.DELETE_MODAL_TITLE}
message={$T.DELETE_MODAL_DESCRIPTION}
/>

Properties

PropertyDescriptionTypeDefault
destructiveButtonIndexRecommended for deletion, to change the option color to rednumberundefined
onPressAction press handlerFunction() => null
cancelButtonIndexFor cancelling and separating the option from other optionsnumberundefined
optionsFor creating actionsArrayundefined
messageFor adding content to action sheetstringundefined
visibleFor opening the action sheetbooleanundefined
titleFor adding titles to action sheetstringundefined
iconsFor adding icons to optionsArrayundefined

Address

AddressLabel

<AddressLabel
className=”some.style.class”
address={address}
/>
Properties
PropertyDescriptionTypeDefault
classNameThe name of the class with the defined stylestringundefined
addressThe name of the addresstextundefined

AddressLine

<AddressLine
className=”some.style.class”
line={line}
/>
Properties
PropertyDescriptionTypeDefault
classNameThe name of the class with the defined stylestringundefined
lineLine texttextundefined

AddressTitle

<AddressTitle title={title} />
Properties
PropertyDescriptionTypeDefault
titleAddress title textstringundefined

PhoneNumber

<PhoneNumber phoneNumber={PhoneNumber} />
Properties
PropertyDescriptionTypeDefault
phoneNumberPhone texttextundefined

Basket

CampaignSwiper

<CampaignSwiper items={campaigns} />
Properties
PropertyDescriptionTypeDefault
itemsThe campaigns object array used for the Swiperarray[ ]

BasketItem

<BasketItem
product={product}
handleChangeQuantity={handleChangeQuantity}
handleSubmitGiftNote={handleSubmitGiftNote}
handleRemoveGiftNote={handleRemoveGiftNote}
handleAddToFavourite={handleAddToFavourite}
isInFavourites={hasFavourite && isLogin && favourites.includes(product.pk)}
isLogin={isLogin}
navigation={navigation}
options={basketItem}
isFavouriteActive={hasFavourite && isLogin}
>
Properties
PropertyDescriptionTypeDefault
productThe displayed product objectobjectundefined
handleChangeQuantityThe method triggered when quantity changesFunctionundefined
handleSubmitGiftNoteThe method triggered when gift note changesFunctionundefined
handleRemoveGiftNoteThe method triggered when the gift note is removedFunctionundefined
handleAddToFavouriteThe method triggered when the product is added to favoritesFunctionundefined
isInFavouritesThe status of the product added to favoritesbooleanundefined
isLoginThe status of loginbooleanundefined
navigationNavigation objectobjectundefined
optionsThe basketItem settings sent from Rulesobjectundefined
isFavouriteActiveThe availability status for adding the product to favoritesbooleanundefined

CampaignTotalAmount

<CheckoutButton confirmBasket={confirmBasket} />
Properties
PropertyDescriptionTypeDefault
confirmBasketThe function that confirms the cartFunctionundefined

CheckoutButtonPrice

<CheckoutButtonPrice amounts={amounts} />
Properties
PropertyDescriptionTypeDefault
amountsThe object that stores quantityobjectundefined

ContinueShoppingButton

<ContinueShoppingButton navigation={navigation} />
Properties
PropertyDescriptionTypeDefault
navigationNavigation objectobjectundefined

CouponCode

<CouponCode 
voucherCode={voucherCode}
validation={validation}
apiError={apiError}
handleDiscount={handleDiscount}
/>
Properties
PropertyDescriptionTypeDefault
voucherCodeVoucher codestringundefined
validationValidation objectobjectundefined
apiErrorAPI error objectobjectundefined
handleDiscountThe method triggered when discount is appliedFunctionundefined

DeleteModal

<DeleteModal 
isModalOpen={isModalOpen}
pending={pending}
product={product}
closeModal={closeModal}
removeItem={removeItem}
isInFavourites={isInFavourites}
isFavouriteActive={isFavouriteActive}
type={type}
animationType={animationType}
handleMoveItemToFavourite={handleMoveItemToFavourite}
/>
Properties
PropertyDescriptionTypeDefault
isModalOpenThe visibility of the Modalbooleanundefined
pendingThe pending status for loadingbooleanundefined
productProduct objectobjectundefined
closeModalThe method to close the modalFunctionundefined
removeItemThe method to remove the productFunctionundefined
isInFavouritesThe status of adding to favoritesbooleanundefined
isFavouriteActiveThe availability status of adding to favoritesbooleanundefined
typeModal typestring‘default’
animationTypeAnimation statusstring‘none’
handleMoveItemToFavouriteThe method triggered when added to favoritesFunctionundefined

Discounts

<Discounts discounts={discounts} />
Properties
PropertyDescriptionTypeDefault
discountsDiscounts arrayArrayundefined

ItemBrand

<ItemBrand product={product} />
Properties
PropertyDescriptionTypeDefault
productProduct objectobjectundefined

ItemGiftNote

<ItemGiftNote 
product={product}
handleSubmitGiftNote={handleSubmitGiftNote}
handleRemoveGiftNote={handleRemoveGiftNote}
/>
Properties
PropertyDescriptionTypeDefault
productProduct objectobjectundefined
handleSubmitGiftNoteThe method triggered when gift note is addedFunctionundefined
handleRemoveGiftNoteProduct The method triggered when the gift note is removedFunctionundefined

ItemImage

<ItemImage 
navigation={navigation}
product={product}
$imageWidth={imageWidth}
$imageHeight={imageHeight}
/>
Properties
PropertyDescriptionTypeDefault
navigationNavigation objectobjectundefined
$imageWidthImage widthnumberundefined
$imageHeightImage heightnumberundefined
productProduct objectobjectundefined

ItemName

<ItemName 
navigation={navigation}
product={product}
/>
Properties
PropertyDescriptionTypeDefault
navigationNavigation objectobjectundefined
productProduct objectobjectundefined

ItemPrice

<ItemPrice 
options={options}
product={product}
/>
Properties
PropertyDescriptionTypeDefault
optionsPrice config objectobjectundefined
productProduct objectobjectundefined

ItemQuantityButtons

<ItemQuantityButtons 
handleChangeQuantity={handleChangeQuantity}
product={product}
/>
Properties
PropertyDescriptionTypeDefault
handleChangeQuantityThe method triggered when the quantity of the product changesFunctionundefined
productProduct objectobjectundefined

ItemRemoveButton

<ItemRemoveButton handleRemoveProduct={handleRemoveProduct} />
Properties
PropertyDescriptionTypeDefault
handleRemoveProductThe method triggered when the product is removedFunctionundefined

ItemRetailPrice

<ItemRetailPrice 
options={options}
product={product}
/>
Properties
PropertyDescriptionTypeDefault
optionsRetail price config objectobjectundefined
productProduct objectobjectundefined

ItemSku

<ItemSku product={product} />
Properties
PropertyDescriptionTypeDefault
productProduct objectobjectundefined

ItemSwipableContent

<ItemSwipableContent swipeToDelete={swipeToDelete} />
Properties
PropertyDescriptionTypeDefault
swipeToDeleteThe status of the Swipe to Delete optionbooleanundefined

ItemVariants

<ItemVariants product={product} />
Properties
PropertyDescriptionTypeDefault
productProduct objectobjectundefined

OrderSummaryTitle

<OrderSummaryTitle />

TotalAmount

<TotalAmount amounts={amounts} />
Properties
PropertyDescriptionTypeDefault
amountsThe object that stores quantityobjectundefined

TotalCount

<TotalCount totalQuantity={totalQuantity} />
Properties
PropertyDescriptionTypeDefault
totalQuantityThe object that stores total quantityobjectundefined

TotalDiscountAmount

<TotalDiscountAmount amounts={amounts} />
Properties
PropertyDescriptionTypeDefault
amountsThe object that stores total quantityobjectundefined

TotalPayable

<TotalPayable amounts={amounts} />
Properties
PropertyDescriptionTypeDefault
amountsThe object that stores total quantityobjectundefined

CarouselImageViewer

<CarouselImageViewer
images={images}
carouselOptions={carouselOptions}
carouselImageCropSizes={carouselImageCropSizes}
zoomViewerOptions={zoomViewerOptions}
zoomImageCropSizes={zoomImageCropSizes}
carouselImageWrapperClassName="className"
carouselImageClassName="className"
pagination={pagination}
carouselDotsContainerClassName={carouselDotsContainerClassName}
dotClassName={dotClassName}
dotClassNameActive={dotClassNameActive}
zoomViewerDotsContainerClassName={zoomViewerDotsContainerClassName}
zoomViewerCloseIconWrapperClassName={zoomViewerCloseIconWrapperClassName}
zoomViewerCloseIconClassName={zoomViewerCloseIconClassName}
zoomViewerLoadingRender={zoomViewerLoadingRender}
zoomViewerRenderHeader={zoomViewerRenderHeader}
zoomViewerRenderIndicator={zoomViewerRenderIndicator}
zoomViewerRenderFooter={zoomViewerRenderFooter}
defaultSlideIndex={defaultSlideIndex}
snapItem={snapItem}
/>

Properties

PropertyDescriptionTypeDefault
imagesThe list of images displayed in the carousel componentArray[ ]
carouselOptionsThe config settings of the carousel componentobject{ itemHeight: deviceHeight / 1.6, itemWidth: deviceWidth - 80, sliderWidth: deviceWidth, style: {marginBottom: 10}}
carouselImageCropSizesThe size object of the images displayed in the carousel componentobject{width: 400, height: 400,}
zoomViewerOptionsThe settings of the object used to zoomobject{backgroundColor: '#fff',},
zoomImageCropSizesThe size object of the images displayed in the zoom componentobject{width: 600, height: 600,}
carouselImageWrapperClassNameThe className value of the component that wraps the imagesstring'components.carouselImageViewer.carouselImageWrapper'
carouselImageClassNameThe className value of the component that displays the imagesstring'components.carouselImageViewer.carouselImage'
carouselDotsContainerClassNameThe container className of the Dots in the carousel componentstring'components.carouselImageViewer.carouselDotsContainer'
dotClassNameThe className value of the Dotsstring'components.carouselImageViewer.dot'
dotClassNameActiveThe className value of the Dots with active statusstring'components.carouselImageViewer.dotActive'
zoomViewerDotsContainerClassNameThe className value of the Dots with zoom statusstring'components.carouselImageViewer.zoomIndicatorsContainer'
zoomViewerCloseIconWrapperClassNameThe className value of the component that wraps the close icon in the zoom componentstring'components.carouselImageViewer.zoomViewerCloseIconWrapper'
zoomViewerCloseIconClassNameThe className value of the close icon in the zoom componentstring'components.carouselImageViewer.zoomViewerCloseIcon'
zoomViewerLoadingRenderThe loading status of the zoom componentboolean() => < Spinner styleName="centerFullHeight" />
zoomViewerRenderHeaderThe header component of the zoom componentReact.Componentnull
zoomViewerRenderIndicatorThe indicator component of the zoom componentReact.Componentnull
zoomViewerRenderFooterThe footer component of the zoom componentReact.Component() => null
defaultSlideIndexThe index of the image displayed as defaultnumber0
paginationPagination statusbooleantrue
snapItemsnapItem statusbooleanundefined

ErrorBoundary

<ErrorBoundary>



<ErrorBoundary/>

Properties

PropertyDescriptionTypeDefault
childrenThe child component to be comprised by error boundaryReact.Componentundefined
<Header 
leftContent={leftContent}
bodyContent={bodyContent}
rightContent={rightContent}
body={body}
left={left}
right={right}
excludeLeft={excludeLeft}
excludeRight={excludeRight}
autoCenterBody={autoCenterBody}
/>

Properties

PropertyDescriptionTypeDefault
leftContentThe component places on the leftReact.Componentnull
bodyContentThe component places in the centerReact.Componentnull
rightContentThe component places on the rightReact.Componentnull
bodyThe central componentReact.Componentnull
leftThe left-hand componentReact.Componentnull
rightThe right-hand componentReact.Componentnull
excludeLeftThe hiding status of the left sidebooleanfalse
excludeRightThe hiding status of the right sidebooleanfalse
autoCenterBodyThe auto-aligning status of the centerbooleanundefined

ImageViewer

 <ImageViewer
images={images}
swiperOptions={swiperOptions}
swiperImageCropSizes={swiperImageCropSizes}
zoomViewerOptions={zoomViewerOptions}
zoomImageCropSizes={zoomImageCropSizes}
swiperImageWrapperClassName="className"
swiperImageClassName="className"
dotClassName={dotClassName}
dotClassNameActive={dotClassNameActive}
zoomViewerDotsContainerClassName={zoomViewerDotsContainerClassName}
zoomViewerCloseIconWrapperClassName={zoomViewerCloseIconWrapperClassName}
zoomViewerCloseIconClassName={zoomViewerCloseIconClassName}
zoomViewerLoadingRender={zoomViewerLoadingRender}
zoomViewerRenderHeader={zoomViewerRenderHeader}
zoomViewerRenderIndicator={zoomViewerRenderIndicator}
zoomViewerRenderFooter={zoomViewerRenderFooter}
/>

Properties

PropertyDescriptionTypeDefault
imagesThe list of images displayed in the carousel componentArray[ ]
swiperOptionsThe config settings of the swiper componentobject{ horizontal: true, height: deviceWidth, paginationStyle: { bottom: 5}}
swiperImageCropSizesThe size object of the images displayed in the swiper componentobject{width: 400, height: 400,}
zoomViewerOptionsThe settings of the object used to zoomobject{backgroundColor: '#fff',},
zoomImageCropSizesThe size object of the images displayed in the zoom componentobject'components.imageViewer.swiperImageWrapper'
swiperImageWrapperClassNameThe className value of the component that wraps the imagesstring'components.imageViewer.swiperImageWrapper'
swiperImageClassNameThe className value of the component that displays the imagesstring'components.imageViewer.swiperImage'
dotClassNameThe className value of the Dotsstring'components.imageViewer.dot'
dotClassNameActiveThe className value of the Dots with active statusstring'components.imageViewer.dotActive'
zoomViewerDotsContainerClassNameThe className value of the Dots with zoom statusstring'components.imageViewer.zoomIndicatorsContainer'
zoomViewerCloseIconWrapperClassNameThe className value of the component that wraps the close icon in the zoom componentstringzoomViewerCloseIconWrapper'
zoomViewerCloseIconClassNameThe className value of the close icon in the zoom componentstring'components.imageViewer.zoomViewerCloseIcon'
zoomViewerLoadingRenderThe loading status of the zoom componentboolean() => < Spinner styleName="centerFullHeight" />
zoomViewerRenderHeaderThe header component of the zoom componentReact.Componentnull
zoomViewerRenderIndicatorThe indicator component of the zoom componentReact.Componentnull
zoomViewerRenderFooterThe footer component of the zoom componentReact.Component() => null

LanguageInfo

<LanguageInfo
renderLabel={renderLabel}
label={label}
endLabel={endLabel}
navigation={navigation}
showSingle={showSingle}
/>

Properties

PropertyDescriptionTypeDefault
renderLabelThe render function that can be specifically definedFunctionnull
labelText abovestringnull
endLabelText belowstringnull
navigationNavigation objectobjectundefined
showSingleThe status of displaying language support as singularbooleanfalse

BottomTabBar

const TabBar = BottomTabBar(bottomTabBarObject)

#Properties

PropertyDescriptionTypeDefault
bottomTabBarObjectBottom Tab Bar stack componentobjectundefined
const Side = SideBar(sideBarObject)
Properties
PropertyDescriptionTypeDefault
sideBarObjectSide Bar stack componentobjectundefined

Order

Status

const TabBar = BottomTabBar(bottomTabBarObject)
Properties
PropertyDescriptionTypeDefault
statusOrder status objectobjectundefined
iconVisibleThe visibility of the Iconbooleantrue
iconRightThe position of the Iconbooleanfalse
iconClassNameThe className value of the Iconstring'orders.status.icon'
textClassNameThe className value of the Textstring'orders.status.text'

Partials

Alert

<Alert options={options} />
Properties
PropertyDescriptionTypeDefault
optionsAlert options objectobjectundefined

NetworkModal

<NetworkModal isConnected={isConnected} />
Properties
PropertyDescriptionTypeDefault
isConnectedInternet connection statusbooleanundefined
<Popup />
Price
<Price 
price={price}
currency={currency}
className={className}
format={format}
/>
Properties
PropertyDescriptionTypeDefault
pricePrice valuenumberundefined
currencyCurrency valuestringundefined
classNameThe class name with the given stylestring‘ ’
formatPrice format valuenumberundefined

Product

<ItemImage 
imageWidth={imageWidth}
imageHeight={imageHeight}
product={product}
wrapperClassName={wrapperClassName}
imageClassName={imageClassName}
/>
Properties
PropertyDescriptionTypeDefault
imageWidthImage widthnumberundefined
imageHeightImage heightnumberundefined
productProduct objectobjectundefined
wrapperClassNameThe class name of the item that wraps the imagestringundefined
imageClassNameThe class name of the image itemstringundefined

SnackBar

<SnackBar />

PickerModal

<PickerModal 
visible={visible}
handleModalVisibility={handleModalVisibility}
title={title}
iconName={iconName}
pickerItems={pickerItems}
onItemPicked={onItemPicked}
containerClassName={containerClassName}
itemsContainerClassName={itemsContainerClassName}
headerContainerClassName={headerContainerClassName}
headerCloseIconClassName={headerCloseIconClassName}
scrollViewClassName={scrollViewClassName}
pickerItemContainerClassName={pickerItemContainerClassName}
pickerItemTextClassName={pickerItemTextClassName}
/>
Properties
PropertyDescriptionTypeDefault
visibleVisibility statusbooleanfalse
handleModalVisibilityThe handler function used to change visibilityFunctionundefined
titleTitle valuestringundefined
iconNameThe name of the close iconstringclose
pickerItemsPicker dataArray
onItemPickedThe method triggered when selecting an itemFunctionDefault
containerClassNameContainer class namestring'components.pickerModal.modal'
itemsContainerClassNameThe class name that wraps the itemsstring'components.pickerModal.modalItemsContainer'
headerContainerClassNameHeader class namestring'components.pickerModal.modalHeaderContainer'
headerCloseIconClassNameThe class name of the icon used for closingstring'components.pickerModal.modalHeaderCloseIcon'
scrollViewClassNameThe class name used for Scrollviewstring'components.pickerModal.scrollView'
pickerItemContainerClassNameThe container class name of the itemsstring'components.pickerModal.pickerItemContainer'
pickerItemTextClassNameThe class name of the text values of the itemsstring'components.pickerModal.pickerItemText'

ProductDetail

Modals / AddedToCartModal

<AddedToCartModal
visible={visible}
{...restProps}
>



</AddedToCartModal>
Properties
PropertyDescriptionTypeDefault
visibleModal visibilitybooleanundefined
…restPropsThe props to be transferred to child componentsundefined
ModalBasketButton
<AddedToCartModalBasketButton
navigation={navigation}
hideModal={hideModal}
/>
Properties
PropertyDescriptionTypeDefault
navigationModal visibilitybooleanundefined
hideModalThe function used to close the modalFunctionundefined
ModalCloseButton
<AddedToCartModalCloseButton
visible={visible}
decorationLine={decorationLine}
/>
Properties
PropertyDescriptionTypeDefault
decorationLineThe decoration value of the text used to close the modalstringundefined
hideModalThe function used to close the modalFunctionundefined
ModalInfo
<AddedToCartModalInfo
product={product}
quantity={quantity}
/>
Properties
PropertyDescriptionTypeDefault
quantityQuantitybooleanundefined
productProduct objectobjectundefined
ModalTitle
<AddedToCartModalTitle />

Modals /

QuickAddToCart
<QuickAddToCart
validation={validation}
product={product}
validationReset={validationReset}
onVariantSelection={onVariantSelection}
isEnable={isEnable}
navigation={navigation}
colorVariantOptions={colorVariantOptions}
modalVariantOptions={modalVariantOptions}
modalVariantDrawerOptions={modalVariantDrawerOptions}
/>
Properties
PropertyDescriptionTypeDefault
validationValidation objectobjectundefined
productProduct objectobjectundefined
validationResetThe function sent to reset the validation valuesFunctionundefined
onVariantSelectionThe method triggered when selecting variantsFunctionundefined
isEnableActivity statusbooleanundefined
navigationNavigation objectobjectundefined
colorVariantOptionsColor variant settingsobjectundefined
modalVariantOptionsModal variant settingsobjectundefined
modalVariantDrawerOptionsModal drawer settingsobjectundefined
ContentDrawer
<ContentDrawer
data={data}
variantSelection={variantSelection}
status={status}
closeModal={closeModal}
options={options}
/>
Properties
PropertyDescriptionTypeDefault
dataContent dataobject{ }
variantSelectionThe method triggered when selecting variantsFunction() => { }
statusStatus valueundefined
closeModalThe function used to close the modalFunction() => { }
optionsConfig objectobjectundefined
ErrorModal
<ErrorModal
errorModal={errorModal}
onRequestClose={onRequestClose}
error={status}
/>
Properties
PropertyDescriptionTypeDefault
errorModalModal valuebooleanundefined
onRequestCloseThe method triggered when closingFunction() => { }
errorError messagestringundefined
ProductAddedToBasketModal
<ProductAddedToBasketModal
dispatch={dispatch}
hideAction={hideAction}
quantity={quantity}
navigation={navigation}
product={product}
visible={visible}
/>
Properties
PropertyDescriptionTypeDefault
dispatchRedux dispatch functionFunctionundefined
hideActionThe method triggered when closingFunctionundefined
quantityQuantity objectobjectundefined
navigationNavigation objectobjectundefined
productProduct objectobjectundefined
visibleVisibility valuebooleanundefined
ProductAddedToFavouriteModal
<ProductAddedToFavouriteModal
dispatch={dispatch}
hideAction={hideAction}
navigation={navigation}
product={product}
visible={visible}
/>
Properties
PropertyDescriptionTypeDefault
dispatchRedux dispatch functionFunctionundefined
hideActionThe method triggered when closingFunctionundefined
navigationNavigation objectobjectundefined
productProduct objectobjectundefined
visibleVisibility valuebooleanundefined
ProductValidationModal
<ProductValidationModal
validation={validation}
validationReset={validationReset}
isEnable={isEnable}
/>
Properties
PropertyDescriptionTypeDefault
validationValidation objectobjectundefined
validationResetThe function sent to reset the validation valuesFunctionundefined
isEnableActivity statusbooleanfalse

Variants /

Variants
<Variants
variants={variants}
status={status}
product={product}
navigation={navigation}
onSelect={onSelect}
colorVariantOptions={colorVariantOptions}
modalVariantOptions={modalVariantOptions}
modalVariantDrawerOptions={modalVariantDrawerOptions}
/>
Properties
PropertyDescriptionTypeDefault
variantsVariant dataArrayundefined
statusStatus valueobjectundefined
productProduct objectFunctionundefined
navigationNavigation objectobjectundefined
onSelectThe method triggered when selecting variantsFunctionundefined
colorVariantOptionsColor variant settingsobjectundefined
modalVariantOptionsModal variant settingsobjectundefined
modalVariantDrawerOptionsModal drawer settingsobjectundefined

AddToCartButton

<AddToCartButton
product={product}
pending={pending}
onPress={onPress}
/>
Properties
PropertyDescriptionTypeDefault
productProduct objectobjectundefined
pendingPending statusbooleanundefined
onPressPress eventFunctionundefined

FavouriteButton

<FavouriteButton
favourite={favourite}
product={product}
removeFromFavouriteHandler={removeFromFavouriteHandler}
addToFavouriteHandler={addToFavouriteHandler}
navigation={navigation}
isLogin={isLogin}
pending={pending}
favouritePending={favouritePending}
/>
Properties
PropertyDescriptionTypeDefault
favoriteFavorite objectobjectundefined
productProduct objectobjectundefined
pendingPending statusbooleanundefined
removeFromFavouriteHandlerThe method triggered when removing from favoritesFunctionundefined
addToFavouriteHandlerThe method triggered when adding to favoritesFunctionundefined
navigationNavigation objectobjectundefined
isLoginLogin statusbooleanundefined
pendingPending statusbooleanundefined
favouritePendingThe pending status for favoritesbooleanundefined

NoStockInfo

<NoStockInfo product={product} />
Properties
PropertyDescriptionTypeDefault
productProduct objectobjectundefined

ProductBrand

<ProductBrand product={product} />
Properties
PropertyDescriptionTypeDefault
productProduct objectobjectundefined

ProductPrice

<ProductPrice 
product={product}
containerClassName={containerClassName}
contentClassName={contentClassName}
/>
Properties
PropertyDescriptionTypeDefault
productProduct objectobjectundefined
containerClassNameThe class name of the containerstring"productDetail.productPrice.priceContainer"
contentClassNameThe class name of the price itemstring"productDetail.productPrice.priceContent"

ProductRetailPrice

<ProductRetailPrice 
product={product}
containerClassName={containerClassName}
contentClassName={contentClassName}
/>
Properties
PropertyDescriptionTypeDefault
productProduct objectobjectundefined
containerClassNameThe class name of the containerstring"productDetail.productPrice.priceContainer"
contentClassNameThe class name of the price itemstring"productDetail.productPrice.priceContent"

ProductSKU

<ProductSku product={product} />
Properties
PropertyDescriptionTypeDefault
productProduct objectobjectundefined

ProductTitle

<ProductTitle product={product} />
Properties
PropertyDescriptionTypeDefault
productProduct objectobjectundefined

QuantityButtons

<QuantityButtons 
product={product}
onPress={onPress}
quantity={quantity}
/>
Properties
PropertyDescriptionTypeDefault
productProduct objectobjectundefined
onPressPress eventFunctionundefined
quantityQuantity objectobjectundefined

ShareButton

<ShareButton route={route} />
Properties
PropertyDescriptionTypeDefault
routeRoute objectobjectundefined

ProductList

<ProductList
items={items}
navigation={navigation}
itemTemplate={itemTemplate}
handleEndReached={handleEndReached}
onRefresh={onRefresh}
scrollToTop={scrollToTop}
numberOfColumns={numberOfColumns}
containerClassName={containerClassName}
contentContainerClassName={contentContainerClassName}
scrollToTopIconName={scrollToTopIconName}
scrollToTopButtonClassName={scrollToTopButtonClassName}
scrollToTopIconClassName={scrollToTopIconClassName}
ListEmptyComponent={ListEmptyComponent}
ListHeaderComponent={ListHeaderComponent}
ListFooterComponent={ListFooterComponent}
/>

Properties

PropertyDescriptionTypeDefault
itemsList dataArrayundefined
navigationNavigation objectobjectundefined
itemTemplateThe data component to be listedReact.Componentundefined
handleEndReachedThe method triggered when reaching the end of the listFunctionundefined
onRefreshThe method triggered when refreshing the listFunctionundefined
scrollToTopThe control value to scroll to the top of the listbooleanfalse
numberOfColumnsNumber of data columnsnumber2
containerClassNameThe class name of the list containerstring‘ ‘
contentContainerClassNameThe class name of the data containerstring‘ ‘
scrollToTopIconNameThe name of the Scroll to Top iconstring‘up-arrow’
scrollToTopButtonClassNameThe class name of the Scroll to Top buttonstring‘ ‘
scrollToTopIconClassNameThe class name of the Scroll to Top iconstring‘ ‘
ListEmptyComponentEmpty list componentReact.Componentnull
ListHeaderComponentThe header component of the listReact.Componentnull
ListFooterComponentThe footer component of the listReact.Componentnull

Promotion

<Promotion content={content} />

Properties

PropertyDescriptionTypeDefault
contentThe content data placed within the componentFunctionundefined
<Search 
navigation={navigation}
route={route}
barcodeVisible={content}
/>

Properties

PropertyDescriptionTypeDefault
routeRoute objectobjectundefined
navigationNavigation objectobjectundefined
barcodeVisibleThe visibility value of the barcode scan optionbooleanundefined

SignIn /

AppleSignIn
<AppleSignIn login={login} />
Properties
PropertyDescriptionTypeDefault
loginLogin eventFunctionundefined
FacebookSignIn
<FacebookSignIn login={login} />
Properties
PropertyDescriptionTypeDefault
loginLogin eventFunctionundefined
SignInWithFaceId
<SignInWithFaceId login={login} />
Properties
PropertyDescriptionTypeDefault
loginLogin eventFunctionundefined

UnsupportedModule

<UnsupportedModule moduleName={moduleName} />

Properties

PropertyDescriptionTypeDefault
moduleNameThe name of the unsupported modulestringundefined

Data Containers

Actions

Address

-addressFullFilled

Indicates success to fetch the address from backend Action Type: FETCH_ADDRESS_FULLFILLED

-cityFullFilled

Indicates success to fetch the cities list information from backend Action Type: FETCH_ADDRESS_CITY_FULLFILLED

-townshipFullFilled

Indicates success to fetch the townships list information from backend Action Type: FETCH_ADDRESS_TOWNSHIP_FULLFILLED

-districtFullFilled

Indicates success to fetch the district list information from backend Action Type: FETCH_ADDRESS_DISTRICT_FULLFILLED

-fetchAddressRejected

Indicates error to fetch the cities list information from backend Action Type: FETCH_ADDRESS_REJECTED

-rejected

Indicates error in communication with backend Action Type: ADDRESS_REJECTED

-pending

Indicates that the result of communication with backend is pending Action Type: FETCH_ADDRESS_PENDING

-success

Indicates success for address processes Action Type: ADDRESS_SUCCESS

-setClearState

Updates the success and pending values within the state to default values Action Type: CLEAR_STATE

-countryAction

Indicates success to fetch the countries list information from backend Action Type: FETCH_ADDRESS_COUNTRY_FULFILLED

-cityAction

Sends a request to backend for the cities list and submits the response to the cityFullFilled action

-townshipAction

Sends a request to backend for the townships list and submits the response to the townshipFullFilled action

-districtAction

Sends a request to backend for the districts list and submits the response to the districtFullFilled action

- addressChanged

Indicates that the address information is changed Action Type: ADDRESS_CHANGED

-clearState

Dispatches the setClearState action to update the success and pending values within the state to default values

-initialAddressState

Dispatches the methods cityAction, townshipAction, and districtAction actions in that order

-selectAddress

Sets the selected address as default address

-sendAddress

Adds a new address

-removeAddress

Removes the selected address

-fetchAddress

Sends a request to backend for the addresses list and dispatches the related actions

-fetchCountry

Dispatches the countryAction action

-fetchCity
dispatch(this.actionRunner([this.cityAction()], _OVERWRITE));
-fetchTownship
dispatch(this.actionRunner([this.townshipAction(cityId)], _OVERWRITE));
-fetchDistrict
dispatch(this.actionRunner([this.districtAction(townshipId)]));

Auth

-currentUserFulfilled

Indicates success to fetch the data of the currently logged-in user Action Type: FETCH_CURRENT_USER_FULFILLED_FOR_INDEX

-currentUserFulfilledLogin

Indicates success to fetch the data of the currently logged-in user Action Type: FETCH_CURRENT_USER_FULFILLED_FOR_LOGIN

-rejected

Indicates error in communication with backend Action Type: FETCH_AUTH_REJECTED

-pending

Indicates that the result of communication with backend is pending Action Type: FETCH_AUTH_PENDING

-loginSuccess

Indicates success for user login Action Type: LOGIN_SUCCESS

-loginSuccessFulfilled

Indicates success for user login Action Type: LOGIN_SUCCESS_FULFILLED

-passwordFulfilled

Indicates success for password reset Action Type: SET_PASSWORD_FORM

-passwordFormRejected

Indicates error for password reset Action Type: PASSWORD_FORM_REJECTED

-passwordFormPending

Indicates that the process of password reset is pending Action Type: PASSWORD_FORM_PENDING

-clearAuthState

Sets the authentication state to default state Action Type: CLEAR_AUTH_STATE

-logoutPending

Indicates that the process of user logout is pending Action Type: LOGOUT_PENDING

-logoutRejected

Indicates error for user logout Action Type: LOGOUT_REJECTED

-getCsrf

Retrieves the CSRF Token from backend

-getCurrentUser

Retrieves the current user from backend

-getCurrentUserForLogin

Retrieves the current user from backend

-faceIdHandler

Handles login with FaceId

-login

Handles login with password

-facebookLogin

Handles login with Facebook

-appleLogin

Handles login with Apple

-passwordInitialState

Sets the forgot my password form values to default values

-setPasswordForm

Sends a request to backend for password reset

-logOut

Sends a request to backend for user logout

Basket

-fulfilled

Indicates success to fetch the cart content from backend Action Type: FETCH_BASKET_FULFILLED

-fulfilledToUpdate

Updates the cart when a change is made and fetches a response parameter. This action is dispatched in the setQuantity and addToCart actions.

Action Type: FETCH_BASKET_FULFILLED + _TO_UPDATE

-rejected

Indicates error to fetch the cart content from backend

Action Type: FETCH_BASKET_REJECTED

-pending

Indicates that the process of fetching the cart content from backend is pending

Action Type: FETCH_BASKET_PENDING

-fulfilledDiscount

Sets the discount applied to cart and fetches a response parameter

Action Type: FETCH_BASKET_DISCOUNT

-productAddedModal

Displays the product added to cart modal

Action Type: PRODUCT_ADDED_MODAL_SHOW

-productAddedModalHide

Hides the product added to cart modal

Action Type: PRODUCT_ADDED_MODAL_HIDE

-addToCartRejected

Indicates error to add product to cart

Action Type: ADD_TO_CART_REJECTED

-addedToCartFullFilled

Indicates success to add product to cart

Action Type: ADDED_TO_CART_FULFILLED

-handledUpdate

Updates the isUpdate field within the state as false

Action Type: HANDLED_UPDATE

-clearError

Hides the error message

Action Type: CLEAR_ERROR

-cleanBasket

Clears the cart

Action Type: CLEAN_BASKET

-pendingFavouriteStatus

Indicates that the process of fetching the favorite products content is pending

Action Type: BASKET_FETCH_FAVOURITE_STATUS_PENDING

-fulfilledFavouriteStatus

Indicates success to fetch the favorite products content

Action Type: BASKET_FETCH_FAVOURITE_STATUS_FULFILLED

-rejectedFavouriteStatus

Indicates error to fetch the favorite products content

Action Type: BASKET_FETCH_FAVOURITE_STATUS_REJECTED

-fulfilledAddToFavourite

Indicates success to add the product to favorites

Action Type: BASKET_ADD_TO_FAVOURITE_FULFILLED

-rejectedAddToFavourite

Indicates error to add the product to favorites

Action Type: BASKET_ADD_TO_FAVOURITE_REJECTED

-setQuantity

Updates the quantity of products in the cart

-addToCart

Adds product to cart

-setDiscount

Applies discount

-fetchBasket

Fetches the cart content

-setGiftNote

Adds gift note

-removeGiftNote

Removes gift note

-fetchFavouriteStatus

Fetches the favorite status of the products in cart from backend

-addToFavourite

Adds product to favorites

Checkout

-loginFulfilled

Indicates success for guest login and fetches a response parameter

Action Type: GUEST_LOGIN_FULFILLED

-checkoutFulfilled

Indicates success for checkout

Action Type: CHECKOUT_FULFILLED

-pending

Indicates that the process of checkout is pending

Action Type: FETCH_CHECKOUT_PENDING

-rejected

Indicates error to fetch the checkout data

Action Type: CHECKOUT_REJECTED

-loginRejected

Indicates error for guest login and fetches a error parameter

Action Type: CHECKOUT_GUEST_LOGIN_REJECTED

-getState

Fetches the initial values of the checkout state

Action Type: CHECKOUT_GUEST_LOGIN_INITIAL_STATE

-fetchCheckout

Fetches checkout

-guestLogin

Fetches guest login

-initialState

Reloads the initial values of the state

Combine Detail

-fulfilled

Fetches combined products from backend and fetches a response parameter

Action Type: FETCH_COMBINE_DETAIL_FULFILLED

-pending

Indicates that the process of fetching combined products from backend is pending

Action Type: FETCH_CHECKOUT_PENDING

-rejected

Indicates error to fetch the combined products from backend and fetches an error parameter

Action Type: CHECKOUT_REJECTED

-fetchProduct

Fetches the related product from backend

-getInitialProduct

Fetches the main product from backend

Contact

-contactUsFulfilled

Contact successful

Action Type: CONTACT_FULFILLED

-subjectsFulfilled

Indicates success to fetch contact subjects from backend

Action Type: FETCH_CONTACT_SUBJECTS

-rejected

Indicates error to fetch contact subjects from backend

Action Type: FETCH_CONTACT_SUBJECTS

-pending

Indicates that the process of sending contact form to backend is pending

Action Type: CONTACT_PENDING

-setContactForm

Sends the contact form to backend

-fetchContactSubjects

Fetches contact subjects from backend

Coupons

-basketOffersFulFilled

Fetches active vouchers from backend and fetches a response parameter

Action Type: FETCH_BASKET_OFFERS

-discountItemsFulFilled

Fetches discount products from backend and fetches a response parameter

Action Type: FETCH_DISCOUNT_ITEMS

-expiredOffersFulFilled

Fetches expired vouchers from backend and fetches a response parameter

Action Type: FETCH_EXPIRED_BASKET_OFFERS

-futureBasketOffersFulFilled

Fetches future vouchers from backend and fetches a response parameter

Action Type: FETCH_FUTURE_BASKET_OFFERS

-basketOffersActions

Fetches active vouchers from backend

-discountItemsActions

Fetches discount products from backend

-expiredOffersActions

Fetches expired vouchers from backend

-futureOffersActions

Fetches future vouchers from backend

-pending

Indicates that the process of loading all vouchers is pending

Action Type: FETCH_COUPONS_PENDING

-rejected

Indicates error to fetch the vouchers from backend

Action Type: FETCH_COUPONS_REJECTED

-fulfilled

Indicates success to fetch the vouchers from backend

Action Type: FETCH_COUPONS_FULFILLED

-fetchCoupons

Fetches the vouchers from backend

Favourite List

-fulfilled

Indicates success to fetch the favorites list from backend

Action Type: FETCH_FAVOURITE_FULFILLED

-rejected

Indicates error to fetch the favorites list from backend

Action Type: FETCH_FAVOURITE_REJECTED

-pending

Indicates that the process of fetching the favorites list from backend is pending

Action Type: FETCH_FAVOURITE_PENDING

-fulfilledRemoveProduct

Indicates success to remove a product from the favorites list

Action Type: FL_REMOVE_FROM_FAVOURITE_FULFILLED

-rejectedRemoveProduct

Indicates error to remove a product from the favorites list

Action Type: FL_REMOVE_FROM_FAVOURITE_REJECTED

-clearError

Clears the error message

Action Type: CLEAR_ERROR

-fetchFavourites

Fetches the favorites list from backend

-getInfiniteFavourites

Fetches the favorites list from backend

-getInitialFavourites

Fetches the favorites list from backend

-removeFromFavourite

Removes a product from the favorites list

-refreshFavorites

Re-fetches the favorites list from backend

Map Marker

-fullfilled

Indicates success to fetch the markers list from backend and writes the result in the state

Action Type: FETCH_MARKER_FULLFILLED

-rejected

Indicates error to fetch the markers list from backend

Action Type: FETCH_MARKER_REJECTED

-pending

Indicates that the process of fetch the markers list from backend is pending

Action Type: FETCH_MARKER_PENDING

-fetchMarkers

Fetches the markers list from backend

-fullFilled

Indicates success to fetch the menu list from backend and writes the result in the state

Action Type: FETCH_MENU_FULLFILLED

-rejected

Indicates error to fetch the menu list from backend

Action Type: FETCH_MENU_REJECTED

-pending

Indicates that the process of fetch the menu list from backend is pending

Action Type: FETCH_MENU_PENDING

-fetchMenu

Fetches the menu list from backend

Product Detail

-fulfilled

Indicates success to fetch the product’s detail data from backend and writes the result in the state

Action Type: FETCH_PRODUCT_DETAIL_FULFILLED

-rejected

Indicates error to fetch the product’s detail data from backend and writes the result in the state

Action Type: FETCH_PRODUCT_DETAIL_REJECTED

-pending

Indicates that the process of fetching the product’s detail data from backend is pending

Action Type: FETCH_PRODUCT_DETAIL_PENDING

-clear

Resets the product detail state

Action Type: CLEAR_PRODUCT_DETAIL

-fulfilledFavouriteStatus

Indicates success to fetch the favorite status of the product’s detail data from backend and writes the result in the state

Action Type: PD_FETCH_FAVOURITE_STATUS_FULFILLED

-rejectedFavouriteStatus

Indicates error to fetch the favorite status of the product’s detail data from backend and writes the result in the state

Action Type: PD_FETCH_FAVOURITE_STATUS_REJECTED

-fulfilledAddProduct

Indicates success to add the product to favorites and writes the result in the state

Action Type: PD_ADD_TO_FAVOURITE_FULFILLED

-rejectedAddToFavourite

Indicates error to add the product to favorites and writes the result in the state

Action Type: PD_ADD_TO_FAVOURITE_REJECTED

-fulfilledRemoveProduct

Indicates success to remove the product from favorites and writes the result in the state

Action Type: PD_REMOVE_FROM_FAVOURITE_FULFILLED

-rejectedRemoveProduct

Indicates error to remove the product from favorites and writes the result in the state

Action Type: PD_REMOVE_FROM_FAVOURITE_REJECTED

-rejectedVariantValidation

Indicates error to select product variant and writes the result in the state

Action Type: VARIANT_VALIDATION_REJECTED

-resetVariantValidation

Resets the errors occurred during variant validation

Action Type: VARIANT_VALIDATION_RESET

-pendingFavouriteStatus

Indicates that the process of communication with backend is pending while adding to/removing from favorites

Action Type: PD_FETCH_FAVOURITE_STATUS_PENDING

-clearFavouriteStatus

Indicates the clearing of favorite status and updates the state

Action Type: PD_CLEAR_FAVOURITE_STATUS

-clearFavouriteError

Indicates the clearing of errors occurred while updating favorites and updates the state

Action Type: PD_CLEAR_FAVOURITE_STATUS_ERROR

-fetchFavouriteStatus

Fetches the product’s favorite status from backend

-fetchProduct

Fetches the product from backend

-buildQueryParam

Creates the appropriate query string parameters to fetch the product from backend

-setVariant

Updates variant selections

-getInitialProduct

Fetches the main product data from backend

-addToFavourite

Adds the product to favorites

-removeFromFavourite

Removes the product from favorites

-variantValidation

Confirms variant selections

-resetValidation

Clears the errors occurred while selecting variants

User Settings

Email
-fulfilled

Indicates success to update email

Action Type: SEND_EMAIL_FORM

-rejected

Indicates error to update email and writes the result in the state

Action Type: SEND_EMAIL_FORM_REJECTED

-pending

Indicates that the process of communication with backend is pending while updating email

Action Type: SEND_EMAIL_FORM_PENDING

-getState

Indicates the initial state data of the reducer

Action Type: EMAIL_INITIAL_STATE

-initialState

The action that updates the reducer state to the initial state

-sendEmailForm

Used to update user email

Notifications
-fulFilledProfile

Indicates success to fetch/update the user profile information from backend and writes the result in the state

Action Type: FETCH_PROFILE

-rejected

Indicates success to fetch/update the profile data from/in backend and writes the result in the state

Action Type: FETCH_NOTIFICATIONS_REJECTED

-pending

Indicates that the process of communication with backend is pending while fetching/updating profile data

Action Type: FETCH_NOTIFICATIONS_PENDING

-fetchProfile

Used to fetch the user’s profile data from backend

-setProfile

Used to update the user’s profile data in backend

Password
-fulFilledProfile

Indicates success to update user password in backend and writes the result in the state

Action Type: SEND_PASSWORD_FORM

-rejected

Indicates error to update user password in backend and writes the result in the state

Action Type: SEND_PASSWORD_FORM_REJECTED

-pending

Indicates that the process of communication with backend is pending while updating the user’s password data

Action Type: SEND_PASSWORD_FORM_PENDING

-getState

Indicates the initial state data of the reducer

Action Type: PASSWORD_INITIAL_STATE

-initialState

The action that updates the reducer state to the initial state

-sendPasswordForm

Used to update the user’s password data in backend

Profile
-profileFulfilled

Indicates success to update the profile data in backend and writes the result in the state

Action Type: SET_PROFILE

-fetchProfileFulfilled

Indicates success to fetch the profile data from backend

Action Type: FETCH_PROFILE

-rejected

Indicates error to fetch/update the profile data or for SMS verification and writes the error in the state

Action Type: PROFILE_REJECTED

-pending

Indicates that the process of communication with backend is pending while updating/fetching the profile data in/from backend

Action Type: PROFILE_PENDING

-resetProfile

Used to reset the initial state data in the reducer

Action Type: RESET_PROFILE

-showSmsVerificationForm

Used to display the SMS verification modal

Action Type: PROFILE_SMS_VERIFICATION_FORM_SHOW

-hideSmsVerificationForm

Used to hide the SMS verification modal

Action Type: PROFILE_SMS_VERIFICATION_FORM_HIDE

-setProfileForm

Updates the user’s profile data in backend

-resendSms

Used to resend SMS for phone verification

-fetchProfile

Fetches the user’s profile data from backend

Web Checkout

-opened

Indicates the opening of the checkout page

Action Type: WEB_CHECKOUT_OPENED

-complete

Indicates the finalization of checkout

Action Type: COMPLETE_ORDER

-getUrl

Indicates the URL of successful checkout

Action Type: WEB_CHECKOUT_URL

-checkoutPending

Indicates that the process of fetching the complete checkout data from backend is pending

Action Type: FETCH_CHECKOUT_COMPLETED_PENDING

-checkoutCompleted

Indicates success to fetch the complete checkout data from backend

Action Type: FETCH_CHECKOUT_COMPLETED_SUCCESS

-checkoutRejected

Indicates error to fetch the complete checkout data from backend

Action Type: FETCH_CHECKOUT_COMPLETED_REJECTED

-firstPurchaseOrdered

Indicates the user’s first purchase

Action Type: FIRST_PURCHASE_ORDERED

-getCheckoutCompleted

Fetches the complete checkout data from backend

-webCheckoutOpened

Indicates the opening of the checkout page

-checkoutSuccess

Indicates the finalization of checkout

-handleFirstPurchase

Indicates the user’s first purchase

Widgets

-fulfilled

Indicates success to fetch the widget data from backend and to write the result in the state

Action Type: FETCH_WIDGETS_FULFILLED

-rejected

Indicates error to fetch the widget data from backend and writes the error in the state

Action Type: FETCH_WIDGETS_REJECTED

-pending

Indicates that the fetching of the widget data from backend is pending

Action Type: FETCH_WIDGETS_PENDING

-promotionView

Indicates the display of a promotion item in analytics events

Action Type: PROMOTION_VIEW

-promotionImpression

Indicates the clicking of a promotion item in analytics events

Action Type: PROMOTION_IMPRESSION

-fetchWidgets

Fetches the widget data from backend

Product List

-fulfilled

Indicates success to fetch the product list data from backend and to write the result in the state

Action Type: FETCH_PRODUCT_LIST_FULFILLED

-rejected

Indicates error to fetch the product list data from backend and writes the error in the state

Action Type: FETCH_PRODUCT_LIST_REJECTED

-pending

Indicates that the fetching of the product list data from backend is pending

Action Type: FETCH_PRODUCT_LIST_PENDING

-setFilter

Saves the applied filter into the state

Action Type: SET_FILTER

-setActiveRoute

Fetches a route data, and saves the active route into the state

Action Type: SET_ACTIVE_ROUTE

-setUrl

Fetches a URL data, and saves the URL into the state

Action Type: SET_URL

-setSort

Fetches a sorter data, and saves the sorter into the state

Action Type: SET_SORTER

-setPagination

Fetches a route data, and saves the active route into the state

Action Type: SET_PAGINATION

-setPagination

Fetches a route data, and saves the active route into the state

Action Type: SET_PAGINATION

-fulfilledFavouriteStatus

Fetches the favorite status of products, and saves it into the state

Action Type: PL_FETCH_FAVOURITE_STATUS_FULFILLED

-rejectedFavouriteStatus

Indicates error to fetch the favorite status of products from backend, and saves the error into the state

Action Type: PL_FETCH_FAVOURITE_STATUS_REJECTED

-pendingFavouriteStatus

Indicates that the fetching of the favorite status of products from backend is pending

Action Type: PL_FETCH_FAVOURITE_STATUS_PENDING

-fulfilledAddProduct

Adds the product to the favorites list

Action Type: PL_ADD_TO_FAVOURITE_FULFILLED

-rejectedAddToFavourite

Indicates error to add the product to the favorites list, and saves the error into the state

Action Type: PL_ADD_TO_FAVOURITE_REJECTED

-resetError

Resets error status

Action Type: RESET_PRODUCT_LIST_REJECTED

-fulfilledRemoveProduct

Removes the product from the favorites list

Action Type: PL_REMOVE_FROM_FAVOURITE_FULFILLED

-rejectedRemoveProduct

Indicates error to remove the product from the favorites list, and saves the error into the state

Action Type: PL_REMOVE_FROM_FAVOURITE_REJECTED

-clearFavouriteError

Clears the error for the favorite status

Action Type: PL_CLEAR_FAVOURITE_STATUS_ERROR

-getProducts

Fetches the products from backend

-getQueryString

Creates the appropriate query string parameters to fetch the products from backend

-fetchProducts

Fetches the products from backend

-selectFacet

Used to select filtering type

-removeFilter

Removes the filter on the product list

-getInfiniteProducts

Fetches the product list from backend while scrolling

-setSorter

Applies the product list sorting, and fetches the product list from backend accordingly

-setFilter

Applies the product list filter, and fetches the product list from backend accordingly

-selectFilter

Used to select filtering type

-getInitialProducts

Fetches the product list from backend when the page is initially loaded

-fetchFavouriteStatus

Fetches the favorite status of products from backend

-addToFavourite

Adds the product to the favorites list

-removeFromFavourite

Removes the product from the favorites list

-refreshProduct

Re-fetches the product list from backend

Orders

-getState

Sets orders initial state

Action Type: ORDER_INITIAL_STATE

-getStateRefund

Sets refund initial state

Action Type: REFUND_INITIAL_STATE

-pending

Shows the result is pending when a network request is made for orders

Action Type: FETCH_ORDERS_PENDING

-pendingOrderDetail

Shows the result is pending when a network request is made for orderDetail

Action Type: FETCH_ORDERS_DETAIL_PENDING

-pendingRefund

Shows the result is pending when a network request is made for refund

Action Type: FETCH_REFUNDS_PENDING

-fulFilled

Indicates success to fetch the orders data with a network request and to set the data. Fetches the response parameter as data

Action Type: FETCH_ORDERS_FULFILLED

-fulFilledOrderDetail

Indicates success to fetch the orderDetail data with a network request and to set the data. Fetches the response parameter as data

Action Type: FETCH_ORDERS_DETAIL_FULFILLED

-fulFilledRefund

Indicates success to fetch the refund data with a network request and to set the data. Fetches the response parameter as data

Action Type: FETCH_ORDERS_DETAIL_FULFILLED

-rejected

Indicates error for network request while fetching data for orders. Fetches the error parameter

Action Type: FETCH_ORDERS_REJECTED

-rejectedOrderDetail

Indicates error for network request while fetching data for orderDetail. Fetches the error parameter

Action Type: FETCH_ORDERS_DETAIL_REJECTED

-rejectedRefund

Indicates error for network request while fetching data for Refund. Fetches the error parameter

Action Type: FETCH_REFUNDS_REJECTED

-fulFilledCancellationReasons

Indicates success to fetch the reasons for cancelation data with a network request and to set the data. Fetches the response parameter as data

Action Type: FETCH_CANCELLATION_REASONS

-orderItemCancellationRequest

Used to write order items and reason for cancelation when an order is canceled. Fetches the orderItemsId and reason parameters

Action Type: CANCELLATION_REQUEST

-cancelRejected

Indicates error for network request while canceling an order. Fetches the error parameter

Action Type: CANCELLATION_REQUEST_REJECTED

-pendingReason

Shows the result is pending when a network request is fetched for reasons for cancelation

Action Type: FETCH_CANCELLATION_REASONS_PENDING

-initialState

Sets orders initial state. Dispatches getState

-initialStateRefund

Sets refund initial state. Dispatches getStateRefund

-changeOrderAdress

Updates the address selected by the user by posting it with a network request. Dispatches { type: CHANGE_ORDER_ADRESS_SUCCEED } if success, and { type: CHANGE_ORDER_ADRESS_FAIL, err } if fail changeOrderAdress = ({ order, adress, order_adress_types })...

changeOrderAdress = ({ order, adress, order_adress_types })...
-fetchOrders

Fetches orders data with a network request. Dispatches the actions fulFilled if success, and rejected if fail. seperatorType (_AS_INFINITE, this parameter is fetched when orders are to be fetched with infinite scroll) and fetches pageNumber as a parameter

fetchOrders = (separatorType = '', pageNumber)...
-fetchRefunds

Fetches refunds data with a network request. Dispatches the actions fulFilledRefund if success, and rejectedRefund if fail. seperatorType (_AS_INFINITE, this parameter is fetched when orders are to be fetched with infinite scroll) and fetches pageNumber as a parameter

fetchRefunds = (separatorType = '', pageNumber)...
-fetchOrderDetail

This action is dispatched when an order detail is to be seen from within the orders data. Fetches the orderId parameter, and the order detail data with a network request. Dispatches the actions fulFilledOrderDetail if success, and rejectedOrderDetail if fail

-fetchCancellationReason

Fetches reasons for cancelation while canceling an order with a network request. Dispatches the actions fulFilledCancellationReason if success, and rejected if fail

-searchOrder

Fetches orders with a network request using order number. Dispatches the actions fulFilled if success, and rejected if fail

-postCancelForm

Posts order items (orderItems), order number (orderNumber), and order ID (orderId) with a network request when canceling an order. Dispatches the actions orderItemCancellationRequest and fetchOrderDetail if success, and cancelRejected if fail

postCancelForm = (orderItems, orderNumber, orderId)...
-itemSelect

If selected product refund is active when canceling an order or making a refund, this action is patched with the id(product ID) and val (bool) values after products are selected.

Action Type: SELECT_ITEM

-reasonSelect

Sets the reason and id (product ID) parameters after reason for cancelation is selected when canceling an order or making a refund

Action Type: SELECT_REASON

-reasonOnChange

Sets the text and id (product ID) parameters after reason for cancelation is selected when canceling an order or making a refund

Actipn Type: ON_CHANGE_REASON

-selectItem

Dispatches itemSelect by fetching the id and val parameters

-selectReason

Dispatches reasonSelect by fetching the reason and val parameters

-onChangeReason

Dispatches reasonOnChange by fetching the text and id parameters

OldOrders

-getStateOldOrder

Sets oldOrders initial stats.

Action Type: OLD_ORDERS_INITIAL_STATE

-pendingOldOrderDetail

Shows the result is pending when a network request is made for OldOrderDetail

Action Type: FETCH_OLD_ORDERS_DETAIL_PENDING

-pendingOldOrder

Shows the result is pending when a network request is made for OldOrders

Action Type: FETCH_OLD_ORDERS_PENDING

-fulFilledOldOrderDetail

Indicates success to fetch the oldOrderDetail data with a network request and to set the data. Fetches the response parameter as data

Action Type: FETCH_OLD_ORDERS_DETAIL_FULFILLED

-fullFilledOldOrder

Indicates success to fetch the oldOrders data with a network request and to set the data. Fetches the response parameter as data

Action Type: FETCH_OLD_ORDERS_FULFILLED

-rejectedOldOrderDetail

Indicates error to fetch the oldOrderDetail data with a network request. Fetches the error parameter

Action Type: FETCH_OLD_ORDERS_DETAIL_REJECTED

-rejectedOldOrder

Indicates error to fetch the oldOrders data with a network request. Fetches the error parameter

Action Type: FETCH_OLD_ORDERS_REJECTED

-initialStateOldOrder

Dispatches getStateOldOrder. Fetches the dispatch function as a parameter

-fetchOldOrders

Fetches oldOrders data with a network request. Dispatches the actions fullFilledOldOrder if success, and rejectedOldOrder if fail. seperatorType (_AS_INFINITE_OLD_ORDERS, this parameter is fetched when orders are to be fetched with infinite scroll) and fetches pageNumber as a parameter

fetchOldOrders = (separatorType = '', pageNumber)
-fetchOldOrderDetail

This action is dispatched when an order detail is to be seen from within the oldOrders data. Fetches the orderId parameter, and the order detail data with a network request. Dispatches the actions fulFilledOldOrderDetail if success, and rejectedOldOrderDetail if fail

Register

-registerCompleted

Indicates the finalization of registration

Action Type: REGISTER_COMPLETED

-rejected

Indicates error during registration. Fetches the error parameter

Action Type: SET_REGISTER_REJECTED

-pending

Indicates that a network request is pending during registration

Action Type: REGISTER_PENDING

-showSmsVerificationForm

Indicates the necessity to show the required form for SMS verification

Action Type: REGISTER_SMS_VERIFICATION_FORM_SHOW

-hideSmsVerificationForm

Indicates the necessity to hide the required form for SMS verification

Action Type: REGISTER_SMS_VERIFICATION_FORM_HIDE

-getCurrentUser

After user registration is successful, the user doesn’t have to relog, and this action is dispatched in the register action to automatically log the user in.

-register

After the registration form is filled out, it’s posted with a network request. Dispatches the actions showSmsVerificationForm if hasSmsVerificationForRegister (platformConfigs/app.json/HAS_SMS_VERIFICATION_FOR_REGISTER) is true and the status code of the response is 202 and hideSmsVerificationForm if it’s 201. After this step, the user successfully logs into the application with getCurrentUser. Dispatches rejected if fails

register = (form, validation)...
-resendSms

This action is dispatched with a network request to resend the SMS code to phone number during the SMS verification form shown to the user with showSmsVerificationForm. This sends a new SMS to the user’s phone.

Search

-fulFilled

Indicates success to fetch the search data with a network request and to set the data. Fetches the data parameter

Action Type: FETCH_SEARCH_FULFILLED

-rejected

Indicates error to fetch the search data with a network request. Fetches the error parameter

Action Type: FETCH_SEARCH_REJECTED

-pending

Indicates that the result of a network request for search is pending

Action Type: FETCH_SEARCH_PENDING

When the user makes a search on the search page, a network request is made with searchText fetched to the action as a parameter. Dispatches fulFilled if success, and rejected if fail

Constants

Address

FETCH_ADDRESS_PENDING FETCH_ADDRESS_REJECTED FETCH_ADDRESS_FULLFILLED FETCH_ADDRESS_CITY_FULLFILLED FETCH_ADDRESS_COUNTRY_FULFILLED FETCH_ADDRESS_TOWNSHIP_FULLFILLED FETCH_ADDRESS_DISTRICT_FULLFILLED _OVERWRITE _AS_INFINITE ADDRESS_SUCCESS CLEAR_STATE ADDRESS_REJECTED CORPORATE INDIVIDUAL ADDRESS_CHANGED

Auth

FETCH_AUTH_REJECTED FETCH_CURRENT_USER_FULFILLED_FOR_INDEX FETCH_CURRENT_USER_FULFILLED_FOR_LOGIN CLEAR_AUTH_STATE FETCH_AUTH_PENDING CLEAR_INDEX_STATE LOGOUT_PENDING LOGOUT_REJECTED LOGIN_SUCCESS LOGIN_SUCCESS_FULFILLED SET_PASSWORD_FORM PASSWORD_FORM_REJECTED PASSWORD_FORM_PENDING FORGOT_PASSWORD_INITIAL_STATE

Basket

FETCH_BASKET_PENDING FETCH_BASKET_REJECTED FETCH_BASKET_FULFILLED FETCH_BASKET_DISCOUNT _TO_UPDATE HANDLED_UPDATE CLEAR_ERROR PRODUCT_ADDED_MODAL_HIDE PRODUCT_ADDED_MODAL_SHOW ADD_TO_CART_REJECTED CLEAN_BASKET BASKET_FETCH_FAVOURITE_STATUS_PENDING BASKET_FETCH_FAVOURITE_STATUS_FULFILLED BASKET_FETCH_FAVOURITE_STATUS_REJECTED BASKET_ADD_TO_FAVOURITE_FULFILLED BASKET_ADD_TO_FAVOURITE_REJECTED ADDED_TO_CART_FULFILLED

Checkout

GUEST_LOGIN_FULFILLED FETCH_CHECKOUT_PENDING CHECKOUT_REJECTED CHECKOUT_FULFILLED CHECKOUT_GUEST_LOGIN_INITIAL_STATE CHECKOUT_GUEST_LOGIN_REJECTED

Combine Detail

FETCH_COMBINE_DETAIL_PENDING FETCH_COMBINE_DETAIL_REJECTED FETCH_COMBINE_DETAIL_FULFILLED

Contact

FETCH_CONTACT_SUBJECTS FETCH_CONTACT_REJECTED CONTACT_FULFILLED CONTACT_PENDING ORDER_FIELD_NAME

Coupons

FETCH_BASKET_OFFERS; FETCH_DISCOUNT_ITEMS FETCH_EXPIRED_BASKET_OFFERS FETCH_FUTURE_BASKET_OFFERS FETCH_COUPONS_PENDING FETCH_COUPONS_REJECTED FETCH_COUPONS_FULFILLED

Favourite List

FETCH_FAVOURITE_PENDING FETCH_FAVOURITE_REJECTED FETCH_FAVOURITE_FULFILLED _AS_INFINITE CLEAR_ERROR FL_REMOVE_FROM_FAVOURITE_REJECTED FL_REMOVE_FROM_FAVOURITE_FULFILLED

Map Marker

FETCH_MARKER_FULLFILLED FETCH_MARKER_REJECTE FETCH_MARKER_PENDIN

FETCH_MENU_PENDING FETCH_MENU_FULLFILLED FETCH_MENU_REJECTED

Product Detail

FETCH_PRODUCT_DETAIL_PENDING FETCH_PRODUCT_DETAIL_REJECTED FETCH_PRODUCT_DETAIL_FULFILLED CLEAR_PRODUCT_DETAIL PD_FETCH_FAVOURITE_STATUS_PENDING PD_FETCH_FAVOURITE_STATUS_FULFILLED PD_FETCH_FAVOURITE_STATUS_REJECTED PD_CLEAR_FAVOURITE_STATUS PD_ADD_TO_FAVOURITE_FULFILLED PD_ADD_TO_FAVOURITE_REJECTED PD_REMOVE_FROM_FAVOURITE_FULFILLED PD_REMOVE_FROM_FAVOURITE_REJECTED PD_CLEAR_FAVOURITE_STATUS_ERROR VARIANT_VALIDATION_RESET VARIANT_VALIDATION_REJECTED

Product List

FETCH_PRODUCT_LIST_PENDING FETCH_PRODUCT_LIST_REJECTED FETCH_PRODUCT_LIST_FULFILLED PL_FETCH_FAVOURITE_STATUS_PENDING PL_FETCH_FAVOURITE_STATUS_FULFILLED PL_FETCH_FAVOURITE_STATUS_REJECTED PL_CLEAR_FAVOURITE_STATUS PL_ADD_TO_FAVOURITE_FULFILLED PL_ADD_TO_FAVOURITE_REJECTED PL_REMOVE_FROM_FAVOURITE_FULFILLED PL_REMOVE_FROM_FAVOURITE_REJECTED PL_CLEAR_FAVOURITE_STATUS_ERROR _AS_INFINITE SELECT_FACET RESET_PRODUCT_LIST_REJECTED SET_FILTER SET_URL SET_PAGINATION SET_SORTER SET_ACTIVE_ROUTE

User Settings

Email

SEND_EMAIL_FORM SEND_EMAIL_FORM_REJECTED SEND_EMAIL_FORM_PENDING EMAIL_INITIAL_STATE

Notifications

FETCH_PROFILE FETCH_NOTIFICATIONS_PENDING FETCH_NOTIFICATIONS_REJECTED

Password

SEND_PASSWORD_FORM SEND_PASSWORD_FORM_REJECTED SEND_PASSWORD_FORM_PENDING PASSWORD_INITIAL_STATE

Profile

SET_PROFILE PROFILE_PENDING PROFILE_REJECTED FETCH_PROFILE RESET_PROFILE PROFILE_SMS_VERIFICATION_FORM_HIDE PROFILE_SMS_VERIFICATION_FORM_SHOW

Web Checkout

WEB_CHECKOUT_OPENED CLEAR_ORDER COMPLETE_ORDER WEB_CHECKOUT_URL FETCH_CHECKOUT_COMPLETED_PENDING FETCH_CHECKOUT_COMPLETED_SUCCESS FETCH_CHECKOUT_COMPLETED_REJECTED FIRST_PURCHASE_ORDERED

Widgets

FETCH_WIDGETS_PENDING FETCH_WIDGETS_REJECTED FETCH_WIDGETS_FULFILLED PROMOTION_VIEW PROMOTION_IMPRESSION

Orders

ORDER_INITIAL_STATE FETCH_ORDERS_PENDING FETCH_ORDERS_FULFILLED FETCH_ORDERS_REJECTED HANDLE_ITEM FETCH_CANCELLATION_REASONS CANCELLATION_REQUEST _AS_INFINITE _FOR_CHECKOUT REFUND_INITIAL_STATE FETCH_REFUNDS_FULFILLED FETCH_REFUNDS_PENDING FETCH_REFUNDS_REJECTED _AS_INFINITE_REFUND FETCH_CANCELLATION_REASONS_PENDING CANCELLATION_REQUEST_REJECTED SELECT_ITEM SELECT_REASON ON_CHANGE_REASON FETCH_ORDERS_DETAIL_PENDING FETCH_ORDERS_DETAIL_FULFILLED FETCH_ORDERS_DETAIL_REJECTED OLD_ORDERS_INITIAL_STATE FETCH_OLD_ORDERS_FULFILLED FETCH_OLD_ORDERS_PENDING FETCH_OLD_ORDERS_REJECTED _AS_INFINITE_OLD_ORDERS FETCH_OLD_ORDERS_DETAIL_PENDING FETCH_OLD_ORDERS_DETAIL_FULFILLED FETCH_OLD_ORDERS_DETAIL_REJECTED CHANGE_ORDER_ADRESS_PENDING CHANGE_ORDER_ADRESS_SUCCEED CHANGE_ORDER_ADRESS_FAIL

OldOrders

OLD_ORDERS_INITIAL_STATE FETCH_OLD_ORDERS_FULFILLED FETCH_OLD_ORDERS_PENDING FETCH_OLD_ORDERS_REJECTED _AS_INFINITE_OLD_ORDERS FETCH_OLD_ORDERS_DETAIL_PENDING FETCH_OLD_ORDERS_DETAIL_FULFILLED FETCH_OLD_ORDERS_DETAIL_REJECTED

Register

SET_REGISTER_REJECTED REGISTER_PENDING REGISTER_COMPLETED REGISTER_SMS_VERIFICATION_FORM_SHOW REGISTER_SMS_VERIFICATION_FORM_HIDE

Search

FETCH_SEARCH_PENDING FETCH_SEARCH_REJECTED FETCH_SEARCH_FULFILLED

Reducer

Address

INITIAL STATE

{
error: {},
pending: true,
infinitePending: false,
next: '',
success: false,
initialSuccess: false,
address: [],
city: [],
township: [],
district: [],
country: {},
isChanged: false,
}

Auth

INITIAL STATE

{
error: {},
indexCompleted: false,
loginCompleted: false,
pending: false,
loginSuccess: false,
logoutPending: false,
auth: {
user: false,
},
forgotPasswordError: [],
forgotPasswordPending: false,
forgotPasswordSuccess: false
}

Basket

INITIAL STATE

{
error: {},
pending: true,
initialSuccess: false,
isUpdate: false,
productAddedModal: false,
errorModal: false,
basket: {},
favourites: [],
favouritePending: false,
favouriteError: {},
}

Checkout

INITIAL STATE

{
error: {},
pending: false,
indexPage: {},
guestLogin: {
pending: false,
isLogin: false,
},
}

Combine Detail

INITIAL STATE

{
error: [],
pending: true,
product: {},
group_products: [],
}

Contact

INITIAL STATE

{
error: {},
pending: true,
isSuccess: false,
subjects: [],
}

Coupons

INITIAL STATE

{
error: [],
pending: true,
basketOffers: [],
discountOffers: [],
expiredOffers: [],
futureOffers: [],
}

Favourite List

INITIAL STATE

{
error: {},
pending: true,
infinitePending: false,
initialSuccess: false,
productAddedModal: false,
errorModal: false,
count: 0,
next: undefined,
previous: undefined,
favourites: [],
infiniteFetchError: false,
}

Map Marker

INITIAL STATE

{
pending: true,
error: {},
markers: [],
nearest: false,
}

INITIAL STATE

{
error: [],
pending: true,
categories: [],
}

Product Detail

INITIAL STATE

{    
error: [],
pending: true,
favouriteError: {},
initialSuccessAt: 0,
favourite: undefined,
favouritePending: false,
addedToFavouriteModal: false,
errorModalFavourite: false,
product: {},
variantValidation: false,
}

Product List

INITIAL STATE

{
error: {},
pending: true,
pendingFavouriteStatus: false,
favouriteError: {},
initialSuccess: false,
facets: [],
sorts: [],
pagination: {},
products: [],
infinitePending: false,
landingPage: {},
currentFilters: [],
currentSorters: [],
currentPagination: [
{
page: 1,
},
],
url: '',
}

User Settings

Email - INITIAL STATE

{  
error: [],
pending: false,
email: {},
isSuccess: false,
}

Notifications - INITIAL STATE

{  
error: [],
pending: false,
profile: {},
}

Password - INITIAL STATE

{  
error: [],
pending: false,
password: {},
isSuccess: false,
}

Profile - INITIAL STATE

{  
error: [],
pending: true,
isSuccess: false,
profile: {},
smsVerificationModal: false,
}

Web Checkout

INITIAL STATE

{   
completed: false,
url: null,
sucess: {
pending: true,
order: {},
error: {},
},
}

Widgets

INITIAL STATE

{   
error: [],
pending: false,
widgets: [],
}

Orders

INITIAL STATE

{
orders: [],
orderDetail: {},
error: {},
errorDetail: {},
reasonError: {},
pending: true,
pendingOrderDetail: true,
pendingReasons: true,
initialSuccess: false,
infinitePending: false,
reasons: {},
cancellationRequest: false,
next: '',
}

OldOrders

INITIAL STATE

{
oldOrders: [],
oldOrderDetail: {},
error: {},
pending: true,
pendingOldOrderDetail: true,
initialSuccess: false,
infinitePending: false,
next: '',
}

Register

INITIAL STATE

{
error: {},
pending: false,
registerSuccesful: false,
smsVerificationModal: false,
}

Search

INITIAL STATE

{
error: [],
pending: false,
results: [],
}

Page Containers

Hooks

useWidgetFetch

These are the hooks used to send requests to the widgets that are defined by Omnitron. When making a request, it’s sent to the widget slug based on the current widger. The exemplary request URL is provided in that format. Each request creates three available parameters.

error

This parameter indicates if any error occurs after a request is made, and returns to process these errors.

loading

The loading value has a true boolean during the period between a request is made and a response is received. Otherwise, it has a false boolean.

data

If the request returns with a successful response, the data value is filled with the returning data.

Core

createApp

This creates the mobile application based on the sent parameters.

Parameters

router This sends the navigation created for the application.

dataContainers Data containers are sent as objects. The Redux store is created with the send object. Reducers are created with object keys.

styles Style objects are sent as objects. Style objects are created with a stylesheet.

themeConfigs Theme configs are sent as objects. Default values are assigned to the elements within the framework

integrationMaps Integrations maps are sent as objects. Each map file has its own properties and stored in json files.

staticTextMaps Static texts are sent as objects. Each text key can support more then one language and are stored in json files.

request Request is sent as object. Http requests are made with Axios.

import { CreateApp } from "_core/App";
import router from './router';
import dataContainers from './dataContainers'
import styles from './styles';
import themeConfigs from './_themeConfigs';
import integrationMaps from './integrationMaps';
import staticTextMaps from './staticTextMaps';
import { request } from './request';

const App = CreateApp({
router,
dataContainers,
styles,
themeConfigs,
integrationMaps,
staticTextMaps,
request
});

export { App };