相册浏览器 React 组件
相册浏览器是一个用于显示照片/图像集合的相册组件。照片可以缩放和平移(可选)。
相册浏览器 React 组件代表了 Framework7 的照片浏览器组件。
相册浏览器 React 组件不会渲染任何输出。它可用于创建 JS 相册浏览器实例并在您的 React 组件内部控制它。
相册浏览器组件
包含以下组件:
PhotoBrowser
相册浏览器属性
您可以在单个属性中传递所有参数params
属性或使用单独的 prop 为每个参数指定它们通过组件属性:
属性 | 类型 | 默认 | 描述 |
---|---|---|---|
<PhotoBrowser> 属性 | |||
init | 布尔值 | true | 初始化相册浏览器 |
参数 | 对象 | 带有相册浏览器参数 | |
photos | 数组 | [] | 包含照片 URL 的数组或包含 "url"(或 "html")和 "caption" 属性的对象数组。 |
thumbs | 数组 | [] | 包含缩略图图像 URL 的数组。如果未指定,或为空数组,则不会渲染缩略图 |
url | 字符串 | photos/ | 相册浏览器模态 URL 将被设置为当前路由 |
routableModals | 布尔值 | false | 将打开的相册浏览器添加到路由历史记录中,这提供了通过在路由历史记录中后退来关闭相册浏览器的功能,并将当前路由设置为相册浏览器模态 |
swiper | 对象 | 具有 Swiper 参数的对象。默认等于:
| |
virtualSlides | 布尔值 | true | 当启用时,Swiper 将使用虚拟幻灯片 |
closeByBackdropClick | 布尔值 | true | 当启用时,相册浏览器弹出窗口将在点击背景时关闭 |
exposition | 布尔值 | true | 在点击相册浏览器时启用/禁用展览模式。 |
expositionHideCaptions | 布尔值 | false | 如果您还想在展览模式下隐藏标题,请将其设置为 true |
swipeToClose | 布尔值 | true | 当启用此参数时,您可以用向上/向下滑动关闭相册浏览器 |
type | 字符串 | standalone | 定义相册浏览器应如何打开。可以是standalone (将作为具有自定义过渡效果的覆盖层打开),popup (将作为弹出窗口打开),page (将注入到 View 并作为新页面加载)。 |
主题 | 字符串 | light | 相册浏览器颜色主题,可以是light 或dark |
captionsTheme | 字符串 | 标题颜色主题,也可以是dark 或light 。默认等于 "theme" 参数 | |
navbar | 布尔值 | true | 设置为 false 以移除相册浏览器的 Navbar |
toolbar | 布尔值 | true | 设置为 false 以移除相册浏览器的 Toolbar |
pageBackLinkText | 字符串 | Back | 相册浏览器 Navbar 中的后退链接文本 |
popupCloseLinkText | 字符串 | Close | 在弹出窗口或作为 Standalone 打开时,相册浏览器 Navbar 中的关闭链接文本 |
navbarShowCount | 布尔值 | undefined | 定义是否应在 Navbar 标题中显示 "3 of 5" 文本。如果未指定(undefined),则如果有超过 1 个项目,它将显示此文本 |
navbarOfText | 字符串 | of | 照片计数中的 "of" 文本:"3 of 5" |
iconsColor | 字符串 | 之一默认颜色之一 |
相册浏览器事件
事件 | 描述 |
---|---|
<PhotoBrowser> 事件 | |
photoBrowserOpen | 当相册浏览器打开时,将触发此事件。 |
photoBrowserOpened | 相册浏览器完成打开动画后,将触发此事件 |
photoBrowserClose | 当相册浏览器关闭时,将触发此事件。 |
photoBrowserClosed | 相册浏览器完成关闭动画后,将触发此事件 |
photoBrowserSwipeToClose | 当用户用向上/向下滑动关闭相册浏览器时,将触发此事件。 |
相册浏览器方法
以下相册浏览器组件方法可用(例如,通过ref)访问:
<PhotoBrowser> 方法 | |
---|---|
.open(index) | 在具有等于 "index" 参数索引号的相册浏览器上打开。如果未指定 "index" 参数,它将在最后一个关闭的相册上打开。 |
.close() | 关闭相册浏览器 |
.expositionToggle() | 切换展览模式 |
.expositionEnable() | 启用展览模式 |
.expositionDisable() | 禁用展览模式 |
示例
photo-browser.jsx
import React, { useRef } from 'react';
import { Navbar, Page, PhotoBrowser, Block, Button } from 'framework7-react';
export default () => {
const standalone = useRef(null);
const popup = useRef(null);
const page = useRef(null);
const standaloneDark = useRef(null);
const popupDark = useRef(null);
const pageDark = useRef(null);
const photos = [
{
url: 'img/beach.jpg',
caption: 'Amazing beach in Goa, India',
},
'http://placekitten.com/1024/1024',
'img/lock.jpg',
{
url: 'img/monkey.jpg',
caption: 'I met this monkey in Chinese mountains',
},
{
url: 'img/mountains.jpg',
caption: 'Beautiful mountains in Zhangjiajie, China',
},
];
const thumbs = [
'img/beach.jpg',
'http://placekitten.com/1024/1024',
'img/lock.jpg',
'img/monkey.jpg',
'img/mountains.jpg',
];
return (
<Page>
<Navbar title="Photo Browser"></Navbar>
<Block strongIos outlineIos>
<p>
Photo Browser is a standalone and highly configurable component that allows to open window
with photo viewer and navigation elements with the following features:
</p>
<ul>
<li>Swiper between photos</li>
<li>Multi-gestures support for zooming</li>
<li>Toggle zoom by double tap on photo</li>
<li>Single click on photo to toggle Exposition mode</li>
</ul>
</Block>
<Block strongIos outlineIos>
<p>
Photo Browser could be opened in a three ways - as a Standalone component (Popup
modification), in Popup, and as separate Page:
</p>
<div className="grid grid-cols-3 grid-gap">
<div>
<PhotoBrowser photos={photos} thumbs={thumbs} ref={standalone} />
<Button fill onClick={() => standalone.current.open()}>
Standalone
</Button>
</div>
<div>
<PhotoBrowser photos={photos} thumbs={thumbs} type="popup" ref={popup} />
<Button fill onClick={() => popup.current.open()}>
Popup
</Button>
</div>
<div>
<PhotoBrowser
photos={photos}
thumbs={thumbs}
type="page"
pageBackLinkText="Back"
ref={page}
/>
<Button fill onClick={() => page.current.open()}>
Page
</Button>
</div>
</div>
</Block>
<Block strongIos outlineIos>
<p>
Photo Browser supports 2 default themes - default Light (like in previous examples) and
Dark theme. Here is a Dark theme examples:
</p>
<div className="grid grid-cols-3 grid-gap">
<div>
<PhotoBrowser photos={photos} thumbs={thumbs} theme="dark" ref={standaloneDark} />
<Button fill onClick={() => standaloneDark.current.open()}>
Standalone
</Button>
</div>
<div>
<PhotoBrowser
photos={photos}
thumbs={thumbs}
theme="dark"
type="popup"
ref={popupDark}
/>
<Button fill onClick={() => popupDark.current.open()}>
Popup
</Button>
</div>
<div>
<PhotoBrowser
photos={photos}
thumbs={thumbs}
theme="dark"
type="page"
pageBackLinkText="Back"
ref={pageDark}
/>
<Button fill onClick={() => pageDark.current.open()}>
Page
</Button>
</div>
</div>
</Block>
</Page>
);
};