## đšī¸ StarknetKit
Install starknetkit with `npm` or `yarn`
```bash
# latest official release (main branch)
$ npm install starknetkit
# or with yarn:
$ yarn add starknetkit
```
## Imports
After installation, we get access to different methods, such as `connect`, `disconnect`, etc which we should import for use in our application:
```js
import { connect, disconnect } from "starknetkit"
```
## Establishing a connection
To establish a wallet connection, we need to call the connect method which was imported earlier like this:
```js
const wallet = await connect()
```
By default, the list of connectors is:
- Ready Wallet
- Braavos
- Ready (formerly Argent)
- Web Wallet
## Connect with specific connectors
```js
const webwallet = await connect([new WebWalletConnector()])
const argentMobileWallet = await connect([
new ArgentMobileConnector()
])
const wallet = await connect([
new InjectedConnector({ options: { id: "argentX" } }),
new InjectedConnector({ options: { id: "braavos" } })
])
```
## Reconnect to a previously connected wallet on load:
```js
const wallet = await connect({ modalMode: "neverAsk" })
```
## Disconnect a wallet
```js
await disconnect({ clearLastWallet: true })
```
## Handle webwallet logout
In your application, import `handleWebwalletLogoutEvent` and pass a callback to manage the state of your dapp
```js
useEffect(() => {
handleWebwalletLogoutEvent(() => {
// clear state
})
}, [])
```
## Listen to account change
```js
const selectedConnectorWallet = getSelectedConnectorWallet()
selectedConnectorWallet.on("accountsChanged", () => {
setWallet(prevState => {
const updatedWallet = { ...prevState }
updatedWallet.account = selectedConnectorWallet.account
return updatedWallet
})
})
```
## đ Guides
Guides can be found [here](https://www.starknetkit.com/docs)
## âī¸ Contributing
If you consider to contribute to this project please read [CONTRIBUTING.md](./CONTRIBUTING.md) first.
## đ License
Copyright (c) 2023
Licensed under the [MIT license](./LICENSE.md).