@trustswap/web-widgets v1.1.34
Team Finance widget collection
This is a collection of widgets related to Team Finance ecosystem.
Powered by
Getting Started
You will need:
- NodeJS latest LTS version. Actually it also works with Node 18, but latest LTS is recommended. On Linux / Mac, we recommend using nodenv
Deploy with Docker
WIP, but the simplest command should be:
docker build -f Dockerfile -t tf-widgets .
docker run -it --rm -d -p 8080:80 --name=tf-widgets-impl tf-widgets
Install with npm
- Run the command:
How to test locally
- Clone the project:
git clone https://github.com/trustswap/teamfinance-widgets.git
cd teamfinance-widgets
- Install dependencies:
npm ci
- Run the dev server
npm run build:library
npm run dev
Usage
Using npm
Here’s how you can integrate the widget into your project:
Install the package:
npm i @trustswap/web-widgets
or
yarn add @trustswap/web-widgets
then use it:
import { StakingWidget } from "@trustswap/web-widgets";
const chainId = 97;
const poolAddress = "YOUR_CONTRACT_ADDRESS";
const poolId = 1;
export default function App() {
return (
<StakingWidget
chainId={chainId}
poolId={poolId}
stakingPoolAddress={poolAddress}
themeConfig={{
primaryColor: "#bf6636",
container: "#F6F6FA",
}}
/>
);
}
Note that bundle size is quite large because of bundled styling (from Mantine) and the Connectkit library. A trimmed version is planned.
Using embeddable JS script
Please refer to test.html
for the usage. This project use Web Component so it can be used in any websites, not just React.
You need to add 2 HTML tags for it to work though. First is the script, it looks like:
<script
src="https://teamfinance-widgets.onrender.com/assets/js/widget.js"
type="module"
></script>
the second is the Web Component placeholder, which is like:
<staking-widget applicationId="test-1" />
Contributing
- Checkout a branch from
main
branch and create a PR from there. - Change the code.
- Run the lint, using
npm run lint
. Lefthook does this automatically for you but it's a good practice to do it usually. - Create a PR with short but easy to understand description.
- If you want to make a release, bump the version in
package.json
. It will be auto-published if its version is different with current NPM version.
4 days ago
6 days ago
6 days ago
6 days ago
6 days ago
6 days ago
6 days ago
6 days ago
6 days ago
6 days ago
6 days ago
7 days ago
10 days ago
10 days ago
10 days ago
10 days ago
10 days ago
10 days ago
10 days ago
10 days ago
10 days ago
10 days ago
10 days ago
10 days ago
10 days ago
10 days ago
10 days ago
10 days ago
10 days ago
10 days ago
10 days ago
10 days ago
10 days ago
10 days ago
13 days ago
13 days ago