API Reference

PhotoProvider

Name	Description	Type	Default
`children`		React.ReactNode	Required
`onIndexChange`		(index: number, state: PhotoProviderState) => void
`onVisibleChange`		(visible: boolean, index: number, state: PhotoProviderState) => void
`loop`	Enable loop preview, number enables when count exceeds value	boolean \| number	3
`speed`	Animation speed	(type: ActiveAnimationType) => number	() => 400
`easing`	Easing function	(type: ActiveAnimationType) => string	() => 'cubic-bezier(0.25, 0.8, 0.25, 1)'
`photoClosable`	Whether clicking the image can close	boolean
`maskClosable`	Whether clicking the backdrop can close	boolean	true
`maskOpacity`	Default backdrop opacity	number \| null	1
`pullClosable`	Whether pull-down can close	boolean	true
`bannerVisible`	Navigation bar visible	boolean	true
`overlayRender`	Custom overlay render	(props: OverlayRenderProps) => React.ReactNode
`toolbarRender`	Custom toolbar render	(props: OverlayRenderProps) => React.ReactNode
`className`		string
`maskClassName`		string
`photoWrapClassName`		string
`photoClassName`		string
`loadingElement`	Custom loading element	JSX.Element
`brokenElement`	Custom error element	JSX.Element \| ((props: BrokenElementParams) => JSX.Element)
`portalContainer`	Custom portal target	HTMLElement	document.body

Name	Description	Type	Default
`src`	Image URL	string
`render`	Custom render function (lower priority than src)	(props: PhotoRenderParams) => React.ReactNode
`overlay`	Overlay node	React.ReactNode
`width`	Custom render node width	number
`height`	Custom render node height	number
`children`	Child node, typically a thumbnail	React.ReactElement
`triggers`	Trigger events	('onClick' \| 'onDoubleClick')[]	['onClick']

Name	Description	Type	Default
`key`	Unique identifier	number \| string	Required
`src`	Resource URL	string
`render`	Custom render function	(props: PhotoRenderParams) => React.ReactNode
`overlay`	Overlay node	React.ReactNode
`width`	Custom render node width	number
`height`	Custom render node height	number
`originRef`	Trigger ref	React.MutableRefObject<HTMLElement \| null>

Name	Description	Type
`images`	Image list	DataType[]
`index`	Current index	number
`onIndexChange`	Index change callback	(index: number) => void
`visible`	Whether visible	boolean
`onClose`	Close event callback	(evt?: React.MouseEvent \| React.TouchEvent) => void
`overlayVisible`	Whether overlay is visible	boolean
`overlay`	Overlay node	React.ReactNode
`rotate`	Current rotation angle	number
`onRotate`	Rotation callback	(rotate: number) => void
`scale`	Current scale	number
`onScale`	Scale callback	(scale: number) => void