CorvidReference

CartIcon

An icon that leads users to the shopping cart.

The shopping cart icon displays how many items are in the shopping cart. When users click on the cart icon, a cart sidebar opens on the current page. You can use a CartIcon element to programmatically add items to a user's cart.

Table of Contents

PROPERTIES

?
Store values associated with an object.
renderedIndicates if an element is currently displayed.
globalIndicates if an element appears on all pages or only on the current page.
idGets the element's ID.
parentGets the element's parent element.
typeGets the element's type.
hiddenIndicates if the element is visible or hidden.
isVisibleIndicates if the element is actually visible.
collapsedIndicates if the element is collapsed or expanded.

FUNCTIONS

?
Perform actions on an object.
addProductsToCart( )Adds multiple products to the shopping cart.
addToCart( )Adds a product to the shopping cart.
onMouseIn( )

Adds an event handler that runs when the mouse pointer is moved onto the element.

onMouseOut( )

Adds an event handler that runs when the mouse pointer is moved off of the element.

scrollTo( )Scrolls the page to the element using an animation.
onViewportEnter( )

Adds an event handler that runs when an element is displayed in the viewable part of the current window.

onViewportLeave( )

Adds an event handler that runs when an element is no longer displayed in the viewable part of the current window.

hide( )

Hides the element and sets its hidden property to true, using an effect if specified.

show( )

Shows the element and sets its hidden property to false, using an effect if specified.

collapse( )Collapses the element and sets its collapsed property to true.
expand( )Expands the element and sets its collapsed property to false.

OBJECTS

?
Objects used when setting, getting, or calling the properties and methods listed above.
AddToCartCustomTextField

An object used to pass a custom text field when adding a product to the shopping cart with options.

AddToCartItemAn object used when adding multiple products to the shopping cart.
AddToCartOptionsAn object used when adding a product to the shopping cart with options.

MIXES IN

?
Where some functionality is inherited from.
$w.Element, $w.HiddenCollapsedMixin

rendered

Indicates if an element is currently displayed.

Description

If rendered is true, the element is in the current DOM structure and can be used.

If rendered is false the element is not in the current DOM structure.

An element might not be in the DOM if it is in a slide which is not currently showing.

See Also

collapsed, hidden, isVisible

Syntax

get rendered(): boolean
TYPE
?
The kind of data the property stores.
boolean
DEFAULT VALUE
?
The value of a property before you explicitly set it.
false

MIXED IN FROM

?
Where this functionality is inherited from.
$w.Element

Examples

Get an element's rendered status

let isRendered = $w("#myElement").rendered;  // true

global

Indicates if an element appears on all pages or only on the current page.

Description

If global is true, the element appears on all pages.

If global is false, the element only appears on the current page.

Syntax

get global(): boolean
TYPE
?
The kind of data the property stores.
boolean
DEFAULT VALUE
?
The value of a property before you explicitly set it.
false

MIXED IN FROM

?
Where this functionality is inherited from.
$w.Element

Examples

Get whether an element is displayed on all pages

let isGlobal = $w("#myElement").global; // false

id

Gets the element's ID.

Description

The ID is the element's unique identifier. It is used when selecting elements using the $w() function.

An element's id is set in the Editor using the Properties panel.

Syntax

get id(): string
TYPE
?
The kind of data the property stores.
string

MIXED IN FROM

?
Where this functionality is inherited from.
$w.Element

Examples

Get the ID

let myId = $w("#myElement").id; // "myElement"

parent

Gets the element's parent element.

Description

Some elements can contain other elements. This occurs when you drag an element onto a container element. The container is the parent of all the elements it contains.

Page, Header, and Footer are top-level elements and have no parent.

See Also

children

Syntax

get parent(): Node
TYPE
?
The kind of data the property stores.
DEFAULT VALUE
?
The value of a property before you explicitly set it.
null

MIXED IN FROM

?
Where this functionality is inherited from.
$w.Element

Examples

Get the parent element and the parent's ID

let parentElement = $w("#myElement").parent;

let parentId = parentElement.id; // "page1"

type

Gets the element's type.

Syntax

get type(): string
TYPE
?
The kind of data the property stores.
string

MIXED IN FROM

?
Where this functionality is inherited from.
$w.Element

Examples

Get the element's type

let myType = $w("#myElement").type; // "$w.Type"

hidden

Indicates if the element is visible or hidden.

Description

If hidden is true, the element is not displayed on the page under any circumstances. A hidden element, unlike a collapsed element, continues to take up the same space on the page as it did when it was visible.

If hidden is false, the element may be displayed on the page.

However, an element whose hidden property is false is still not displayed if:

Even if the element is not displayed due to the conditions mentioned above, if its hidden property is set to false, it's displayed when the conditions no longer apply.

To determine if the element is actually visible, use the isVisible property.

To set the hidden property on an element, use the element's hide() or show() functions.

If you select Hidden on load in the element's Properties panel in the Editor, the hidden property is set to true when the page loads.

Note

An element's hidden property is not the same as its isVisible property. The hidden property indicates whether the element should be displayed, while isVisible indicates if it is actually displayed.

See Also

hide( ), show( ), collapse( ), expand( ), collapsed, rendered

Syntax

get hidden(): boolean
TYPE
?
The kind of data the property stores.
boolean
DEFAULT VALUE
?
The value of a property before you explicitly set it.
false

MIXED IN FROM

?
Where this functionality is inherited from.
$w.HiddenCollapsedMixin

Examples

Get an element's hidden status

let isHidden = $w("#myElement").hidden;  // false

Toggle an element's hidden state

if( $w("#myElement").hidden ) {
  $w("#myElement").show();
}
else {
  $w("#myElement").hide();
}

isVisible

Indicates if the element is actually visible.

Description

If isVisible is true, the element is displayed on the page.

If isVisible is false, the element is not displayed on the page.

The value of the isVisible property is calculated based on the hidden, collapsed, and rendered properties of the element and all of its ancestors. It is true only if the conditions exist in the element's property values and the property values of its ancestors such that the element is actually displayed on the page.

Note

An element's isVisible property is not the same as its hidden property. The isVisible property indicates whether the element is actually displayed, while hidden indicates if it should be displayed.

The isVisible property of an element remains true even if another element completely covers it so that a user cannot see it.

See Also

hidden, collapsed, rendered

Syntax

get isVisible(): boolean
TYPE
?
The kind of data the property stores.
boolean
DEFAULT VALUE
?
The value of a property before you explicitly set it.
true

MIXED IN FROM

?
Where this functionality is inherited from.
$w.HiddenCollapsedMixin

Examples

Get whether an element is visible

let isVisible = $w("#myElement").isVisible;  // true

collapsed

Indicates if the element is collapsed or expanded.

Description

If collapsed is true, the element is not displayed on the page under any circumstances. A collapsed element, unlike a hidden element, does not take up any space on the page. When collapsed, elements positioned within 70 pixels below the collapsed element and each other move up to take the collapsed element's place where possible. The elements that move up maintain their positions relative to one another.

If collapsed is false, the element may be displayed on the page. Elements that moved up to take the collapsed element's place on the page are moved back down.

However, an expanded element (an element whose collapsed property is false) is still not displayed if:

Even if the element is not be displayed due to the conditions mentioned above, if its collapsed property is false, it's displayed when the conditions no longer apply.

To set the collapsed property on an element, use the element's collapse() and expand() functions.

If you select Collapsed on load in the element's Properties panel in the Editor, the collapsed property is set to true when the page loads.

See Also

collapse( ), expand( ), hide( ), show( ), hidden

Syntax

get collapsed(): boolean
TYPE
?
The kind of data the property stores.
boolean
DEFAULT VALUE
?
The value of a property before you explicitly set it.
false

MIXED IN FROM

?
Where this functionality is inherited from.
$w.HiddenCollapsedMixin

Examples

Get an element's collapsed status

let isCollapsed = $w("#myElement").collapsed; // false

Toggle an element's collapsed state

if( $w("#myElement").collapsed ) {
  $w("#myElement").expand();
}
else {
  $w("#myElement").collapse();
}

addProductsToCart( )

Adds multiple products to the shopping cart.

Description

The addProductsToCart() function returns a Promise that is resolved when the specified products are added to the shopping cart.

Use the quantity property of each AddToCartItem object that is passed to the products parameter to add more than one product unit to the shopping cart at one time. If quantity is omitted, one product unit will be added.

Use the options property of each AddToCartItem object that is passed to the products parameter to specify the product options to choose when adding the product to the cart. For example, if a product comes in different sizes, you can specify the size that should be added to the cart. If the product you are adding to the cart has options, you must specify which options should be chosen.

You can retrieve a product's option information from the productOptions field in the Stores/Product collection.

You can use the getProductOptionsAvailability() to determine if an item with specific options is available for purchase.

Also use the options property to specify the values for the product's custom text fields. If the product you are adding to the cart has mandatory custom text fields, you must specify values for those fields.

Syntax

function addProductsToCart(products: Array<AddToCartItem>): Promise<void>
PARAMETERS
?
Values that you pass to a function.
products
The list of products to add to the cart.
RETURN VALUE
?
Value that a function evaluates to when it is finished running.
Promise<void>
Fulfilled - When the products have been added to the cart.

Examples

Add multiple products to the cart

$w('#shoppingCartIcon1').addProductsToCart( [
  {
    "productID": "580a3cd8-8e39-2863-2a56-1d7019cbfcc1",
    "quantity": 5
  },
  {
    "productID": "2ab0eac2-69b3-bc77-5033-fac8805b223a",
    "options": {
      "choices": {
        "Size": "Small"
      },
      "customTextFields": [ {
        "title": "Personalization 1",
        "value": "Personalized Text 1"
      },
      {
        "title": "Personalization 2",
        "value": "Personalized Text 2"
      } ]
    }
  }
] )
  .then( () => {
    console.log("Products added");
  } )
  .catch( (error) => {
    console.log(error);
  } );

addToCart( )

Adds a product to the shopping cart.

Description

The addToCart() function returns a Promise that is resolved when the specified product is added to the shopping cart.

Use the optional quantity parameter to add more than one product unit to the shopping cart at one time. If quantity is omitted, one product unit will be added.

Use the options parameter to specify the product options to choose when adding the product to the cart. For example, if a product comes in different sizes, you can specify the size that should be added to the cart. If the product you are adding to the cart has options, you must specify which options should be chosen.

You can retrieve a product's option information from the productOptions field in the Stores/Product collection.

You can use the getProductOptionsAvailability() to determine if an item with specific options is available for purchase.

Also use the options parameter to specify the values for the product's custom text fields. If the product you are adding to the cart has mandatory custom text fields, you must specify values for those fields.

Syntax

function addToCart(productID: string, [quantity: number], [options: AddToCartOptions]): Promise<void>
PARAMETERS
?
Values that you pass to a function.
productID
string
The ID of the product to add to the cart.
quantity(Optional)
number

The number of product units to add to the cart. If omitted, one product unit will be added.

options(Optional)
Product options.
RETURN VALUE
?
Value that a function evaluates to when it is finished running.
Promise<void>
Fulfilled - When the product has been added to the cart.

Examples

Add a product to the cart

$w('#myShoppingCartIcon').addToCart("ea77f230-558f-0ba565e8f827")
  .then( () => {
    console.log("Product added");
  } )
  .catch( (error) => {
    console.log(error);
  } );

Add a product to the cart from a button click

$w("#myButton").onClick( () => {
  $w("#myShoppingCartIcon").addToCart("ea77f230-558f-0ba565e8f827")
    .then( () => {
      console.log("Product added");
    } )
    .catch( (error) => {
      console.log(error);
    } );
} );

Add two units of a product to the cart

$w('#myShoppingCartIcon').addToCart("ea77f230-558f-0ba565e8f827", 2)
  .then( () => {
    console.log("Product added");
  } )
  .catch( (error) => {
    console.log(error);
  } );

Add a product to the cart with options

$w('#shoppingCartIcon1').addToCart("ea77f230-558f-0ba565e8f827", 2, {
    "choices": {
      "Size": "Small"
    },
    "customTextFields": [ {
      "title": "Personalization 1",
      "value": "Personalized Text 1"
    },
    {
      "title": "Personalization 2",
      "value": "Personalized Text 2"
    } ]
  } )
  .then( () => {
    console.log("Product added");
  } )
  .catch( (error) => {
    console.log(error);
  } );

onMouseIn( )

Adds an event handler that runs when the mouse pointer is moved onto the element.

Note

Deprecation note: The $w parameter of event handlers is being deprecated. To get a scoped selector for working with elements in repeater items, use the $w.at() function and pass it the context property of the event parameter: $item = $w.at(event.context). To learn more, see here.

Syntax

function onMouseIn(handler: MouseEventHandler): Element
callback MouseEventHandler(event: MouseEvent, $w: $w): void
PARAMETERS
?
Values that you pass to a function.
handler
function(event: MouseEvent, $w: $w)

The name of the function or the function expression to run when the mouse pointer is moved onto the element.

?
Values that you pass to a function.
event
The mouse event that occurred.
$w

Deprecated: A selector function. The $w function was used to enable event handlers to work with elements in repeaters. Now, to get a scoped selector for working with repeater items, use the $w.at() function and pass it the context property of the event parameter: $item = $w.at(event.context).

RETURN VALUE
?
Value that a function evaluates to when it is finished running.
The element to which the event handler was added.

MIXED IN FROM

?
Where this functionality is inherited from.
$w.Element

Examples

Get the mouse event info when the mouse enters an element

$w("#myElement").onMouseIn( (event) => {
  let clientX = event.clientX;  // 362
  let clientY = event.clientY;  // 244
  let offsetX = event.offsetX;  // 10
  let offsetY = event.offsetY;  // 12
  let pageX = event.pageX;      // 362
  let pageY = event.pageY;      // 376
  let screenX = event.screenX;  // 3897
  let screenY = event.screenY;  // 362
} );

onMouseOut( )

Adds an event handler that runs when the mouse pointer is moved off of the element.

Note

Deprecation note: The $w parameter of event handlers is being deprecated. To get a scoped selector for working with elements in repeater items, use the $w.at() function and pass it the context property of the event parameter: $item = $w.at(event.context). To learn more, see here.

Syntax

function onMouseOut(handler: MouseEventHandler): Element
callback MouseEventHandler(event: MouseEvent, $w: $w): void
PARAMETERS
?
Values that you pass to a function.
handler
function(event: MouseEvent, $w: $w)

The name of the function or the function expression to run when the mouse pointer is moved off of the element.

?
Values that you pass to a function.
event
The mouse event that occurred.
$w

Deprecated: A selector function. The $w function was used to enable event handlers to work with elements in repeaters. Now, to get a scoped selector for working with repeater items, use the $w.at() function and pass it the context property of the event parameter: $item = $w.at(event.context).

RETURN VALUE
?
Value that a function evaluates to when it is finished running.
The element to which the event handler was added.

MIXED IN FROM

?
Where this functionality is inherited from.
$w.Element

Examples

Get the mouse event info when the mouse exits an element

$w("#myElement").onMouseOut( (event) => {
  let clientX = event.clientX;  // 362
  let clientY = event.clientY;  // 244
  let offsetX = event.offsetX;  // 10
  let offsetY = event.offsetY;  // 12
  let pageX = event.pageX;      // 362
  let pageY = event.pageY;      // 376
  let screenX = event.screenX;  // 3897
  let screenY = event.screenY;  // 362
} );

scrollTo( )

Scrolls the page to the element using an animation.

Description

The scrollTo() function returns a Promise that is resolved when the animated scroll is complete and the element is now in view.

To scroll to a specific location on the page, see the wix-window scrollTo() function.

Calling the scrollTo() function on an element in a repeated item that is selected from the global scope causes an error.

Syntax

function scrollTo(): Promise<void>
RETURN VALUE
?
Value that a function evaluates to when it is finished running.
Promise<void>
Fulfilled - When the scroll is complete.

MIXED IN FROM

?
Where this functionality is inherited from.
$w.Element

Examples

Scroll the page to an element

$w("#myElement").scrollTo();

Scroll the page to an element and log message when done

$w("#myElement").scrollTo()
  .then( ( ) => {
    console.log("Done with scroll");
} );

onViewportEnter( )

Adds an event handler that runs when an element is displayed in the viewable part of the current window.

Description

An element enters the viewport when the page is scrolled to show any part of the element. An element also enters the viewport if it was hidden or collapsed and is then shown or expanded in the viewable part of the current window.

Note

Deprecation note: The $w parameter of event handlers is being deprecated. To get a scoped selector for working with elements in repeater items, use the $w.at() function and pass it the context property of the event parameter: $item = $w.at(event.context). To learn more, see here.

See Also

onViewportLeave( )

Syntax

function onViewportEnter(handler: EventHandler): Element
callback EventHandler(event: Event, $w: $w): void
PARAMETERS
?
Values that you pass to a function.
handler
function(event: Event, $w: $w)

The name of the function or the function expression to run when the element enters the viewport.

?
Values that you pass to a function.
event
The event that occurred.
$w

Deprecated: A selector function. The $w function was used to enable event handlers to work with elements in repeaters. Now, to get a scoped selector for working with repeater items, use the $w.at() function and pass it the context property of the event parameter: $item = $w.at(event.context).

RETURN VALUE
?
Value that a function evaluates to when it is finished running.
The element on which the event is now registered.

MIXED IN FROM

?
Where this functionality is inherited from.
$w.Element

Examples

Get the ID of the element that has entered the viewport

$w("#myElement").onViewportEnter( (event) => {
  let targetId = event.target.id; // "myElement"
});

onViewportLeave( )

Adds an event handler that runs when an element is no longer displayed in the viewable part of the current window.

Description

An element leaves the viewport when the page is scrolled so that the elements is completely out of view. An element also leaves the viewport if it was shown or expanded and is then hidden or collapsed from the viewable part of the current window.

Note

Deprecation note: The $w parameter of event handlers is being deprecated. To get a scoped selector for working with elements in repeater items, use the $w.at() function and pass it the context property of the event parameter: $item = $w.at(event.context). To learn more, see here.

See Also

onViewportEnter( )

Syntax

function onViewportLeave(handler: EventHandler): Element
callback EventHandler(event: Event, $w: $w): void
PARAMETERS
?
Values that you pass to a function.
handler
function(event: Event, $w: $w)

The name of the function or the function expression to run when the element leaves the viewport.

?
Values that you pass to a function.
event
The event that occurred.
$w

Deprecated: A selector function. The $w function was used to enable event handlers to work with elements in repeaters. Now, to get a scoped selector for working with repeater items, use the $w.at() function and pass it the context property of the event parameter: $item = $w.at(event.context).

RETURN VALUE
?
Value that a function evaluates to when it is finished running.
The element on which the event is now registered.

MIXED IN FROM

?
Where this functionality is inherited from.
$w.Element

Examples

Get the ID of the element that has entered the viewport

$w("#myElement").onViewportLeave( (event) => {
  let targetId = event.target.id; // "myElement"
});

hide( )

Hides the element and sets its hidden property to true, using an effect if specified.

Description

The hide() function hides the element and returns a Promise that is resolved when the effect is complete and the element's hidden property has been set to true.

To learn about the behavior of a hidden element, see the hidden property.

You can optionally apply an effect when hiding the element by providing an effectName value. You can also customize the effect by providing the optional effectOptions object.

Effects:

You can also hide an element when the page loads by using the Properties panel in the Editor.

See Also

show( ), hidden, collapse( )

Syntax

function hide([effectName: string], [effectOptions: ArcEffectOptions | BounceEffectOptions | FadeEffectOptions | FlipEffectOptions | FloatEffectOptions | FlyEffectOptions | FoldEffectOptions | GlideEffectOptions | PuffEffectOptions | RollEffectOptions | SlideEffectOptions | SpinEffectOptions | TurnEffectOptions | ZoomEffectOptions]): Promise<void>
RETURN VALUE
?
Value that a function evaluates to when it is finished running.
Promise<void>
Fulfilled - When the effect is complete and the element's hidden property has been set to true.

MIXED IN FROM

?
Where this functionality is inherited from.
$w.HiddenCollapsedMixin

Examples

Hide an element with no effect

$w("#myElement").hide();

Hide an element with the "fade" effect

$w("#myElement").hide("fade");

Hide an element with an effect and log message when the effect is done

let fadeOptions = {
  "duration":   2000,
  "delay":      1000
};

$w("#myElement").hide("fade", fadeOptions);

Hide an element with an effect and log message when the effect is done

$w("#myElement").hide("fade")
  .then( ( ) => {
    console.log("Done with fade");
} );

Toggle an element's hidden state

if( $w("#myElement").hidden ) {
  $w("#myElement").show();
}
else {
  $w("#myElement").hide();
}

show( )

Shows the element and sets its hidden property to false, using an effect if specified.

Description

The show() function shows the element and returns a Promise that is resolved when the effect is complete and the element's hidden property has been set to false.

You can optionally apply an effect when showing the element by providing an effectName value. You can also customize the effect by providing the optional effectOptions object.

Effects:

See Also

hide( ), hidden, expand( )

Syntax

function show([effectName: string], [effectOptions: ArcEffectOptions | BounceEffectOptions | FadeEffectOptions | FlipEffectOptions | FloatEffectOptions | FlyEffectOptions | FoldEffectOptions | GlideEffectOptions | PuffEffectOptions | RollEffectOptions | SlideEffectOptions | SpinEffectOptions | TurnEffectOptions | ZoomEffectOptions]): Promise<void>
RETURN VALUE
?
Value that a function evaluates to when it is finished running.
Promise<void>
Fulfilled - When the effect is complete and the element's hidden property has been set to false.

MIXED IN FROM

?
Where this functionality is inherited from.
$w.HiddenCollapsedMixin

Examples

Show an element with no effect

$w("#myElement").show();

Show an element with the "fade" effect

$w("#myElement").show("fade");

Show an element with the "fade" effect and custom options

let fadeOptions = {
  "duration":   2000,
  "delay":      1000
};

$w("#myElement").show("fade", fadeOptions);

Show an element with an effect and log message when the effect is done

$w("#myElement").show("fade")
  .then( ( ) => {
    console.log("Done with fade");
  } );

Toggle an element's hidden state

if( $w("#myElement").hidden ) {
  $w("#myElement").show();
}
else {
  $w("#myElement").hide();
}

collapse( )

Collapses the element and sets its collapsed property to true.

Description

The collapse() function returns a Promise that is resolved when the element's collapsed property has been set to true.

To learn about the behavior of a collapsed element, see the collapsed property.

You can also collapse an element when the page loads by using the Properties panel in the Editor.

See Also

expand( ), collapsed, hide( )

Syntax

function collapse(): Promise<void>
RETURN VALUE
?
Value that a function evaluates to when it is finished running.
Promise<void>
Fulfilled - When the element's collapsed property has been set to true.

MIXED IN FROM

?
Where this functionality is inherited from.
$w.HiddenCollapsedMixin

Examples

Collapse an element

$w("#myElement").collapse();

Collapse an element and log a message when done

$w("#myElement").collapse()
  .then( () => {
    console.log("Done with collapse");
  } );

Toggle an element's collapsed state

if( $w("#myElement").collapsed ) {
  $w("#myElement").expand();
}
else {
  $w("#myElement").collapse();
}

expand( )

Expands the element and sets its collapsed property to false.

Description

The expand() function returns a Promise that is resolved when the element's collapsed property has been set to false.

To learn about the behavior of an expanded element, see the collapsed property.

See Also

expand( ), collapsed, show( )

Syntax

function expand(): Promise<void>
RETURN VALUE
?
Value that a function evaluates to when it is finished running.
Promise<void>
Fulfilled - When the element's collapsed property has been set to false.

MIXED IN FROM

?
Where this functionality is inherited from.
$w.HiddenCollapsedMixin

Examples

Expand an element

$w("#myElement").expand();

Expand an element and log a message when done

$w("#myElement").expand()
  .then( () => {
    console.log("Done with expand");
  } );

Toggle an element's collapsed state

if( $w("#myElement").collapsed ) {
  $w("#myElement").expand();
}
else {
  $w("#myElement").collapse();
}

AddToCartCustomTextField

An object used to pass a custom text field when adding a product to the shopping cart with options.

See Also

addToCart( ), AddToCartOptions

Syntax

type AddToCartCustomTextField = {
  title: string
  value: string
}
MEMBERS
?
The properties of an object.
title
string
Custom text field title.
value
string
Custom text field value.

Examples

Add a product to the cart with options

$w('#shoppingCartIcon1').addToCart("ea77f230-558f-0ba565e8f827", 2, {
    "choices": {
      "Size": "Small"
    },
    "customTextFields": [ {
      "title": "Personalization 1",
      "value": "Personalized Text 1"
    },
    {
      "title": "Personalization 2",
      "value": "Personalized Text 2"
    } ]
  } )
  .then( () => {
    console.log("Product added");
  } )
  .catch( (error) => {
    console.log(error);
  } );

Add multiple products to the cart

$w('#shoppingCartIcon1').addProductsToCart( [
  {
    "productID": "580a3cd8-8e39-2863-2a56-1d7019cbfcc1",
    "quantity": 5
  },
  {
    "productID": "2ab0eac2-69b3-bc77-5033-fac8805b223a",
    "options": {
      "choices": {
        "Size": "Small"
      },
      "customTextFields": [ {
        "title": "Personalization 1",
        "value": "Personalized Text 1"
      },
      {
        "title": "Personalization 2",
        "value": "Personalized Text 2"
      } ]
    }
  }
] )
  .then( () => {
    console.log("Products added");
  } )
  .catch( (error) => {
    console.log(error);
  } );

AddToCartItem

An object used when adding multiple products to the shopping cart.

See Also

addToCart( )

Syntax

type AddToCartItem = {
  productID: string
  options: AddToCartOptions
}
MEMBERS
?
The properties of an object.
productID
string
The ID of the product to add to the cart.
options(Optional)

Custom custom text fields to use when adding the product to the cart.

Examples

Add multiple products to the cart

$w('#shoppingCartIcon1').addProductsToCart( [
  {
    "productID": "580a3cd8-8e39-2863-2a56-1d7019cbfcc1",
    "quantity": 5
  },
  {
    "productID": "2ab0eac2-69b3-bc77-5033-fac8805b223a",
    "options": {
      "choices": {
        "Size": "Small"
      },
      "customTextFields": [ {
        "title": "Personalization 1",
        "value": "Personalized Text 1"
      },
      {
        "title": "Personalization 2",
        "value": "Personalized Text 2"
      } ]
    }
  }
] )
  .then( () => {
    console.log("Products added");
  } )
  .catch( (error) => {
    console.log(error);
  } );

AddToCartOptions

An object used when adding a product to the shopping cart with options.

See Also

addToCart( )

Syntax

type AddToCartOptions = {
  choices: Object
  customTextField: AddToCartCustomTextField
}
MEMBERS
?
The properties of an object.
choices
Object

Product options to use when adding the product to the cart. The object contains key:value pairs where the key is the option name and the value is the chosen option value.

customTextField

Custom custom text fields to use when adding the product to the cart.

Examples

Add a product to the cart with options

$w('#shoppingCartIcon1').addToCart("ea77f230-558f-0ba565e8f827", 2, {
    "choices": {
      "Size": "Small"
    },
    "customTextFields": [ {
      "title": "Personalization 1",
      "value": "Personalized Text 1"
    },
    {
      "title": "Personalization 2",
      "value": "Personalized Text 2"
    } ]
  } )
  .then( () => {
    console.log("Product added");
  } )
  .catch( (error) => {
    console.log(error);
  } );

Add multiple products to the cart

$w('#shoppingCartIcon1').addProductsToCart( [
  {
    "productID": "580a3cd8-8e39-2863-2a56-1d7019cbfcc1",
    "quantity": 5
  },
  {
    "productID": "2ab0eac2-69b3-bc77-5033-fac8805b223a",
    "options": {
      "choices": {
        "Size": "Small"
      },
      "customTextFields": [ {
        "title": "Personalization 1",
        "value": "Personalized Text 1"
      },
      {
        "title": "Personalization 2",
        "value": "Personalized Text 2"
      } ]
    }
  }
] )
  .then( () => {
    console.log("Products added");
  } )
  .catch( (error) => {
    console.log(error);
  } );