@get-asset/react
AssetRevenueCard
Drop-in styled card for the period's revenue and its period-over-period change, with built-in loading, empty, and error states. Period defaults to the AssetProvider's year/month.
Built on the headless RevenueCard compound from @get-asset/sdk.
Preview
Revenue
$125,000.00
28%
from prior period
Required scopes
The access token used by AssetProvider must include this scope for this primitive to fetch data successfully:
report:read
API reference
Root props
| Prop | Type | Default | Description |
|---|---|---|---|
year | number | — | Fiscal year to report on. Falls back to the AssetProvider's year. |
month | number | null | — | Month (1-12). When set the card shows that month vs. the previous month; null explicitly forces a whole-year range. Falls back to the AssetProvider's month (default: no month). |
revenue | number | — | Override fetched revenue. Skips the API call. |
previousRevenue | number | — | Override fetched prior-period revenue. |
state | "loading" | "error" | — | Force a specific state for testing. |
locked | boolean | — | Gate the report for a viewer who isn't entitled to it. Activates the SDK's Locked state: the metric renders blurred and inert as a teaser behind a lock and the upgrade CTA. No live fetch runs while locked — the teaser shows built-in placeholder data (a `revenue` override still wins). |
upsell | { title?, description?, ctaLabel?, onUpgrade? } | — | Customize the locked state's copy and action. `ctaLabel` and `onUpgrade` are the tenant's upgrade wording and handler; `title` / `description` default per report. |
className | string | — | Forwarded to the outer card element. |
States
LoadingFetch in flight.
Revenue
from prior period
SuccessYear-over-year increase.
Revenue
$125,000.00
28%
from prior period
ErrorFetch failed; retry button surfaces.
Revenue
We couldn't load your Revenue. Refresh the page or click try again.
LockedViewer isn't entitled to the report — a built-in placeholder teaser renders blurred behind the upgrade prompt. Pass `upsell` to customize the copy and wire `onUpgrade`.