arkada-widgets 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +65 -0
- package/dist/index.cjs +1819 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.css +123 -0
- package/dist/index.css.map +1 -0
- package/dist/index.d.cts +53 -0
- package/dist/index.d.ts +53 -0
- package/dist/index.js +1791 -0
- package/dist/index.js.map +1 -0
- package/package.json +70 -0
package/README.md
ADDED
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
# arkada-widgets
|
|
2
|
+
|
|
3
|
+
Production-ready widget library for the Arkada ecosystem. Widgets are available as standard React components and as self-contained Web Components for framework-agnostic embedding.
|
|
4
|
+
|
|
5
|
+
## Table of Contents
|
|
6
|
+
|
|
7
|
+
- [Widgets (Start Here)](#widgets-start-here)
|
|
8
|
+
- [WalletVerificationButton](./docs/widgets/wallet-verification-button.md)
|
|
9
|
+
- [Installation](#installation)
|
|
10
|
+
- [Documentation](./docs/)
|
|
11
|
+
- [Architecture](./docs/architecture.md)
|
|
12
|
+
- [Web Components](./docs/web-components.md)
|
|
13
|
+
- [TypeScript](#typescript)
|
|
14
|
+
- [Troubleshooting](#troubleshooting)
|
|
15
|
+
|
|
16
|
+
---
|
|
17
|
+
|
|
18
|
+
## Installation
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
npm install arkada-widgets
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
---
|
|
25
|
+
|
|
26
|
+
## Widgets (Start Here)
|
|
27
|
+
|
|
28
|
+
Widget docs are prioritized for integrators:
|
|
29
|
+
|
|
30
|
+
- `WalletVerificationButton` docs: `./docs/widgets/wallet-verification-button.md`
|
|
31
|
+
|
|
32
|
+
---
|
|
33
|
+
|
|
34
|
+
## TypeScript
|
|
35
|
+
|
|
36
|
+
All types are included. No `@types/` package needed.
|
|
37
|
+
|
|
38
|
+
```ts
|
|
39
|
+
import type {
|
|
40
|
+
WalletVerificationButtonProps,
|
|
41
|
+
VerifyWalletVariant,
|
|
42
|
+
} from "arkada-widgets";
|
|
43
|
+
|
|
44
|
+
import { VerifyWalletVariants } from "arkada-widgets";
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
---
|
|
48
|
+
|
|
49
|
+
## Troubleshooting
|
|
50
|
+
|
|
51
|
+
**The button always shows "unverified"**
|
|
52
|
+
|
|
53
|
+
- Check the browser network tab — is `GET /public/wallet/status/{address}` being called?
|
|
54
|
+
- Verify `ARKADA_PUBLIC_API_URL` is set correctly and the API is reachable.
|
|
55
|
+
- Check the browser console for a `[WalletVerificationButton]` warning (visible in development builds).
|
|
56
|
+
|
|
57
|
+
**Web component is not rendering**
|
|
58
|
+
|
|
59
|
+
- Confirm the script is loaded with `type="module"` before the custom element is used.
|
|
60
|
+
- Confirm `data` attribute is valid JSON with a `walletAddress` key.
|
|
61
|
+
- Custom elements require a browser that supports Web Components (all modern browsers).
|
|
62
|
+
|
|
63
|
+
**React version mismatch**
|
|
64
|
+
|
|
65
|
+
- The package requires React 18 or 19 as a peer dependency. Run `npm ls react` to confirm the installed version.
|