Remote and Front-end Analytics
Build
Run npm run build
.
- This will create a build in
./dist
. This is an ESM-only target (you can't use this in CommonJS modules). - This will also make a tarball at
./ucam-observe-remove-analytics-x.y.z.tgz
.
Installation
To install the package, run the following command:
npm install ucam-observe-remote-analytics
Usage
CookieBanner
Insert this next to the root of your React app.
❗️ Note
Use the CookieBanner
in a ThemeProvider
with the CamMuiTheme
to get the correct style.
Before
<html lang="en">
<body className={inter.className}>
{children}
</body>
</html>
After
<html lang="en">
<body className={inter.className}>
<CookieBanner />
{children}
</body>
</html>
CamMuiTheme
This is a theme that you can use with the ThemeProvider
from material-ui
. You should use the provider
in your layout or highest-level React app component.
Before
<html lang="en">
<body className={inter.className}>
<CookieBanner />
{children}
</body>
</html>
After
<html lang="en">
<body className={inter.className}>
<ThemeProvider theme={CamMuiTheme}>
<CssBaseline />
<CookieBanner />
{children}
</ThemeProvider>
</body>
</html>
Examples
In the basic-usage
folder, you will find an example application.
To use it, start from the root folder, then run the following to install the package:
npm run build
pushd && cd basic-usage
npm i ../ucam-observe-remove-analytics-0.1.0.tgz
npm i
Then run the following to start the test app:
npm run dev
Go to localhost:3000
to see the application.
Contributing
This project is MIT licensed.