CartSystem | shopperman api docs

Cart system component class

is a section element
takes as props a cart object, checkout machine, scroll tracker, etc
contains CartButton and CartPanel components, mediates their relationship
handles cart button click event to toggle cart panel open or closed
handles cart system scroll tracking
ultimately performs the checkout, using the cart panel checkout callback and checkout machine as tools
takes a cart text object and distributes the text labels to child components

Hierarchy

Component<CartSystemProps, any>
- CartSystem

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new CartSystem(props?: CartSystemProps, context?: any): CartSystem

Inherited from Component.__constructor
- Defined in /home/brim/Desktop/work/shopperman/node_modules/preact/dist/preact.d.ts:85
Parameters
- Optional props: CartSystemProps
- Optional context: any
Returns CartSystem

Properties

Optional base

base: HTMLElement

context

context: any

props

props: RenderableProps<CartSystemProps>

state

state: Readonly<any>

Static Optional defaultProps

defaultProps: any

Static Optional displayName

displayName: string

Methods

componentWillMount

componentWillMount(): void

- Defined in components/cart/cart-system.tsx:40
Mount

Returns void

componentWillUnmount

componentWillUnmount(): void

- Defined in components/cart/cart-system.tsx:59
Unmount

Returns void

forceUpdate

forceUpdate(callback?: function): void

Inherited from Component.forceUpdate
- Defined in /home/brim/Desktop/work/shopperman/node_modules/preact/dist/preact.d.ts:99
Parameters
- Optional callback: function
  - - (): void
    - Returns void
Returns void

render

render(): Element

Overrides Component.render
- Defined in components/cart/cart-system.tsx:101
Render
- section element with scroll tracking
- contains cart button and cart panel
Returns Element

setState

setState<K>(state: Pick<any, K>, callback?: function): void
setState<K>(fn: function, callback?: function): void

Inherited from Component.setState
- Defined in /home/brim/Desktop/work/shopperman/node_modules/preact/dist/preact.d.ts:96
Type parameters
- K: keyof any
Parameters
- state: Pick<any, K>
- Optional callback: function
  - - (): void
    - Returns void
Returns void
Inherited from Component.setState
- Defined in /home/brim/Desktop/work/shopperman/node_modules/preact/dist/preact.d.ts:97
Type parameters
- K: keyof any
Parameters
- fn: function
  - - (prevState: any, props: CartSystemProps): Pick<any, K>
    - Parameters
      - prevState: any
      - props: CartSystemProps
      Returns Pick<any, K>
- Optional callback: function
  - - (): void
    - Returns void
Returns void

Static Optional componentDidMount

componentDidMount(): void

Inherited from Component.componentDidMount
- Defined in /home/brim/Desktop/work/shopperman/node_modules/preact/dist/preact.d.ts:76
Returns void

Static Optional componentDidUpdate

componentDidUpdate(previousProps: Readonly<CartSystemProps>, previousState: Readonly<any>, previousContext: any): void

Inherited from Component.componentDidUpdate
- Defined in /home/brim/Desktop/work/shopperman/node_modules/preact/dist/preact.d.ts:82
Parameters
- previousProps: Readonly<CartSystemProps>
- previousState: Readonly<any>
- previousContext: any
Returns void

Static Optional componentWillMount

componentWillMount(): void

Inherited from Component.componentWillMount
- Defined in /home/brim/Desktop/work/shopperman/node_modules/preact/dist/preact.d.ts:75
Returns void

Static Optional componentWillReceiveProps

componentWillReceiveProps(nextProps: Readonly<CartSystemProps>, nextContext: any): void

Inherited from Component.componentWillReceiveProps
- Defined in /home/brim/Desktop/work/shopperman/node_modules/preact/dist/preact.d.ts:79
Parameters
- nextProps: Readonly<CartSystemProps>
- nextContext: any
Returns void

Static Optional componentWillUnmount

componentWillUnmount(): void

Inherited from Component.componentWillUnmount
- Defined in /home/brim/Desktop/work/shopperman/node_modules/preact/dist/preact.d.ts:77
Returns void

Static Optional componentWillUpdate

componentWillUpdate(nextProps: Readonly<CartSystemProps>, nextState: Readonly<any>, nextContext: any): void

Inherited from Component.componentWillUpdate
- Defined in /home/brim/Desktop/work/shopperman/node_modules/preact/dist/preact.d.ts:81
Parameters
- nextProps: Readonly<CartSystemProps>
- nextState: Readonly<any>
- nextContext: any
Returns void

Static Optional getChildContext

getChildContext(): object

Inherited from Component.getChildContext
- Defined in /home/brim/Desktop/work/shopperman/node_modules/preact/dist/preact.d.ts:78
Returns object

Static Optional shouldComponentUpdate

shouldComponentUpdate(nextProps: Readonly<CartSystemProps>, nextState: Readonly<any>, nextContext: any): boolean

Inherited from Component.shouldComponentUpdate
- Defined in /home/brim/Desktop/work/shopperman/node_modules/preact/dist/preact.d.ts:80
Parameters
- nextProps: Readonly<CartSystemProps>
- nextState: Readonly<any>
- nextContext: any
Returns boolean

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional props: CartSystemProps

Optional context: any

Returns CartSystem

Properties

Optional base

context

props

state

Static Optional defaultProps

Static Optional displayName

Methods

componentWillMount

Returns void

componentWillUnmount

Returns void

forceUpdate

Parameters

Optional callback: function

Returns void

Returns void

render

Returns Element

setState

Type parameters

K: keyof any

Parameters

state: Pick<any, K>

Optional callback: function

Returns void

Returns void

Type parameters

K: keyof any

Parameters

fn: function

Parameters

prevState: any

props: CartSystemProps

Returns Pick<any, K>

Optional callback: function

Returns void

Returns void

Static Optional componentDidMount

Returns void

Static Optional componentDidUpdate

Parameters

previousProps: Readonly<CartSystemProps>

previousState: Readonly<any>

previousContext: any

Returns void

Static Optional componentWillMount

Returns void

Static Optional componentWillReceiveProps

Parameters

nextProps: Readonly<CartSystemProps>

nextContext: any

Returns void

Static Optional componentWillUnmount

Returns void

Static Optional componentWillUpdate

Parameters

nextProps: Readonly<CartSystemProps>

nextState: Readonly<any>

nextContext: any

Returns void

Static Optional getChildContext

Returns object

Static Optional shouldComponentUpdate

Parameters

nextProps: Readonly<CartSystemProps>

nextState: Readonly<any>

nextContext: any

Returns boolean