Skip to content

Documentation / @expofp/schema / HeatmapSchema

Variable: HeatmapSchema

ts
const HeatmapSchema: ZodObject<{
  enabled: ZodOptional<ZodBoolean>;
  kiosk: ZodOptional<ZodBoolean>;
  variant: ZodOptional<ZodEnum<{
     booths: "booths";
     yah: "yah";
  }>>;
}, $strip>;

The heatmap-mode request — the config.heatmap node. An empty object (the default) means no heatmap; a non-empty node engages the mode unless switched off with an explicit enabled: false — presence implies intent, so ?heatmap[variant]=yah alone is enough, and ?heatmap[enabled]=false can veto a manifest-set node (config layers replace the node wholesale).

Heatmap mode freezes the page URL for its whole session (the legacy contract). The request's access token (?t=) is deliberately NOT a field here — it is request material the data loader reads raw from the query.