Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tonicpow/widget-react
React component for using the TonicPow widget and share buttons
https://github.com/tonicpow/widget-react
bitcoin bsv javascript react tonic tonicpow widget
Last synced: 7 days ago
JSON representation
React component for using the TonicPow widget and share buttons
- Host: GitHub
- URL: https://github.com/tonicpow/widget-react
- Owner: tonicpow
- License: other
- Created: 2021-05-03T15:12:09.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-05-16T10:35:54.000Z (6 months ago)
- Last Synced: 2024-05-21T11:50:01.458Z (6 months ago)
- Topics: bitcoin, bsv, javascript, react, tonic, tonicpow, widget
- Language: TypeScript
- Homepage:
- Size: 26.2 MB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# Widget (React Component)
> Easy integration using React
[](https://github.com/tonicpow/widget-react/commits/master)
[](https://github.com/tonicpow/widget-react/releases)
[](https://github.com/tonicpow/widget-react/actions)
[](https://mergify.io)
[](https://github.com/sponsors/TonicPow)
[](https://atlantistic.slack.com/app_redirect?channel=tonicpow)
[](https://www.npmjs.com/package/@tonicpow/widget-react)
## 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](https://tonicpow.com/guides/promoters/create-widget)
- Create [share button](https://tonicpow.com/guides/developers/share-buttons) widgets
## Installation
```shell script
yarn
```
## Documentation
Read more about the [TonicPow API](https://docs.tonicpow.com) 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](https://github.com/tonicpow/widget-react/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 |
Library Deployment
[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.
Makefile Commands
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
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](https://tonicpow.com/guides/promoters/create-widget)
## 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.
```shell script
yarn storybook
```
To use this in your project, just do
```
import TonicPowWidget from "@tonicpow/widget-react"
```
We are using it! Visit [our website](https://tonicpow.com) to see it in action.
## Maintainers
| [
](https://github.com/mrz1836) | [
](https://github.com/rohenaz) |
|:------------------------------------------------------------------------------------------------:|:----------------------------------------------------------------------------------------------------:|
| [MrZ](https://github.com/mrz1836) | [Satchmo](https://github.com/rohenaz) |
## 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-react&utm_term=widget-react&utm_content=widget-react) to ensure this journey continues indefinitely! :rocket:
## License
[](/LICENSE)