@orangecheck/react / OcGateProps
Interface: OcGateProps
Defined in: src/gate.tsx:23
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
<a id="property-address"></a> address? | string | Bitcoin address. Pick one of address / attestationId / identity. | src/gate.tsx:25 |
<a id="property-attestationid"></a> attestationId? | string | Attestation ID (SHA-256 hex). | src/gate.tsx:27 |
<a id="property-children"></a> children? | | ReactNode | ((result: CheckResult) => ReactNode) | Rendered when the check passes. The resolved CheckResult is passed through. | src/gate.tsx:37 |
<a id="property-fallback"></a> fallback? | | ReactNode | ((result: CheckResult | null) => ReactNode) | Rendered when the check fails. Receives the CheckResult so you can explain why. | src/gate.tsx:41 |
<a id="property-identity"></a> identity? | { identifier: string; protocol: string; } | Identity binding, e.g. { protocol: 'github', identifier: 'alice' }. | src/gate.tsx:29 |
identity.identifier | string | - | src/gate.tsx:29 |
identity.protocol | string | - | src/gate.tsx:29 |
<a id="property-loading"></a> loading? | ReactNode | Rendered while the check is pending. Default null. | src/gate.tsx:39 |
<a id="property-mindays"></a> minDays? | number | Minimum days unspent. Default 0. | src/gate.tsx:34 |
<a id="property-minsats"></a> minSats? | number | Minimum sats bonded. Default 0. | src/gate.tsx:32 |
<a id="property-onresult"></a> onResult? | (result: CheckResult) => void | Optional callback when the check resolves (pass or fail). | src/gate.tsx:44 |
<a id="property-relays"></a> relays? | string[] | Override discovery relays. | src/gate.tsx:47 |