1.2.8 • Published 5 months ago

merchi_cart v1.2.8

Weekly downloads
-
License
MIT
Repository
github
Last release
5 months ago

merchi_cart

Merchi's cart

Table of Contents

Installation

npm install merchi_cart

or

yarn add merchi_cart

Usage

context functions:

components: ButtonOpenCart ButtonListWrappedOpenCart MerchiCart MerchiCartModal MerchiShoppingCartModal

context functions: setCartComplete - Resets the cart refetchCart - refetches the cart createCartAndCookie - clears and resets the cart with a new cookie getCartShipmentOptions - refetches the cart shipment options

window functions: addCartItem - takes job json and creates a cart item getCart - fetches the cart getMerchiCartValues - retruns the following: cart cartItemsCount currency subtotalCost taxAmount totalCost isMerchiCartFetching - checks the fetching state of the cart setCartComplete - Resets the cart toggleCartOpen - open close cart modal refetchCart - refetches the cart createCartAndCookie = clears and resets the cart with a new cookie

Props

NameTypeDefaultDescription
cartcartJson Object || undefined"{}"Pass in a cart to init the cart state in the provider
classNameAlertErrorstring?"alert alert-danger"Class for alert error
classNameAlertInfostring?"alert alert-info"Class for alert info
classNameAlertSuccessstring?"alert alert-success"Class for alert success
classNameAlertWarningstring?"alert alert-warning"Class for alert warning
classNameBtnstring?"btn"Base class for button elements
classNameBtnBackstring?"btn-lg btn-default pull-left"Class for back button
classNameBtnCartClearstring?"btn-lg btn-danger mr-auto"Class for clear cart button
classNameBtnClosestring?"btn-close"Class for close button element
classNameBtnDangerstring?"btn btn-md btn-danger"Class for button danger element
classNameBtnDownloadInvoicestring?"btn btn-lg btn-primary"Class for button download element
classNameBtnLinkstring?"btn-md btn-link"Class for link button elements
classNameBtnNextstring?"btn-lg btn-primary"Class for next button
classNameBtnNextCompletestring?"btn-lg btn-success"Class for next button completed
classNameBtnPaystring?"btn-lg btn-primary width-full"Class for pay button completed
classNameBtnPrimarystring?"btn btn-md btn-primary"Class for edit cart item button
classNameBtnEditCartItemstring?"btn btn-md btn-primary ml-auto"Class for primary button completed
classNameCartBodystring?"merchi-cart-body"Class for cart body container
classNameCartFooterstring?"merchi-cart-footer"Class for cart footer container
classNameCartFormGroupstring?"form-group merchi-form-group"Class for form group element
classNameCartFormGroupButtonstring?"merchi-form-group-button"Class for form group button
classNameCartFormGroupCheckboxstring?"form-check"Class for form group checkbox
classNameCartFormInputstring?"form-control"Class for form input
classNameCartFormLabelCheckboxstring?""Class for form input checkbpx label
classNameCartFormCheckboxstring?"form-check-input"Class for form input checkbpx
classNameCartHeaderstring?"merchi-cart-header"Class for cart header container
classNameCartInputErrorstring?"text-danger"Class for form error
classNameCartNavstring?"nav merchi-nav-tabs merchi-nav merchi-nav-fill merchi-nav-pills"Class for cart nav
classNameNoItemsstring?"merchi-no-cart-items"Class for no items in cart
classNameCartGoogleSuggestListstring?"list-group m-b-0"Class for google suggest list
classNameCartGoogleSuggestListItemstring?"list-group-item cursor-pointer"Class for google suggest list item
classNameCartItemFeatureImagestring?"img-rounded m-10"Class for cart item feature image
classNameCartItemInfostring?"text-muted font-weight-normal font-italic"Class for cart item info element
classNameCartItemInfoCellstring?"border-0 align-middle"Class for cart item cell
classNameCartItemInfoCellRightstring?"border-0 align-middle text-right"Class for cart item cell right align
classNameCartItemInfoContainerstring?"ml-3 d-inline-block align-middle"Class for cart item info container
classNameCartRowstring?"merchi-row"Class for row element
classNameCartRowColumnstring?"merchi-column"Class for row column element
classNameTableContainerstring?"table-responsive"Class for cart table container
classNameCartTabstring?"merchi-tab-content"Class for cart tab container
classNameCartTabItemstring?"nav-item merchi-nav-item"Class for cart tab item
classNameCartTabItemLinkstring?"merchi-nav-link"Class for cart tab item link |
classNameCartTitlestring?"merchi-cart-title"Class for cart Title container
classNameCartTotalContainerstring?"merchi-cart-total-container"Class for totals container elements
classNameCartToggleIconButtonstring?"cart-icon-button-class"Class for toggle modal button
classNameCartTotalItemstring?"merchi-cart-total-item"Class for totals item elements
classNameCartTotalItemPricestring?"merchi-cart-total-item-price"Class for totals item price elements
classNameClearCartContainerstring?"merchi-cart-clear-container"Class cart clear container
classNameClearCartTextstring?"merchi-cart-clear-text"Class cart clear text container
classNameListClientInfostring?"merchi-cart-client-info-list"Class for client info list
classNameListContainerstring?"pb-2"Class for list conatiner element
classNameCartTotaListContainerstring?"merchi-cart-total-list-container"Class for list conatiner for cart totlas element
classNameListItemstring?"list-group-item"Class for list item elements
classNameListItemCartTotalsstring?"list-group-item d-flex justify-content-between align-items-center"Class for list item cart totals elements
classNameListstring?"list-group"Class for list elements
classNameListInlinestring?"list-inline"Class for list inline elements
classNameListUnstylesstring?"list-unstyled"Class for list unstyled elements
classNameLoadingTemplatestring?"merchi-loading-template"Class for loading elements
classNameLoadingTemplateContainerstring?"merchi-loading-template-container"Class for loading container elements
classNameShipmentOptionstring?"merchi-shipment-option"Class for shipment option element
classNameTablestring?"table"Class for table elements
classNameVariationsListstring?"list-unstyled list-inline"Class for variation info
customSuccessMessagestring?undefinedA message to display on payment success
domainIdnumberundefinedThe merchi domain/store id for the cart
footerReactElementundefinedA customer footer component
hideHeadbooleanfalsehides the cart head title and close
includeThemeboolean?falseIf true will fetch and apply the store theme to the page
initialiseCartboolean?trueIf true will initial fetch cart and set cart function on window
onClickClose() => void?() => console.log('close merchi cart!')a function to close the cart
setIsCartModalOpen(isOpen: boolean) => void?() => console.log('close merchi cart!')a function to open/close cart modal wrapper
isCartModalOpenbooleanfalsea boolean value to control the cart modal open/closed
productFormClassNamesobj{}An object to be passsed to the merchi_product_form
showUserTermsAndConditionsboolean?trueDisplay the user t&cs for Merchi
showCartItemInfoboolean?trueWill display the cart item info in the cart items table
apiUrlstring?'https://api.merchi.co/v6/'URL to connect to the Merchi API
urlFrontendstring?'https://merchi.co/'URL to redirect users to a frontend
urlTrackingPagestring?undefinedURL used on the thankyou page for tracking
reactmerchicomponentmerchmerchandiselibrarystripe
@fortawesome/fontawesome-free@fortawesome/fontawesome-svg-core@fortawesome/free-solid-svg-icons@fortawesome/react-fontawesome@rollup/plugin-image@stripe/react-stripe-js@stripe/stripe-js@types/moment-timezone@types/nodebabel-plugin-import-css-to-jssbabel-plugin-inline-importbabel-plugin-inline-react-svgbrowser-or-nodecompile-sasseslinteslint-config-nextjs-cookielodashmerchi_product_formmerchi_sdk_jsmerchi_sdk_tsmomentmoment-timezonereactreact-country-region-selectorreact-domreact-geosuggestreact-hook-formreact-iconsreact-square-web-payments-sdkreact-transitionreact-transition-groupreactstrapreflect-metadatarollup-plugin-babelsasstypescript
1.0.0-test-af

7 months ago

1.0.0-test-ag

7 months ago

1.0.0-test-ah

7 months ago

1.0.0-test-ab

7 months ago

1.0.0-test-ac

7 months ago

1.0.0-test-ad

7 months ago

1.0.0-test-ae

7 months ago

1.0.0-test-aa

7 months ago

1.0.0-test-b

8 months ago

1.0.0-test-a

8 months ago

0.1.13-a

8 months ago

1.1.2-test

7 months ago

1.2.0

6 months ago

1.2.8

5 months ago

1.2.7

5 months ago

1.2.6

5 months ago

1.2.5

6 months ago

1.2.4

6 months ago

1.2.3

6 months ago

1.2.2

6 months ago

1.2.1

6 months ago

1.1.1

7 months ago

1.1.0

7 months ago

1.1.3

7 months ago

1.1.2

7 months ago

1.0.0-test-p

8 months ago

1.0.0-test-o

8 months ago

1.0.0-test-r

8 months ago

1.0.0-test-q

8 months ago

1.0.0-test-l

8 months ago

1.0.0-test-k

8 months ago

1.0.0-test-n

8 months ago

1.0.0-test-m

8 months ago

1.0.0-test-h

8 months ago

1.0.0-test-g

8 months ago

1.0.0-test-j

8 months ago

1.0.0-test-i

8 months ago

1.0.0-test-d

8 months ago

1.0.0-test-c

8 months ago

1.0.0-test-f

8 months ago

1.0.0-test-e

8 months ago

1.0.0-test-x

8 months ago

1.0.0-test-w

8 months ago

1.0.0-test-z

7 months ago

1.0.0-test-y

7 months ago

1.0.0-test-t

8 months ago

1.0.0-test-s

8 months ago

1.0.0-test-v

8 months ago

1.0.0-test-u

8 months ago

1.2.5-test-a

6 months ago

1.2.5-test-g

6 months ago

1.2.5-test-f

6 months ago

1.2.5-test-c

6 months ago

1.2.5-test-b

6 months ago

1.2.5-test-e

6 months ago

1.2.5-test-d

6 months ago

0.1.8-m

1 year ago

0.1.8-l

1 year ago

0.1.8-o

1 year ago

0.1.8-n

1 year ago

0.1.8-i

1 year ago

0.1.8-h

1 year ago

0.1.8-k

1 year ago

0.1.8-j

1 year ago

0.1.8-e

1 year ago

0.1.8-d

1 year ago

0.1.8-g

1 year ago

0.1.8-f

1 year ago

0.1.8-a

1 year ago

0.1.8-c

1 year ago

0.1.8-b

1 year ago

0.1.8-u

12 months ago

0.1.8-t

12 months ago

0.1.8-w

12 months ago

0.1.8-v

12 months ago

0.1.8-q

1 year ago

0.1.8-p

1 year ago

0.1.8-s

12 months ago

0.1.8-r

12 months ago

0.1.10

12 months ago

0.1.11

12 months ago

0.1.12

12 months ago

0.1.11-a

12 months ago

0.1.7

1 year ago

0.1.9

12 months ago

0.1.6

1 year ago

0.1.5

1 year ago

0.1.4

1 year ago

0.1.1-d

1 year ago

0.1.1-c

1 year ago

0.1.1-b

1 year ago

0.1.1-a

1 year ago

0.1.2

1 year ago

0.1.3

1 year ago

0.1.1

1 year ago

0.0.9-e

1 year ago

0.0.9-d

1 year ago

0.0.8-i

1 year ago

0.1.0

1 year ago

0.0.9-c

1 year ago

0.0.9-b

1 year ago

0.0.9-a

1 year ago

0.0.9

1 year ago

0.0.8-h

1 year ago

0.0.8-g

1 year ago

0.0.8-f

1 year ago

0.0.8-e

1 year ago

0.0.8

1 year ago

0.0.8-d

1 year ago

0.0.8-c

1 year ago

0.0.8-b

1 year ago

0.0.8-a

1 year ago

0.0.7-z

1 year ago

0.0.7-y

1 year ago

0.0.7-x

1 year ago

0.0.7-w

1 year ago

0.0.7-q

1 year ago

0.0.7-p

1 year ago

0.0.7-o

1 year ago

0.0.7-n

1 year ago

0.0.7-u

1 year ago

0.0.7-t

1 year ago

0.0.7-s

1 year ago

0.0.7-r

1 year ago

0.0.7-v

1 year ago

0.0.7-m

1 year ago

0.0.7-l

1 year ago

0.0.7-k

1 year ago

0.0.7-j

1 year ago

0.0.7-i

1 year ago

0.0.7-h

1 year ago

0.0.7-g

1 year ago

0.0.6-n

1 year ago

0.0.6-m

1 year ago

0.0.6-l

1 year ago

0.0.6-k

1 year ago

0.0.6-o

1 year ago

0.0.6-j

1 year ago

0.0.7

1 year ago

0.0.7-e

1 year ago

0.0.7-d

1 year ago

0.0.7-c

1 year ago

0.0.7-b

1 year ago

0.0.7-f

1 year ago

0.0.7-a

1 year ago

0.0.6-f

1 year ago

0.0.6-e

1 year ago

0.0.6-d

1 year ago

0.0.6-c

1 year ago

0.0.6-i

1 year ago

0.0.6-h

1 year ago

0.0.6-g

1 year ago

0.0.6-b

1 year ago

0.0.6-a

1 year ago

0.0.5-s

1 year ago

0.0.5-r

1 year ago

0.0.5-q

1 year ago

0.0.5-w

1 year ago

0.0.5-v

1 year ago

0.0.5-u

1 year ago

0.0.5-t

1 year ago

0.0.5-z

1 year ago

0.0.5-y

1 year ago

0.0.6

1 year ago

0.0.5-x

1 year ago

0.0.5-o

1 year ago

0.0.5-n

1 year ago

0.0.5-m

1 year ago

0.0.5-l

1 year ago

0.0.5-p

1 year ago

0.0.5-g

1 year ago

0.0.5-f

1 year ago

0.0.5-d

1 year ago

0.0.5-k

1 year ago

0.0.5-j

1 year ago

0.0.5-i

1 year ago

0.0.5-h

1 year ago

0.0.5-c

1 year ago

0.0.5-b

1 year ago

0.0.5

1 year ago

0.0.4-t

1 year ago

0.0.4-s

1 year ago

0.0.4-x

1 year ago

0.0.4-w

1 year ago

0.0.4-v

1 year ago

0.0.4-u

1 year ago

0.0.4-z

1 year ago

0.0.4-y

1 year ago

0.0.4-p

1 year ago

0.0.4-o

1 year ago

0.0.4-n

1 year ago

0.0.4-m

1 year ago

0.0.4-r

1 year ago

0.0.4-q

1 year ago

0.0.4-h

1 year ago

0.0.4-g

1 year ago

0.0.4-f

1 year ago

0.0.4-e

1 year ago

0.0.4-l

1 year ago

0.0.4-k

1 year ago

0.0.4-j

1 year ago

0.0.4-i

1 year ago

0.0.4-d

1 year ago

0.0.4-c

1 year ago

0.0.4-b

1 year ago

0.0.4-a

1 year ago

0.0.2-z

1 year ago

0.0.3-q

1 year ago

0.0.3-p

1 year ago

0.0.3-o

1 year ago

0.0.3-n

1 year ago

0.0.3-u

1 year ago

0.0.3-t

1 year ago

0.0.3-s

1 year ago

0.0.3-r

1 year ago

0.0.3-h

1 year ago

0.0.3-g

1 year ago

0.0.3-f

1 year ago

0.0.3-m

1 year ago

0.0.3-l

1 year ago

0.0.3-k

1 year ago

0.0.3-j

1 year ago

0.0.3-a

1 year ago

0.0.3-e

1 year ago

0.0.3-d

1 year ago

0.0.3-c

1 year ago

0.0.3-b

1 year ago

0.0.3

1 year ago

0.0.3-y

1 year ago

0.0.3-x

1 year ago

0.0.3-w

1 year ago

0.0.3-v

1 year ago

0.0.4

1 year ago

0.0.3-z

1 year ago

0.0.2-r

1 year ago

0.0.2-q

1 year ago

0.0.2-p

1 year ago

0.0.2-o

1 year ago

0.0.2-v

1 year ago

0.0.2-u

1 year ago

0.0.2-t

1 year ago

0.0.2-s

1 year ago

0.0.2-i

1 year ago

0.0.2-h

1 year ago

0.0.2-g

1 year ago

0.0.2-n

1 year ago

0.0.2-m

1 year ago

0.0.2-l

1 year ago

0.0.2-f

1 year ago

0.0.2-e

1 year ago

0.0.2-d

1 year ago

0.0.2-c

1 year ago

0.0.2-y

1 year ago

0.0.2-x

1 year ago

0.0.1-s

1 year ago

0.0.1-r

1 year ago

0.0.1-w

1 year ago

0.0.1-v

1 year ago

0.0.1-u

1 year ago

0.0.1-t

1 year ago

0.0.2-a

1 year ago

0.0.2

1 year ago

0.0.1-z

1 year ago

0.0.1-y

1 year ago

0.0.1-x

1 year ago

0.0.1-q

1 year ago

0.0.1-p

1 year ago

0.0.1-k

1 year ago

0.0.1-j

1 year ago

0.0.1-h

1 year ago

0.0.1-o

1 year ago

0.0.1-m

1 year ago

0.0.1-g

1 year ago

0.0.1-f

1 year ago

0.0.1-e

1 year ago

0.0.1-d

1 year ago

0.0.1-c

1 year ago

0.0.1-b

1 year ago

0.0.1-a

1 year ago

0.0.1

1 year ago

0.0.0

1 year ago