Loading...

RECOMMENDATION: If you are using a version of The Portal Connector higher than 4.0, we strongly recommend utilizing the MVC based widgets and components to create your site. This documentation is for legacy purposes only and will soon be deprecated.

Nav Cart

API
Widget Type:
Page Widgets
TPC Version:
  • 6.2
nav-cart

Placing a Nav Cart widget on your page displays a cart icon that shows the number of items you have added to your shopping cart. Clicking on it will show you the items in your cart, the quantity and price. In addition, you are given the option to go to the Shopping Cart page or to the Checkout page.

Graphical user interface, text, application, email Description automatically generated

Configuration

Basic

After you drag and drop the widget on your page and then click edit, you are presented with the Basic tab view. In this view, you configure the redirects to the Shopping Cart and Checkout Page. In addition, you have the option to disable the Nav Cart from flying out.

Graphical user interface, text, application, email Description automatically generated

Widget Properties

Basic Properties

Advanced Properties

Advanced properties provide additional functionality. They can be accessed by clicking on the "Advanced" Button in the bottom right corner of the widget designer.

API

get_navCartItemTotalElement()

Returns the div containing the nav cart subtotal.

Returns

jQuery Object

get_navCartButton()

Returns the nav cart button.

Returns

jQuery Object 

get_navCartDropDownContainer()

Returns the nav cart object, including nav cart buttons.

Returns

jQuery Object

get_cartCurrency()

Returns currency symbol.

Returns

String

get_type()

Returns the type of widget it is. Can be used in conjunction with findAll() e.g., tpc.findAll()[0].get_type().

Returns

String

show()

Shows the widget on the page.

Returns

None

get_navCartItemCountElement()

Returns the nav cart item count span. 

Returns

jQuery Object

toggle()

Toggles the visibility of the widget.

Returns

None

get_navCart()

Returns information about cart items.

Returns

Object

get_cartItemsSubTotal()

Returns the cart subtotal.

Returns

Number

get_container()

Returns the container element of the widget.

Returns

jQuery Object

get_cartDecimalPrecision()

Returns decimal places of cart amount.

Returns

Number

get_cartItemsCount()

Returns the number of items in your cart.

Returns

Number

hide()

Hides the widget from the page.

Returns

None

get_model()

Returns the model configuration object of the widget, which contains several useful properties related to the widget.

Returns

Object

Full API With Examples

How to's

Examples of Nav Cart Configuration