@arcteryx/components-callout
v3.1.1
Published
Arcteryx callout
Downloads
166
Readme
@arcteryx/components-callout
This library is Deprecated. It was used for the Virtual Advisor feature which we no longer use.
Install
npm install --save @arcteryx/components-callout
FDP Usage
(scroll down for usage on legacy apps)
GENERIC CALLOUT
The generic callout is a clickable callout element that slides into the page and contains text as well as some child element. When the close button is clicked, the callout will no longer appear for the user in the current session.
PROPS
text: The text that will show up at the bottom of the Callout
isActive: This will enable/disable the Callout
handleClick: The click handler function that is executed when the Callout is clicked
handleCloseButton: The click handler function that is executed when the Callout close button is clicked
child: The child component enclosed in the Callout will appear above the 'text' prop. You can add an image here.
CALL
The following is an example of calling the generic Callout component:
<Callout
text="Questions about product or sizing?"
isActive={true}
handleClick={e => handleClick(e)}
handleCloseButtonClick={handleCloseButtonClick}
>
<figure>
<Imgix
src={
"https://images-dynamic-arcteryx.imgix.net/virtual-advisor-callout/a6ff6a61-6c57-44ec-bdb0-dcae77bb05d6.png"
}
height={83}
imgixParams={{ auto: "format,compress", q: 75 }}
htmlAttributes={{ alt: "Virtual Advisor" }}
/>
<figcaption>Virtual Advisor</figcaption>
</figure>
</Callout>
VIRTUAL ADVISOR
CALL
VirtualAdvisor calls the generic Callout with props specific to the Virtual Advisor (see the props used in the above example)
<VirtualAdvisor />
Legacy Usage
As of v1.0.15 this package change to export ES modules, and not CommonJS. Therefore, newer versions don't work with our legacy apps (namely Category Display Pages, Web Bundles and the ecomm app).
To deal with this, those consuming apps are version-locked to an older version of components-callout. This commit is the last known working version for legacy: @arcteryx/[email protected]
Should you find the need to hotfix this older version, here's the song and dance you'll need to do:
TL;DR https://stackoverflow.com/a/27665031
git checkout feature/callout-legacy-export
This is the last known working version for legacy apps
grep version package.json
Confirm this lines up with the latest 'legacy-export' version Callout Tags
[make your changes]
npm run build
npm version patch
The patch command will bump the version number
grep version package.json
Confirm the version number was bumped
npm publish --tag legacy-export
This published to npm, but doesn't overwrite the current latest version. You'll see your tagged version in the Versions tab, underneath the latest version, which will now be available for your consuming app to ... consume.