shopperman api docs

Index

Classes

Type aliases

Variables

scrollEvents

Functions

Object literals

defaultCartOptions

Type aliases

PerformCheckout

PerformCheckout: function

Perform checkout function signature

function to call when the checkout is triggered

Type declaration

- (): Promise<string>
- Returns Promise<string>

ProductEvaluator

ProductEvaluator: function

Function to evaluate non-shopify product details

Type declaration

- (product: Product): ProductEvaluation
- Parameters
  - product: Product
  Returns ProductEvaluation

ShopifyClient

ShopifyClient: any

Shopify api client

Variables

Const scrollEvents

scrollEvents: string[] = ["scroll", "resize"]

Functions

convertNewlinesToReactBreaks

convertNewlinesToReactBreaks(text: string): Element[]

- Defined in toolbox/convert-newlines-to-react-breaks.tsx:4
Parameters
- text: string
Returns Element[]

ecommerceShopifyStore

ecommerceShopifyStore(options: EcommerceShopifyStoreOptions): Promise<void>

- Defined in ecommerce/shopify-store.tsx:17
Ecommerce shopify collection options
- load products from shopify
- install a fully featured cart system and ecommerce experience
- place products into specific dom elements
Parameters
- options: EcommerceShopifyStoreOptions
Returns Promise<void>

getScrollTop

getScrollTop(doc?: Document): number

- Defined in toolbox/get-scroll-top.ts:2
Parameters
- Default value doc: Document = window.document
Returns number

isDescendant

isDescendant(child: Element, parent: Element): boolean

- Defined in toolbox/is-descendant.ts:2
Parameters
- child: Element
- parent: Element
Returns boolean

Const makeDefaultCartText

makeDefaultCartText(): CartText

- Defined in components/cart/make-default-cart-text.ts:4
Returns CartText

Const makeDefaultScrollTracker

makeDefaultScrollTracker(): ScrollTracker

- Defined in components/cart/make-default-scroll-tracker.ts:4
Returns ScrollTracker

setScrollTop

setScrollTop(value: number, doc?: Document): void

- Defined in toolbox/set-scroll-top.ts:2
Parameters
- value: number
- Default value doc: Document = window.document
Returns void

Object literals

Const defaultCartOptions

defaultCartOptions: object

Default cart options

omniStorage

omniStorage: any = new LocalClient({storage: window.localStorage})

storageKey

storageKey: string = "shopperman"

Generated using TypeDoc