@fullstory/snippet
v2.0.4
Published
FullStory snippet source
Downloads
829,354
Readme
FullStory Snippet
FullStory's snippet package provides a number of ways to integrate the FullStory snippet with your build tooling of choice. For a more integrated experience, try the browser SDK.
Installation
with npm
npm i @fullstory/snippet --savewith yarn
yarn add @fullstory/snippetExports
generateSnippetText
Options
orgId- Sets your FullStory Org Id. Find out how to get your Org Id here. Required.host- The recording server host domain. Can be set to direct recorded events to a proxy that you host. Defaults tofullstory.com.script- The full location of the FullStory script (fs.js). FullStory hosts thefs.jsrecording script on a CDN, but you can choose to host a copy yourself. Defaults toedge.fullstory.com/s/fs.js.namespace- Sets the global identifier for FullStory when conflicts withFSarise; see help. Defaults toFS.
Usage
Returns a stringified version of the FullStory snippet. This is useful for various build systems like webpack.
Examples
Webpack (docs)
// webpack.config.js
{
// ...
plugins: [
new HtmlWebpackPlugin({
fsSnippet: generateSnippetText({ orgId: 'xyz' }),
template: 'index.html',
})
]
}
// index.html
<!DOCTYPE html>
<html>
<head>
<script><%= htmlWebpackPlugin.options.fsSnippet %></script>
</head>
<body>
</body>
</html>Gatsby (docs)
// gatsby-ssr.js
exports.onRenderBody = ({ setHeadComponents }) => {
setHeadComponent(
<script
dangerouslySetInnerHTML={{
__html: generateSnippetTxt({ orgId: 'xyz' }),
}}
/>
);
}initFS
Options
Same as generateSnippetText.
Usage
Calling this function sets all the necessary global variables and immediately executes the FullStory snippet.
NOTE: this is used internally by @fullstory/browser.