cheatsheet
$w

$w

.$w(selector): Element | Element[ ]

.at(context): $w

.onReady((void) => Promise<void>)

Anchor (Node, ViewportMixin)

Anchor (Node, ViewportMixin)

.name: String

Background

Background

.background: BackgroundOptions

BackgroundOptions: {src: String}

Box (Element, HiddenCollapsedMixin, ClickableMixin, ContainableMixin, StyleMixin)

Box (Element, HiddenCollapsedMixin, ClickableMixin, ContainableMixin, StyleMixin)

.style: Style

Button (Element, HiddenCollapsedMixin, DisabledMixin, LinkableMixin, ClickableMixin, StyleMixin, LabelMixin)

Button (Element, HiddenCollapsedMixin, DisabledMixin, LinkableMixin, ClickableMixin, StyleMixin, LabelMixin)

.label: String

.style: Style

CartIcon (Element, HiddenCollapsedMixin)

CartIcon (Element, HiddenCollapsedMixin)

.addToCart(productID, quantity, options): Promise<void>

AddToCartCustomTextField: {title: String, value: String}

AddToCartOptions: {choices: Object, customTextField: AddToCartCustomTextField}

Checkbox (FormElement, DisabledMixin, HiddenCollapsedMixin, FocusMixin, ClickableMixin, StyleMixin, RequiredMixin, CheckedMixin)

Checkbox (FormElement, DisabledMixin, HiddenCollapsedMixin, FocusMixin, ClickableMixin, StyleMixin, RequiredMixin, CheckedMixin)

.checked: Boolean

.required: Boolean

.style: Style

.value: String

CheckedMixin

CheckedMixin

.checked: Boolean

ClickableMixin

ClickableMixin

.onClick((event, $w) => ): Element

.onDblClick((event, $w) => ): Element

CollapsedMixin

CollapsedMixin

.collapsed: Boolean

.collapse(): Promise<void>

.expand(): Promise<void>

Column (Element, Background, ClickableMixin, ContainableMixin)

Column (Element, Background, ClickableMixin, ContainableMixin)

ColumnStrip (Element, Background, HiddenCollapsedMixin, ClickableMixin, ContainableMixin)

ColumnStrip (Element, Background, HiddenCollapsedMixin, ClickableMixin, ContainableMixin)

.columns: Column[ ]

ContainableMixin

ContainableMixin

.children: Element[ ]

Container (Element, Background, ClickableMixin, ContainableMixin)

Container (Element, Background, ClickableMixin, ContainableMixin)

DatePicker (FormElement, HiddenCollapsedMixin, DisabledMixin, FocusMixin, ReadOnlyMixin, ClickableMixin, RequiredMixin)

DatePicker (FormElement, HiddenCollapsedMixin, DisabledMixin, FocusMixin, ReadOnlyMixin, ClickableMixin, RequiredMixin)

.disabledDates: Date[ ]

.disabledDaysOfWeek: Number[ ]

.maxDate: Date

.minDate: Date

.value: Date

DisabledMixin

DisabledMixin

.enabled: Boolean

.disable(): Promise<void>

.enable(): Promise<void>

Document

Document

.background: BackgroundOptions

.children: Node[ ]

.type: String

BackgroundOptions: {src: String}

Dropdown (FormElement, HiddenCollapsedMixin, DisabledMixin, FocusMixin, ClickableMixin, StyleMixin, RequiredMixin)

Dropdown (FormElement, HiddenCollapsedMixin, DisabledMixin, FocusMixin, ClickableMixin, StyleMixin, RequiredMixin)

.options: Option[ ]

.placeholder: String

.selectedIndex: Number

.style: Style

Option: {value: String, label: String}

EffectOptions

EffectOptions

ArcEffectOptions: {duration: Number, delay: Number, direction: String}

BounceEffectOptions: {duration: Number, delay: Number, direction: String, intensity: String}

FadeEffectOptions: {duration: Number, delay: Number}

FlipEffectOptions: {duration: Number, delay: Number, direction: String}

FloatEffectOptions: {duration: Number, delay: Number, direction: String}

FlyEffectOptions: {duration: Number, delay: Number, direction: String}

FoldEffectOptions: {duration: Number, delay: Number, direction: String}

GlideEffectOptions: {duration: Number, delay: Number, angle: Number, distance: Number}

PuffEffectOptions: {duration: Number, delay: Number}

RollEffectOptions: {duration: Number, delay: Number, direction: String}

SlideEffectOptions: {duration: Number, delay: Number, direction: String}

SpinEffectOptions: {duration: Number, delay: Number, direction: String, cycles: Number}

TurnEffectOptions: {duration: Number, delay: Number, direction: String}

ZoomEffectOptions: {duration: Number, delay: Number}

Element (Node, ViewportMixin)

Element (Node, ViewportMixin)

.rendered: Boolean

.onMouseIn((event, $w) => ): Element

.onMouseOut((event, $w) => ): Element

Event

Event

.context: EventContext

.target: Element

.type: String

EventContext: {type: String, itemId: Prefix[ ]}

FocusMixin

FocusMixin

.blur()

.focus()

.onBlur((event, $w) => ): Element

.onFocus((event, $w) => ): Element

Footer (Element, ClickableMixin, ContainableMixin, StyleMixin)

Footer (Element, ClickableMixin, ContainableMixin, StyleMixin)

.style: Style

FormElement (Element, ValidatableMixin, ValueMixin)

FormElement (Element, ValidatableMixin, ValueMixin)

.value: String

Gallery (Element, HiddenCollapsedMixin, PlayableMixin)

Gallery (Element, HiddenCollapsedMixin, PlayableMixin)

.clickAction: String

.currentIndex: Number

.currentItem: ImageItem| VideoItem| TextItem

.galleryCapabilities: GalleryCapabilities

.items: ImageItem[ ]| VideoItem[ ]| TextItem[ ]

.showNavigationButtons: Boolean

.onCurrentItemChanged((event, $w) => ): Gallery

.onItemClicked((event, $w) => ): Gallery

GalleryCapabilities: {isPlayable: Boolean, hasCurrentItem: Boolean, hasNavigationButtons: Boolean}

ImageItem: {type: String, slug: String, src: String, description: String, title: String, link: String, settings: ImageItemSettings}

ImageItemSettings: {quality: String, amount: String, radius: String, threshold: String}

TextItem: {type: String, slug: String, html: String, link: String, style: TextItemStyle}

TextItemStyle: {layoutRatio: String, fillColor: String, opacity: String, boxPadding: String, verticalAlignment: String}

VideoItem: {type: String, slug: String, src: String, description: String, title: String, link: String, thumbnail: String}

GalleryItemChangedEvent (Event)

GalleryItemChangedEvent (Event)

.item: ImageItem| VideoItem| TextItem

.itemIndex: Number

GalleryItemClickedEvent (GalleryItemChangedEvent, Event)

GalleryItemClickedEvent (GalleryItemChangedEvent, Event)

GoogleMap (Element, HiddenCollapsedMixin)

GoogleMap (Element, HiddenCollapsedMixin)

.location: MapLocation

MapLocation: {latitude: Number, longitude: Number, description: String}

Header (Element, ClickableMixin, ContainableMixin, StyleMixin)

Header (Element, ClickableMixin, ContainableMixin, StyleMixin)

.style: Style

HiddenCollapsedElement (Element, HiddenCollapsedMixin)

HiddenCollapsedElement (Element, HiddenCollapsedMixin)

HiddenCollapsedMixin (HiddenMixin, CollapsedMixin)

HiddenCollapsedMixin (HiddenMixin, CollapsedMixin)

HiddenMixin

HiddenMixin

.hidden: Boolean

.isVisible: Boolean

.hide(effectName, effectOptions): Promise<void>

.show(effectName, effectOptions): Promise<void>

HtmlComponent (IFrame)

HtmlComponent (IFrame)

.scrolling: void

.src: String

.allowFullScreen(): HtmlComponent

.onMessage((event, $w) => ): HtmlComponent

.postMessage(message)

HtmlComponentMessageEvent (Event)

HtmlComponentMessageEvent (Event)

.data: Element

IFrame (Element, HiddenCollapsedMixin)

IFrame (Element, HiddenCollapsedMixin)

Image (Element, HiddenCollapsedMixin, LinkableMixin, ClickableMixin)

Image (Element, HiddenCollapsedMixin, LinkableMixin, ClickableMixin)

.alt: String

.src: String

.tooltip: String

KeyboardEvent (Event)

KeyboardEvent (Event)

.altKey: Boolean

.ctrlKey: Boolean

.key: String

.metaKey: Boolean

.shiftKey: Boolean

LabelMixin

LabelMixin

.label: String

LinkableMixin

LinkableMixin

.link: String

.target: String

MouseEvent (Event)

MouseEvent (Event)

.clientX: Number

.clientY: Number

.offsetX: Number

.offsetY: Number

.pageX: Number

.pageY: Number

.screenX: Number

.screenY: Number

Node

Node

.global: Boolean

.id: String

.parent: Node

.type: String

.scrollTo(): Promise<void>

Page (Element, ClickableMixin, ContainableMixin)

Page (Element, ClickableMixin, ContainableMixin)

.description: String

.keywords: String[ ]

.title: String

.visibleInMenu: Boolean

Pagination (Element, DisabledMixin, HiddenCollapsedMixin, ClickableMixin, ViewportMixin)

Pagination (Element, DisabledMixin, HiddenCollapsedMixin, ClickableMixin, ViewportMixin)

.currentPage: Number

.totalPages: Number

.onChange((event, $w) => ): Pagination

PlayableMixin

PlayableMixin

.isPlaying: Boolean

.next(): Promise<Element>

.onPause((event, $w) => ): Gallery | Slideshow

.onPlay((event, $w) => ): Gallery | Slideshow

.pause()

.play()

.previous(): Promise<Element>

ProductPage (Element, HiddenCollapsedMixin)

ProductPage (Element, HiddenCollapsedMixin)

.getProduct(): Promise<StoreProduct>

StoreProduct: {_id: String, name: String, description: String, mainMedia: String, mediaItems: ImageItem[ ]| VideoItem[ ], sku: String, ribbons: StoreProductRibbon[ ], currency: String, price: Number, discountedPrice: Number, formattedPrice: String, formattedDiscountedPrice: String, trackInventory: Boolean, inStock: Boolean, quantityInStock: Number, additionalInfoSections: StoreProductAdditionalInfoSection[ ], productOptions: StoreProductOptions, productPageUrl: String, manageVariants: Boolean, customTextField: StoreProductCustomTextFields[ ], productType: String, slug: String, weight: String}

StoreProductAdditionalInfoSection: {title: String, description: String}

StoreProductCustomTextFields: {title: String, maxLength: String}

StoreProductOption: {optionType: String, name: String, choices: StoreProductOptionsChoice[ ]}

StoreProductOptions: {optionKey: StoreProductOption}

StoreProductOptionsChoice: {value: Number, description: Number, media: StoreProductOptionsChoiceMedia, inStock: Boolean, visible: Boolean}

StoreProductOptionsChoiceMedia: {mainMedia: String, mediaItems: ImageItem[ ]| VideoItem[ ]}

StoreProductRibbon: {text: String}

QuickActionBar (HiddenCollapsedMixin, StyleMixin)

QuickActionBar (HiddenCollapsedMixin, StyleMixin)

.alignment: Boolean

.colorScheme: String

.invertColorScheme: Boolean

.showLabels: Boolean

.onItemClicked((event, $w) => ): QuickActionBar

QuickActionBarItemClickedEvent (Event)

QuickActionBarItemClickedEvent (Event)

.item: QuickActionBarItem

.itemIndex: Number

QuickActionBarItem: {itemType: String, label: String, link: String}

RadioButtonGroup (FormElement, HiddenCollapsedMixin, DisabledMixin, FocusMixin, ClickableMixin, StyleMixin, RequiredMixin)

RadioButtonGroup (FormElement, HiddenCollapsedMixin, DisabledMixin, FocusMixin, ClickableMixin, StyleMixin, RequiredMixin)

.options: Option[ ]

.selectedIndex: Number

.style: Style

.value: String

Option: {value: String, label: String}

RatingsDisplay (Element, HiddenCollapsedMixin, ClickableMixin)

RatingsDisplay (Element, HiddenCollapsedMixin, ClickableMixin)

.numRatings: Number

.rating: Number

ReadOnlyMixin

ReadOnlyMixin

.readOnly: Boolean

Repeater (Element, HiddenCollapsedMixin)

Repeater (Element, HiddenCollapsedMixin)

.data: Object[ ]

.forEachItem(($item, itemData, index) => )

.forItems(itemIds, ($item, itemData, index) => )

.onItemReady(($item, itemData, index) => ): Repeater

.onItemRemoved((itemData) => ): Repeater

RequiredMixin

RequiredMixin

.required: Boolean

Slide (Element, Background, ContainableMixin)

Slide (Element, Background, ContainableMixin)

.name: String

Slider (Element, ValueMixin, DisabledMixin, HiddenCollapsedMixin, FocusMixin)

Slider (Element, ValueMixin, DisabledMixin, HiddenCollapsedMixin, FocusMixin)

.max: Number

.min: Number

.step: Number

.stepType: String

Slideshow (Element, HiddenCollapsedMixin, PlayableMixin, ClickableMixin, ContainableMixin)

Slideshow (Element, HiddenCollapsedMixin, PlayableMixin, ClickableMixin, ContainableMixin)

.currentIndex: Number

.currentSlide: Slide

.showNavigationButtons: Boolean

.showSlideButtons: Boolean

.slides: Slide[ ]

.changeSlide(slideReference): Promise<Slide>

.onChange((event, $w) => ): Slideshow

Style

Style

.backgroundColor: String

.borderColor: String

.borderRadius: String

.borderWidth: String

.color: String

StyleMixin

StyleMixin

.style: Style

Switch (Element, DisabledMixin, HiddenCollapsedMixin, FocusMixin, ClickableMixin, ValueMixin, CheckedMixin)

Switch (Element, DisabledMixin, HiddenCollapsedMixin, FocusMixin, ClickableMixin, ValueMixin, CheckedMixin)

.checked: Boolean

Table (Element, HiddenCollapsedMixin, ClickableMixin)

Table (Element, HiddenCollapsedMixin, ClickableMixin)

.columns: Column[ ]

.dataFetcher: void

.pagination: PaginationOptions

.rows: Object[ ]

.onCellSelect((event, $w) => ): Table

.onDataChange((event, $w) => )

.onRowSelect((event, $w) => ): Table

.refresh()

.selectRow(index)

.updateRow(index, rowData)

Column: {id: String, dataPath: String, label: String, type: String, width: Number, visible: Boolean, linkPath: String}

PaginationOptions: {type: String, rowsPerPage: Number}

TableCellEvent (Event)

TableCellEvent (Event)

.cellColumnId: String

.cellData: String

.cellRowIndex: Number

TableRowEvent (Event)

TableRowEvent (Event)

.rowData: Object

.rowIndex: Number

Text (Element, HiddenCollapsedMixin, ClickableMixin)

Text (Element, HiddenCollapsedMixin, ClickableMixin)

.html: String

.text: String

TextBox (FormElement, DisabledMixin, TextInputMixin, HiddenCollapsedMixin, FocusMixin, ReadOnlyMixin, ClickableMixin, StyleMixin, RequiredMixin)

TextBox (FormElement, DisabledMixin, TextInputMixin, HiddenCollapsedMixin, FocusMixin, ReadOnlyMixin, ClickableMixin, StyleMixin, RequiredMixin)

.style: Style

.value: String

.wrap: String

TextInput (FormElement, HiddenCollapsedMixin, DisabledMixin, TextInputMixin, FocusMixin, ReadOnlyMixin, ClickableMixin, StyleMixin, RequiredMixin)

TextInput (FormElement, HiddenCollapsedMixin, DisabledMixin, TextInputMixin, FocusMixin, ReadOnlyMixin, ClickableMixin, StyleMixin, RequiredMixin)

.inputType: String

.max: Number

.min: Number

.style: Style

.value: String

TextInputMixin

TextInputMixin

.maxLength: Number

.placeholder: String

.onKeyPress((event, $w) => ): Element

UploadButton (FormElement, HiddenCollapsedMixin, DisabledMixin, FocusMixin, StyleMixin, RequiredMixin)

UploadButton (FormElement, HiddenCollapsedMixin, DisabledMixin, FocusMixin, StyleMixin, RequiredMixin)

.buttonLabel: String

.fileType: String

.style: Style

.value: File[ ]

.reset()

.startUpload(): Promise<UploadedFile>

File: {name: String, size: String}

UploadedFile: {url: String}

UploadError: {errorCode: String, errorDescription: String}

ValidatableMixin

ValidatableMixin

.valid: Boolean

.validationMessage: String

.validity: ValidityState

.onCustomValidation((value, reject) => )

.resetValidityIndication()

.updateValidityIndication()

ValidityState: {customError: Boolean, valid: Boolean, valueMissing: Boolean, typeMismatch: Boolean, patternMismatch: Boolean, tooLong: Boolean, tooShort: Boolean, rangeUnderflow: Boolean, rangeOverflow: Boolean, fileNotUploaded: Boolean, stepMismatch: Boolean, badInput: Boolean}

ValueMixin

ValueMixin

.value: String

.onChange((event, $w) => ): Element

VectorImage (Element, HiddenCollapsedMixin, LinkableMixin, ClickableMixin)

VectorImage (Element, HiddenCollapsedMixin, LinkableMixin, ClickableMixin)

.src: String

Video (Element, HiddenCollapsedMixin)

Video (Element, HiddenCollapsedMixin)

.videoUrl: String

ViewportMixin

ViewportMixin

.onViewportEnter((event, $w) => ): Element

.onViewportLeave((event, $w) => ): Element

wix-crm

wix-crm

.createContact(contactInfo): Promise<String>

.emailContact(emailId, toContact, options): Promise<void>

ContactInfo: {firstName: String, lastName: String, picture: String, emails: String[ ], loginEmail: String, phones: String[ ], labels: String[ ], language: String, customFields: String| Number| Date}

wix-crm-backend

wix-crm-backend

.createContact(contactInfo): Promise<String>

wix-data

wix-data

.filter(): WixDataFilter

.get(collectionName, itemId, options): Promise<Object>

.insert(collectionName, item, options): Promise<Object>

.insertReference(collectionName, propertyName, referringItem, referredItem): Promise<void>

.isReferenced(collectionName, propertyName, referringItem, referredItem): Promise<Boolean>

.query(collectionName): WixDataQuery

.queryReferenced(collectionName, item, propertyName): Promise<Object>

.remove(collectionName, itemId, options): Promise<Object>

.removeReference(collectionName, propertyName, referringItem, referredItem): Promise<void>

.save(collectionName, item, options): Promise<Object>

.sort(): WixDataSort

.update(collectionName, item, options): Promise<Object>

WixDataOptions: {suppressAuth: Boolean, suppressHooks: Boolean}

Hooks

Hooks

.afterCount(count, context): Promise<Number>

.afterGet(item, context): Promise<Object>

.afterInsert(item, context): Promise<Object>

.afterQuery(item, context): Promise<Object>

.afterRemove(item, context): Promise<Object>

.afterUpdate(item, context): Promise<Object>

.beforeCount(query, context): Promise<WixDataQuery>

.beforeGet(itemId, context): Promise<String>

.beforeInsert(item, context): Promise<Object>

.beforeQuery(query, context): Promise<WixDataQuery>

.beforeRemove(itemId, context): Promise<String>

.beforeUpdate(item, context): Promise<Object>

.onFailure(error, context): Promise<Object>

HookContext: {collectionName: String, userId: String, userRole: String, currentItem: Object}

WixDataFilter

WixDataFilter

.between(propertyName, rangeStart, rangeEnd): WixDataQuery

.contains(propertyName, string): WixDataQuery

.endsWith(propertyName, string): WixDataQuery

.eq(propertyName, value): WixDataQuery

.ge(propertyName, value): WixDataQuery

.gt(propertyName, value): WixDataQuery

.hasAll(propertyName, value): WixDataQuery

.hasSome(propertyName, value): WixDataQuery

.isEmpty(propertyName): WixDataQuery

.isNotEmpty(propertyName): WixDataQuery

.le(propertyName, value): WixDataQuery

.lt(propertyName, value): WixDataQuery

.ne(propertyName, value): WixDataQuery

.not(query): WixDataQuery

.or(query): WixDataQuery

.startsWith(propertyName, string): WixDataQuery

WixDataQuery

WixDataQuery

.ascending(propertyName): WixDataQuery

.between(propertyName, rangeStart, rangeEnd): WixDataQuery

.contains(propertyName, string): WixDataQuery

.count(options): Promise<Number>

.descending(propertyName): WixDataQuery

.endsWith(propertyName, string): WixDataQuery

.eq(propertyName, value): WixDataQuery

.find(options): Promise<WixDataQueryResult>

.ge(propertyName, value): WixDataQuery

.gt(propertyName, value): WixDataQuery

.hasAll(propertyName, value): WixDataQuery

.hasSome(propertyName, value): WixDataQuery

.include(propertyName): WixDataQuery

.isEmpty(propertyName): WixDataQuery

.isNotEmpty(propertyName): WixDataQuery

.le(propertyName, value): WixDataQuery

.limit(limit): WixDataQuery

.lt(propertyName, value): WixDataQuery

.ne(propertyName, value): WixDataQuery

.not(query): WixDataQuery

.or(query): WixDataQuery

.skip(skip): WixDataQuery

.startsWith(propertyName, string): WixDataQuery

WixDataQueryResult

WixDataQueryResult

.currentPage: Number

.items: Object[ ]

.length: Number

.pageSize: Number

.partialIncludes: Boolean

.query: WixDataQuery

.totalCount: Number

.totalPages: Number

.hasNext(): Boolean

.hasPrev(): Boolean

.next(): Promise<WixDataQueryResult>

.prev(): Promise<WixDataQueryResult>

WixDataSort

WixDataSort

.ascending(propertyName): WixDataQuery

.descending(propertyName): WixDataQuery

wix-dataset

wix-dataset

.getCurrentItem(): Object

.getCurrentItemIndex(): Number

.getCurrentPageIndex(): Number

.getItems(fromIndex, numberOfItems): Promise<GetItemsResult>

.getNextDynamicPage(): Promise<String>

.getPageSize(): Number

.getPreviousDynamicPage(): Promise<String>

.getTotalCount(): Number

.getTotalPageCount(): Number

.hasNext(): Boolean

.hasNextPage(): Boolean

.hasPrevious(): Boolean

.hasPreviousPage(): Boolean

.loadMore(): Promise<void>

.loadPage(pageIndex): Promise<Object[ ]>

.new(): Promise<void>

.next(): Promise<Object>

.nextPage(): Promise<Object[ ]>

.onAfterSave((itemBeforeSave, itemAfterSave) => void)

.onBeforeSave((void) => Promise<Boolean>)

.onCurrentIndexChanged((index) => )

.onError((operation, error) => )

.onItemValuesChanged((itemBeforeChange, updatedItem) => )

.onReady()

.previous(): Promise<Object>

.previousPage(): Promise<Object[ ]>

.refresh(): Promise<void>

.remove(): Promise<void>

.revert(): Promise<void>

.save(): Promise<Object>

.setCurrentItemIndex(index): Promise<void>

.setFieldValue(fieldKey, value)

.setFieldValues(fieldValues)

.setFilter(filter): Promise<void>

.setPageSize(pageSize): Promise<void>

.setSort(sort): Promise<void>

GetItemsResult: {items: Object[ ], totalCount: Number, offset: Number}

wix-fetch

wix-fetch

.fetch(url, options): Promise<WixFetchResponse>

WixFetchRequest: {method: String, headers: Object, body: String}

WixFetchResponse

WixFetchResponse

.bodyUsed: Boolean

.headers: Object

.ok: Boolean

.status: Number

.statusText: String

.url: String

.json(): Promise<Object>

.text(): Promise<String>

wix-http-functions

wix-http-functions

.badRequest(options): WixHttpFunctionResponse

.created(options): WixHttpFunctionResponse

.delete(request): WixHttpFunctionResponse

.forbidden(options): WixHttpFunctionResponse

.get(request): WixHttpFunctionResponse

.notFound(options): WixHttpFunctionResponse

.ok(options): WixHttpFunctionResponse

.post(request): WixHttpFunctionResponse

.put(request): WixHttpFunctionResponse

.response(options): WixHttpFunctionResponse

.serverError(options): WixHttpFunctionResponse

.use(request): WixHttpFunctionResponse

WixHttpFunctionResponseOptions: {status: Number, body: String| Buffer, headers: Object}

WixHttpFunctionRequest

WixHttpFunctionRequest

.baseUrl: String

.body: WixHttpFunctionRequestBody

.functionName: String

.headers: Object

.ip: String

.method: String

.path: String[ ]

.query: Object

.url: String

WixHttpFunctionRequestBody: {text(): Promise, json(): Promise}

WixHttpFunctionResponse

WixHttpFunctionResponse

.body: Number| Buffer

.headers: Object

.status: Number

wix-location

wix-location

.baseUrl: String

.path: String[ ]

.prefix: String

.protocol: String

.query: Object

.url: String

.to(url)

wix-router

wix-router

.afterRouter(request, response): Promise<WixRouterResponse>

.afterSitemap(request, sitemapEntries): Promise<WixRouterSitemapEntry[ ]>

.beforeRouter(request): Promise<WixRouterResponse>

.customizeQuery(request, route, query): WixDataQuery

.forbidden(message): Promise<WixRouterResponse>

.next(): Promise<WixRouterResponse>

.notFound(message): Promise<WixRouterResponse>

.ok(Page, routerReturnedData, head): Promise<WixRouterResponse>

.redirect(url, statusCode): Promise<WixRouterResponse>

.router(request): Promise<WixRouterResponse>

.sendStatus(statusCode, message): Promise<WixRouterResponse>

.sitemap(request): Promise<WixRouterSitemapEntry[ ]>

WixRouterRequest

WixRouterRequest

.baseUrl: String

.formFactor: String

.ip: String

.pages: String[ ]

.path: String[ ]

.prefix: String

.protocol: String

.query: Object

.referrer: String

.url: String

.user: WixRouterUser

.userAgent: String

WixRouterResponse

WixRouterResponse

.data: Object

.head: HeadOptions

.message: String

.page: String

.redirectUrl: String

.status: Number

HeadOptions: {title: String, description: String, keywords: String, noIndex: Boolean, metaTags: Object}

WixRouterSitemapEntry

WixRouterSitemapEntry

.changeFrequency: String

.lastModified: Date

.pageName: String

.priority: Number

.title: String

.url: String

WixRouterSitemapRequest

WixRouterSitemapRequest

.baseUrl: String

.pageName: String

.pages: String[ ]

.prefix: String

.user: WixRouterUser

WixRouterUser

WixRouterUser

.id: String

.role: String

wix-site

wix-site

.getSiteStructure(): SiteStructure

.routerSitemap(routerPrefix): Promise<WixRouterSitemapEntry[ ]>

Prefix: {name: String, type: String, prefix: String, applicationId: String}

SiteStructure: {pages: StructurePage[ ], prefixes: Prefix[ ], lightboxes: StructureLightbox[ ]}

StructureLightbox: {name: String}

StructurePage: {name: String, type: String, url: String, applicationId: String, prefix: String}

wix-storage

wix-storage

.local: Storage

.session: Storage

Storage

Storage

.clear()

.getItem(key): String

.removeItem(key)

.setItem(key, value)

wix-stores-backend

wix-stores-backend

.getProductOptionsAvailability(productId, choices): Promise<ProductOptionsAvailability>

ProductOptionsAvailability: {availableForPurchase: Boolean, productOptions: StoreProductOptions, mainMedia: String, mediaItems: ImageItem[ ]| VideoItem[ ], selectedVariant: ProductOptionsAvailabilitySelectedVariant}

ProductOptionsAvailabilitySelectedVariant: {sku: String, currency: String, price: Number, discountedPrice: Number, formattedPrice: String, formattedDiscountedPrice: String, visible: Boolean, inStock: Boolean, weight: Number}

StoreProductChoices: {optionKey: String}

wix-users

wix-users

.currentUser: User

.applySessionToken(sessionToken): Promise<void>

.emailUser(emailId, toUser, options): Promise<void>

.login(email, password): Promise<void>

.logout()

.onLogin((user) => )

.promptForgotPassword(language): Promise<void>

.promptLogin(options): Promise<User>

.register(email, password, options): Promise<RegistrationResult>

LoginOptions: {mode: String, lang: String}

RegistrationOptions: {contactInfo: ContactInfo}

RegistrationResult: {status: String, approvalToken: String, user: User}

TriggeredEmailOptions: {variables: Object}

User

User

.id: String

.loggedIn: Boolean

.getEmail(): Promise<String>

.getRoles(): Promise<UserRole[ ]>

UserRole: {name: String, description: String}

wix-users-backend

wix-users-backend

.currentUser: User

.approveByEmail(email): Promise<String>

.approveByToken(token): Promise<String>

.blockByEmail(email): Promise<void>

.register(email, password, options): Promise<RegistrationResult>

RegistrationResult: {status: String, sessionToken: String, approvalToken: String, user: User}

wix-window

wix-window

.formFactor: String

.locale: String

.referrer: String

.viewMode: String

.getBoundingRect(): Promise<WindowSizeInfo>

.getCurrentGeolocation(): Promise<Object>

.getRouterData(): Object

.openLightbox(name, data): Promise<Object>

.openModal(url, options): Promise<void>

.postMessage(message, target): Promise<Object>

.scrollBy(x, y): Promise<void>

.scrollTo(x, y): Promise<void>

.trackEvent(eventName, parameters)

OpenModalOptions: {width: Number, height: Number}

WindowSizeInfo: {window: Object, document: Object, scroll: Object}

lightbox

lightbox

.close(data)

.getContext(): Object

rendering

rendering

.env: String

.renderCycle: Number

trackingParameters

trackingParameters

AddPaymentInfoEvent: {option: String}

AddProductImpressionEvent: {contents: AddProductImpressionEventContents[ ]}

AddProductImpressionEventContents: {id: String, sku: String, name: String, category: String, price: Number, currency: String, brand: String, variant: String, list: String, position: String}

AddToCartEvent: {id: String, sku: String, name: String, price: Number, currency: String, category: String, brand: String, variant: String, position: String, quantity: Number}

ClickProductEvent: {id: String, sku: String, name: String, price: Number, currency: String, category: String, brand: String, variant: String, list: String, position: String}

CustomEvent: {event: String}

InitiateCheckoutEvent: {contents: InitiateCheckoutEventContents[ ]}

InitiateCheckoutEventContents: {id: String, sku: String, name: String, category: String, price: Number, currency: String, brand: String, variant: String, quantity: Number}

PurchaseEvent: {id: String, affiliation: String, revenue: Number, tax: Number, shipping: Number, coupon: String, contents: PurchaseEventContents[ ]}

PurchaseEventContents: {id: String, name: String, category: String, price: Number, currency: String, brand: String, variant: String, quantity: Number}

RemoveFromCartEvent: {id: String, name: String, price: Number, currency: String, category: String, brand: String, variant: String, position: String, quantity: Number}

ViewContentEvent: {id: String, sku: String, name: String, price: Number, currency: String, category: String, brand: String, variant: String, list: String, position: String}