@tonicpow/widget
Version:
TonicPow helps manage visitor sessions, loads any TonicPow Widgets, and fires events.
198 lines (136 loc) • 7.36 kB
Markdown
<img src="https://github.com/tonicpow/widget/blob/master/examples/images/tonicpow-logo.png?raw=true" height="100" alt="TonicPow">
> Learn more [about TonicPow](https://tonicpow.com/?utm_source=github&utm_medium=link&utm_campaign=widget&utm_term=widget&utm_content=widget). Checkout the [TonicPow API Docs](https://docs.tonicpow.com).
[](https://github.com/tonicpow/widget/commits/master)
[](https://www.npmjs.com/package/@tonicpow/widget)
[](https://github.com/tonicpow/widget/releases)
[](https://github.com/tonicpow/widget/actions)
[](https://mergify.io)
<br>
[](https://github.com/sponsors/TonicPow)
[](https://atlantistic.slack.com/app_redirect?channel=tonicpow)
## Table of Contents
- [Features](#Features)
- [Installation](#installation)
- [Documentation](#documentation)
- [Examples](#examples)
- [Code Standards](#code-standards)
- [Usage](#usage)
- [Maintainers](#maintainers)
- [Contributing](#contributing)
- [License](#license)
## Features
- Create banner widgets
- Create share button widgets
- Manage session tokens for firing conversions
- Completes TonicPow basic website integration on a campaign
## Installation
1. Add the script to your web application
```html
<script src="https://tonicpow.com/scripts/tonicpow.js"></script>
```
2. Insert the widget from your [TonicPow](https://tonicpow.com/?utm_source=github&utm_medium=sponsor-link&utm_campaign=widget&utm_term=widget&utm_content=widget) account:
```html
<div class="tonicpow-widget" data-widget-id="your-widget-id-here"></div>
```
<details>
<summary><strong><code>Get Visitor Session</code></strong></summary>
```javascript
let session = window.TonicPow.getVisitorSession()
console.log(session) // 1b40c235dd9532213f5d611ffz06f9dd018efeffad8d6fbc35dc421fed18babz
```
</details>
<details>
<summary><strong><code>Build From Scratch</code></strong></summary>
```shell script
make install
make build
```
</details>
<br/>
## Documentation
Read more about the [TonicPow API](https://docs.tonicpow.com/?utm_source=github&utm_medium=sponsor-link&utm_campaign=widget&utm_term=widget&utm_content=widget) platform.
<details>
<summary><strong><code>Supported Browsers</code></strong></summary>
TonicPow supports all commonly used browsers. Below is a list of popular browsers and their minimum supported version.
If we're missing a browser, suggest one [via an issue](https://github.com/tonicpow/widget/issues/new).
| Browser | Platform | Min Version |
| :------ | :------- | :---------- |
| Android | Mobile | 67.0 |
| Bottle | Desktop | 0.1 |
| Brave | Desktop | 55.0 |
| Chrome | Desktop | 55.0 |
| Chrome | Mobile | 74.0 |
| Edge | Desktop | 17.0 |
| Firefox | Desktop | 52.0 |
| Firefox | Mobile | 67.0 |
| IE | Desktop | --- |
| Opera | Desktop | 42.0 |
| Opera | Mobile | --- |
| Safari | Desktop | 10.1 |
| Safari | Mobile | 10.3 |
</details>
<details>
<summary><strong><code>Library Deployment</code></strong></summary>
[goreleaser](https://github.com/goreleaser/goreleaser) for easy binary or library deployment to Github and can be installed via: `brew install goreleaser`.
The [.goreleaser.yml](.goreleaser.yml) file is used to configure [goreleaser](https://github.com/goreleaser/goreleaser).
Use `make release-snap` to create a snapshot version of the release, and finally `make release` to ship to production.
</details>
<details>
<summary><strong><code>Makefile Commands</code></strong></summary>
View all `makefile` commands
```shell script
make help
```
List of all current commands:
```text
audit Checks for vulnerabilities in dependencies
build Builds the package for web distribution
clean Remove previous builds and any test cache data
install Installs the dependencies for the package
lint Runs the standard-js lint tool
outdated Checks for outdated packages via npm
publish Will publish the version to npm
release Deploy to npm
test Runs all tests
help Show this help message
release Full production release (creates release in Github)
release-test Full production test release (everything except deploy)
release-snap Test the full release (build binaries)
replace-version Replaces the version in HTML/JS (pre-deploy)
tag Generate a new tag and push (tag version=0.0.0)
tag-remove Remove a tag if found (tag-remove version=0.0.0)
tag-update Update an existing tag to current commit (tag-update version=0.0.0)
```
</details>
<br/>
## Examples
View some [example TonicPow widgets](/examples/basic/basic-example.html)
<br/>
### Unit Tests
Run the unit tests:
```shell script
make test
```
<br/>
## Code Standards
Always use the language's best practices and don't optimize early :P
<br/>
## Usage
We are using it! Visit [our website](https://tonicpow.com/?utm_source=github&utm_medium=sponsor-link&utm_campaign=widget&utm_term=widget&utm_content=widget) to see it in action.
<br/>
## Maintainers
| [<img src="https://github.com/mrz1836.png" height="50" alt="MrZ" />](https://github.com/mrz1836) | [<img src="https://github.com/rohenaz.png" height="50" alt="Satchmo" />](https://github.com/rohenaz) |
| :----------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------------------: |
| [MrZ](https://github.com/mrz1836) | [Satchmo](https://github.com/rohenaz) |
<br/>
## Contributing
View the [contributing guidelines](.github/CONTRIBUTING.md) and follow the [code of conduct](.github/CODE_OF_CONDUCT.md).
### How can I help?
All kinds of contributions are welcome :raised_hands:!
The most basic way to show your support is to star :star2: the project, or to raise issues :speech_balloon:.
You can also support this project by [becoming a sponsor on GitHub](https://github.com/sponsors/TonicPow) :clap:
or by making a [**bitcoin donation**](https://tonicpow.com/?utm_source=github&utm_medium=sponsor-link&utm_campaign=widget&utm_term=widget&utm_content=widget) to ensure this journey continues indefinitely! :rocket:
[](https://github.com/tonicpow/widget/stargazers)
<br/>
## License
[](/LICENSE)