Skip to content
ZikZuk UI

OverviewPage

Stripe OverviewPage + PageModule

A feature's landing page: key figures and charts in the primary column; tasks, insights, quick links and help in an optional 20rem secondary column that stacks below on smaller screens. Columns hold PageModules — a title, an optional subtitle and text-link actions over a hairline.

pnpm add @zikzuk/ui
import { OverviewPage, PageModule } from "@zikzuk/ui";

Wallets

Wallets

Money you hold for your customers.

Balances

Last 30 days

Total held
₹4,82,190
Wallets
128
Top-ups
312

Recent wallets

When to use

  • The first page of a feature (Wallets, Messaging) before anyone opens a record.
  • PageModule actions are teal text links — “View all” with href, “Create” with onPress.
  • pending shows a skeleton with the same number of columns as the loaded page.

Not for

  • A record — use DetailLayout.
  • A plain list — PageHeader over a table.

Props

OverviewPage

PropTypeDescription
headerReactNodeUsually a PageHeader; stays visible while pending.
primaryColumnReactNodePageModules with figures and charts.
secondaryColumnReactNodePageModules with tasks, links and help. 20rem from xl.
pendingboolean
Default false
A skeleton with the same columns.
classNamestringExtra classes on the outer element.

PageModule

PropTypeDescription
titleReactNodeThe module's heading.
subtitleReactNodeOne grey line under it.
extraActionsPageModuleAction[]{ label, onPress | href, disabled, type } — text links; type "destructive" is red.
childrenReactNodeThe content.
contentClassNamestringClasses on the content wrapper.
classNamestringExtra classes on the outer element.