live · mainnetoc · docs
specs · api · guides
docs / documentation

@orangecheck/react


@orangecheck/react / OcBadgeProps

Interface: OcBadgeProps

Defined in: src/badge.tsx:25

Properties

PropertyTypeDescriptionDefined in
<a id="property-address"></a> addressstringBitcoin address the proof is bound to.src/badge.tsx:27
<a id="property-algorithm"></a> algorithm?ScoringAlgorithmScoring display mode. Default v0.src/badge.tsx:35
<a id="property-classname"></a> className?stringExtra className passed through to the root element.src/badge.tsx:43
<a id="property-days"></a> daysnumberDays unspent.src/badge.tsx:31
<a id="property-hidescore"></a> hideScore?booleanHide the score entirely; show only raw metrics.src/badge.tsx:41
<a id="property-sats"></a> satsnumberSats bonded (from the sats field of a CheckResult or sats_bonded of a VerifyOutcome.metrics).src/badge.tsx:29
<a id="property-score"></a> score?numberOptional reference score (from score). Computed from sats/days if omitted.src/badge.tsx:33
<a id="property-style"></a> style?CSSPropertiesInline style override.src/badge.tsx:45
<a id="property-theme"></a> theme?"light" | "dark"Colour theme. Default light.src/badge.tsx:39
<a id="property-variant"></a> variant?"compact" | "card"Visual variant. Default compact.src/badge.tsx:37