https://github.com/cube-js/cube-example-wrapper
Layout and monitoring wrapper for Cube example apps
https://github.com/cube-js/cube-example-wrapper
Last synced: 10 months ago
JSON representation
Layout and monitoring wrapper for Cube example apps
- Host: GitHub
- URL: https://github.com/cube-js/cube-example-wrapper
- Owner: cube-js
- Created: 2022-03-28T18:14:30.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-07-09T09:19:05.000Z (over 3 years ago)
- Last Synced: 2024-04-26T10:42:41.236Z (over 1 year ago)
- Language: CSS
- Homepage:
- Size: 87.9 KB
- Stars: 2
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Cube examples wrapper
This package contains common layout and features like user tracking, feedback, and errors logging for Cube's [example applications](https://github.com/cube-js/cube.js/tree/master/examples).
## Installation
Install package via `yarn`:
```bash
yarn add cube-example-wrapper
```
## Usage
At the entry point of your app, import `createExampleWrapper`:
```js
import createExampleWrapper from "cube-example-wrapper";
```
Define an example description object and fill it with your values:
```js
const exampleDescription = {
title: "demo title",
text: `demo description text`,
};
```
*Note: you can use HTML tags inside the `text` template string.*
Call `createExampleWrapper` with passed `exampleDescription`:
```js
createExampleWrapper(exampleDescription);
```