Skip to main content

​
Overview

The useView hook provides information about the current view mode (modal or default) and any associated parameters.

​
Import

import { useView } from 'sunpeak';

​
Signature

function useView(): View | null

​
Returns

​
return
View | null
A View object, or null if not available.
{
  mode: 'modal' | 'default',
  params?: Record<string, unknown>
}

​
Usage

import { useView } from 'sunpeak';

function MyWidget() {
  const view = useView();

  return (
    <div>
      {view?.mode === 'modal' ? 'Modal View' : 'Default View'}
    </div>
  );
}