Skip to main content
Widget Pro is the dashboard layout of the yield widget. It is the same @stakekit/widget package with one prop, dashboardVariant, turned on. Instead of the compact single-flow widget, users get a full app: yields grouped by category, a details pane, positions and activity, and Borrow when you enable it.

Widget or Widget Pro

Turn it on

Install the widget as described in Embed the yield widget, then add dashboardVariant:
The demo uses this configuration. With the browser renderer, pass the same props to renderSKWidget.

What the dashboard adds

  • Tab bar. The Earn category tabs, then Borrow when it is enabled, then Manage and Activity.
  • Yields by category. dashboardVariant sets yieldGrouping to "category". Set dashboardYieldCategoryOrder to change the order, for example ["stake", "defi", "rwa"]; categories you leave out follow in the default order. The DashboardYieldCategory export lists the valid values.
  • Details pane. Selecting a yield, position or activity row opens its details beside the list. On narrow screens the panes collapse into one view.
  • Header. Shows an account and chain selector. Hide it with hideAccountAndChainSelector when your app already shows the connected wallet.
  • Borrow. Add borrowEnabled to show the Borrow tab and Borrow positions. See the Borrow widget guide for the requirements.

Common props

validatorsConfig takes a network id, or "*" for every network without its own entry:
Every other prop works as it does in the classic layout; see the configuration reference.

Theme and analytics

To change a few tokens of a built-in theme, merge your overrides onto it:
Pass brandLightTheme or brandDarkTheme to theme based on your app’s color mode. To send the widget’s events to your analytics, pass a tracking object:
HelpModal opens the widget’s own help dialogs from any element you choose. Render it as a child of SKApp, so it shares the widget’s runtime and tracking:

Verify

Open your page and check that:
  • The category tabs show your project’s yields, matching GET /v1/yields for the same API key.
  • Connecting a wallet fills Manage with its positions.
  • Activity lists past actions.
  • With borrowEnabled, the Borrow tab lists markets on a Borrow network.

Next steps

Embed the yield widget

Install, wallets, theming and every prop.

Borrow widget

Requirements and the wallet adapter for Borrow.