@rokt/ux-helper-web
v0.3.0
Published
The Rokt UX Helper Web is an open source library that enables partner applications to more easily render various user experiences, increasing the velocity of testing and ultimately improving relevancy for the customer. This library provides the flexibilit
Readme
Rokt UX Helper Web
The Rokt UX Helper Web is an open source library that enables partner applications to more easily render various user experiences, increasing the velocity of testing and ultimately improving relevancy for the customer. This library provides the flexibility to modify the Rokt optimized user experience before rendering content and exposes various events for the RoktLayout that the application can listen to and may forward to their server.
📦 Installation
Install the library using npm:
# Install stable version (recommended for production)
npm install @rokt/ux-helper-web@stable
# For testing new features
npm install @rokt/ux-helper-web@latestCDN Usage
<!-- Use the stable version for production -->
<script src="https://cdn.jsdelivr.net/npm/@rokt/ux-helper-web/dist/index.cjs"></script>🚀 Getting Started
🔔 Events
For detailed event handling documentation, refer to docs/EVENTS.md.
Main Event Types
- RoktUXEvent - User interaction events you can use to customize your UX
- RoktPlatformEvent - System events that should be forwarded to Rokt
🔧 Utils
For detailed documentation on utility functions, refer to docs/UTILS.md.
📂 Key Directories
rokt-custom-elements/: Contains web component definitions likeRoktLayoutView.renderer/: Manages rendering and core application logic.utils/: Includes reusable utility functions (e.g.,parseUserAgent).types/: Defines shared TypeScript interfaces and types.
📖 Additional Resources
🙋 FAQ
Where can I find integration guides?
Refer to the Web integration guide.
How do I determine if I need embedded or overlay experiences?
Embedded experiences integrate within your page structure, while overlay experiences appear on top of your content. Review your design requirements or consult with your Rokt Account Manager to determine which type best meets your needs.
How do I report issues?
Open an issue on GitHub Issues.
What browser versions are supported?
The library is compatible with modern browsers including Chrome, Firefox, Safari, and Edge. For older browser support, consider adding web component polyfills.
👥 Resident Experts
- Cris Ryan Tan - [email protected]
- Martin Rubinsztein - [email protected]
- James Newman - [email protected]
📝 License
Licensed under Rokt License.
