Sanity Library Reference Docs
Preparing search index...
sanity
presentation
PreviewHeaderProps
Interface PreviewHeaderProps
interface
PreviewHeaderProps
{
canSharePreviewAccess
:
boolean
;
canToggleSharePreviewAccess
:
boolean
;
canUseSharedPreviewAccess
:
boolean
;
header
?:
HeaderOptions
;
iframeRef
:
RefObject
<
HTMLIFrameElement
>
;
initialUrl
:
URL
;
loadersConnection
:
ConnectionStatus
;
navigatorEnabled
:
boolean
;
onPathChange
:
(
nextPath
:
string
)
=>
void
;
onRefresh
:
(
fallback
:
()
=>
void
)
=>
void
;
openPopup
:
(
url
:
string
)
=>
void
;
overlaysConnection
:
ConnectionStatus
;
perspective
:
PresentationPerspective
;
presentationRef
:
ActorRef
;
previewUrl
?:
string
;
previewUrlRef
:
ActorRef
;
renderDefault
:
(
props
:
PreviewHeaderProps
)
=>
Element
;
setViewport
:
(
mode
:
"desktop"
|
"mobile"
)
=>
void
;
targetOrigin
:
string
;
toggleNavigator
?:
()
=>
void
;
toggleOverlay
:
()
=>
void
;
vercelProtectionBypass
:
string
;
viewport
:
PresentationViewport
;
}
Hierarchy (
View Summary
)
PreviewProps
PreviewHeaderProps
Index
Properties
can
Share
Preview
Access
can
Toggle
Share
Preview
Access
can
Use
Shared
Preview
Access
header?
iframe
Ref
initial
Url
loaders
Connection
navigator
Enabled
on
Path
Change
on
Refresh
open
Popup
overlays
Connection
perspective
presentation
Ref
preview
Url?
preview
Url
Ref
render
Default
set
Viewport
target
Origin
toggle
Navigator?
toggle
Overlay
vercel
Protection
Bypass
viewport
Properties
can
Share
Preview
Access
canSharePreviewAccess
:
boolean
can
Toggle
Share
Preview
Access
canToggleSharePreviewAccess
:
boolean
can
Use
Shared
Preview
Access
canUseSharedPreviewAccess
:
boolean
Optional
header
header
?:
HeaderOptions
iframe
Ref
iframeRef
:
RefObject
<
HTMLIFrameElement
>
initial
Url
initialUrl
:
URL
loaders
Connection
loadersConnection
:
ConnectionStatus
navigator
Enabled
navigatorEnabled
:
boolean
on
Path
Change
onPathChange
:
(
nextPath
:
string
)
=>
void
on
Refresh
onRefresh
:
(
fallback
:
()
=>
void
)
=>
void
open
Popup
openPopup
:
(
url
:
string
)
=>
void
overlays
Connection
overlaysConnection
:
ConnectionStatus
perspective
perspective
:
PresentationPerspective
presentation
Ref
presentationRef
:
ActorRef
Optional
preview
Url
previewUrl
?:
string
preview
Url
Ref
previewUrlRef
:
ActorRef
render
Default
renderDefault
:
(
props
:
PreviewHeaderProps
)
=>
Element
set
Viewport
setViewport
:
(
mode
:
"desktop"
|
"mobile"
)
=>
void
target
Origin
targetOrigin
:
string
Optional
toggle
Navigator
toggleNavigator
?:
()
=>
void
toggle
Overlay
toggleOverlay
:
()
=>
void
vercel
Protection
Bypass
vercelProtectionBypass
:
string
viewport
viewport
:
PresentationViewport
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
can
Share
Preview
Access
can
Toggle
Share
Preview
Access
can
Use
Shared
Preview
Access
header
iframe
Ref
initial
Url
loaders
Connection
navigator
Enabled
on
Path
Change
on
Refresh
open
Popup
overlays
Connection
perspective
presentation
Ref
preview
Url
preview
Url
Ref
render
Default
set
Viewport
target
Origin
toggle
Navigator
toggle
Overlay
vercel
Protection
Bypass
viewport
Sanity Library Reference Docs
Loading...