@tonicpow/widget-react

Widget (React Component)

Easy integration using React

Table of Contents

• Features
• Installation
• Documentation
• Examples
• Code Standards
• Usage
• Maintainers
• Contributing
• License

Features

• Create banner widgets
• Create share button widgets

Installation

yarn

Documentation

Read more about the TonicPow API platform.

Supported Browsers

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.

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

Library Deployment

goreleaser for easy binary or library deployment to Github and can be installed via: brew install goreleaser.

The .goreleaser.yml file is used to configure goreleaser.

Use make release-snap to create a snapshot version of the release, and finally make release to ship to production.

Makefile Commands

View all makefile commands

make help

List of all current commands:

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
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)

Examples

View some example TonicPow widgets

Code Standards

Always use the language's best practices and don't optimize early :P

Usage

To see the available widgets and run in standalone mode, we've conveniently added all components to storybook.

yarn storybook

To use this in your project, just do

import TonicPowWidget from "@tonicpow/widget-react"
<TonicPowWidget widgetId="your-widget-id">

We are using it! Visit our website to see it in action.

Maintainers

MrZ	Satchmo

Contributing

View the contributing guidelines and follow the code of conduct.

How can I help?

All kinds of contributions are welcome 🙌! The most basic way to show your support is to star 🌟 the project, or to raise issues 💬. You can also support this project by becoming a sponsor on GitHub 👏 or by making a bitcoin donation to ensure this journey continues indefinitely! 🚀

License