Fragments/Beam - Documentation

Source:

src/components/fragments/BeamImpact/index.js, line 3

Methods

(static) BeamCommunityImpact(props) → {React.Element}

Source:

src/components/fragments/BeamImpact/BeamCommunityImpact.jsx, line 15

Author:

Htin Linn Aung

Component for Beam CommunityImpact widget

Parameters:

Name Type Description

props

object

Properties

Name	Type	Description
`widgetColors`	object	From BeamImpact component
`widgetId`	string	Provided by Beam. It is in config

Returns:

Component for Beam CommunityImpact widget

Type: React.Element

(static) BeamImpact(props) → {React.Element}

Source:

src/components/fragments/BeamImpact/BeamImpact.jsx, line 39

Author:

Htin Linn Aung

Depending on the step, returns an appropriate widget

Parameters:

Name Type Description

props

object

Properties

Name	Type	Description
`style`	object	From theme file & withTemplate HOC
`widgetId`	string	Provided by Beam. It is in config
`patronEmail`	string	From BeamImpact
`cartTotal`	number	From BeamImpact
`step`	string	Checkout Step
`beam`	object	State in pages/Cart/routes.jsx
`setBeam`	function	Setter method for state in pages/Cart/routes.jsx
`onSeeMoreImpact`	function	callback for onClick on 'See More Impact' in pages/Cart/routes.jsx
`onSkipBeamSelection`	function	Alternate Func to bring the user to Routes.PURCHASE_COMPLETE - from home.jsx

Returns:

Main parent Beam Impact component

Type: React.Element

(static) BeamImpactOverview(props) → {React.Element}

Source:

src/components/fragments/BeamImpact/BeamImpactOverview.jsx, line 18

Author:

Htin Linn Aung

Component for Beam Impact Overview widget

Parameters:

Name Type Description

props

object

Properties

Name	Type	Description
`widgetColors`	string	From BeamImpact component
`widgetId`	string	Provided by Beam. It is in config
`patronEmail`	string	From BeamImpact
`beam`	object	State in pages/Cart/routes.jsx
`onSeeMoreImpact`	function	Callback for SeeMore button

Returns:

Component for Beam Impact Overview widget

Type: React.Element

(static) BeamNonProfit(props) → {React.Element}

Source:

src/components/fragments/BeamImpact/BeamNonProfit.jsx, line 85

Author:

Htin Linn Aung

Component for Beam Nonprofit widget

Parameters:

Name Type Description

props

object

Properties

Name	Type	Description
`style`	object	From theme file & withTemplate HOC
`widgetColors`	string	From BeamImpact component
`widgetId`	string	Provided by Beam. It is in config
`patronEmail`	string	From BeamImpact component
`cartTotal`	number	From BeamImpact component
`step`	string	Checkout Step
`beam`	object	State in pages/Cart/routes.jsx
`setBeam`	function	Setter method for state in pages/Cart/routes.jsx
`onSkipBeamSelection`	Fuction	Alternate Func to bring the user to Routes.PURCHASE_COMPLETE - from home.jsx

Returns:

Component for Beam Nonprofit widget

Type: React.Element

(static) BeamPersonalImpact(props) → {React.Element}

Source:

src/components/fragments/BeamImpact/BeamPersonalImpact.jsx, line 16

Author:

Htin Linn Aung

Component for Beam PersonalImpact widget

Parameters:

Name Type Description

props

object

Properties

Name	Type	Description
`widgetColors`	string	From BeamImpact
`widgetId`	string	Provided by Beam. It is in config
`beam`	object	State in pages/Cart/routes.jsx

Returns:

Component for Beam PersonalImpact widget

Type: React.Element

(static) Fallback() → {React.Element}

Source:

src/components/fragments/BeamImpact/Fallback.jsx, line 10

Author:

Htin Linn Aung

Fallback component if none of the Beam widgets works

Returns:

Fallback component if none of the Beam widgets works

Type: React.Element