mirror of
https://github.com/Unleash/unleash.git
synced 2025-09-05 17:53:12 +02:00
aaa96f71cb
Related to: https://linear.app/unleash/issue/2-511/exploration-build-data-for-the-possibility-of-showing-an-alert-to-the Namely: https://unleash-internal.slack.com/archives/C046LV85N3C/p1671443897386729 The idea is to have a general message banner that can be controlled through a feature flag in Unleash to display announcements, warnings, informations, etc. Currently using mock feature flags, but the idea is to bind this to a feature flag we can manage in our Unleash instance, and use its payload to provide information to end users whenever we want. Co-authored-by: Gastón Fournier <gaston@getunleash.ai>
41 lines
1.2 KiB
TypeScript
41 lines
1.2 KiB
TypeScript
import { useCallback, useContext } from 'react';
|
|
import { PlausibleContext } from 'contexts/PlausibleContext';
|
|
import { EventOptions, PlausibleOptions } from 'plausible-tracker';
|
|
|
|
/**
|
|
* Allowed event names. Makes it easy to remove, since TS will complain.
|
|
* Add those to Plausible as Custom event goals.
|
|
* @see https://plausible.io/docs/custom-event-goals#2-create-a-custom-event-goal-in-your-plausible-analytics-account
|
|
* @example `'download | 'invite' | 'signup'`
|
|
**/
|
|
type CustomEvents =
|
|
| 'invite'
|
|
| 'upgrade_plan_clicked'
|
|
| 'change_request'
|
|
| 'favorite'
|
|
| 'maintenance'
|
|
| 'message_banner';
|
|
|
|
export const usePlausibleTracker = () => {
|
|
const plausible = useContext(PlausibleContext);
|
|
|
|
const trackEvent = useCallback(
|
|
(
|
|
eventName: CustomEvents,
|
|
options?: EventOptions | undefined,
|
|
eventData?: PlausibleOptions | undefined
|
|
) => {
|
|
if (plausible?.trackEvent) {
|
|
plausible.trackEvent(eventName, options, eventData);
|
|
} else {
|
|
if (options?.callback) {
|
|
options.callback();
|
|
}
|
|
}
|
|
},
|
|
[plausible]
|
|
);
|
|
|
|
return { trackEvent };
|
|
};
|