树形视图 Svelte 组件
树形视图 Svelte 组件表示 Framework7 的树视图组件。
树形视图组件
包含以下组件:
Treeview- 主树形视图容器TreeviewItem- 树形视图项
树形视图属性
| 属性 | 类型 | 默认 | 描述 |
|---|---|---|---|
| <TreeviewItem> 属性 | |||
| toggle | 布尔值 | 启用树形视图项切换按钮。默认情况下,如果有子项则启用 | |
| itemToggle | 布尔值 | false | 启用整个树形视图项作为切换 |
| selectable | 布尔值 | false | 使项可选 |
| selected | 布尔值 | 使项被选中 | |
| opened | 布尔值 | false | 定义项默认是否展开 |
| label | 字符串 | 项标签文本 | |
| loadChildren | 布尔值 | false | 当需要在打开时加载子项时启用。 |
| link | 字符串 布尔值 | 启用链接和链接 URL(如果指定为字符串)。与href属性 | |
| <TreeviewItem> 图标相关属性 | |||
| iconSize | 字符串 数字 | 图标大小(像素) | |
| iconColor | 字符串 | 图标颜色。可以是默认颜色之一 | |
| icon | 字符串 | 自定义图标类 | |
| iconF7 | 字符串 | F7 图标字体图标的名称 | |
| iconMaterial | 字符串 | Material 图标字体图标的名称 | |
| iconIos | 字符串 | 在使用 iOS 主题时使用的图标。由图标系列和图标名称组成,例如f7:house | |
| iconMd | 字符串 | 在使用 MD 主题时使用的图标。由图标系列和图标名称组成,例如material:home | |
| <TreeviewItem> 导航/路由相关属性 | |||
| href | 字符串 布尔值 | # | 要加载的页面的 URL。如果是布尔值href="false"则不会添加hreftag |
| target | 字符串 | 链接目标属性值,例如_blank, _self,等等。 | |
| view | 字符串 | 要加载页面的视图的 CSS 选择器。或者current在当前视图中加载。 | |
| external | 布尔值 | 启用以绕过 Framework7 的链接点击处理程序 | |
| back | 布尔值 | 启用返回导航链接 | |
| openIn | 字符串 | 允许将页面路由作为模态或面板打开。可以是popup, loginScreen, sheet, popover或panel | |
| force | 布尔值 | 强制页面加载并忽略历史记录中的先前页面(与back属性一起使用) | |
| reloadCurrent | 布尔值 | 重新加载新页面而不是当前活动的页面 | |
| reloadPrevious | 布尔值 | 用路由中的新页面替换历史记录中的先前页面 | |
| reloadAll | 布尔值 | 加载新页面并从历史记录和 DOM 中删除所有先前页面 | |
| reloadDetail | 布尔值 | 在主/详细信息视图中重新加载详细信息页面 | |
| animate | 布尔值 | 禁用页面动画 | |
| transition | 字符串 | 自定义页面过渡的名称custom page transition | |
| ignoreCache | 布尔值 | 忽略缓存 | |
| routeTabId | 字符串 | 可路由选项卡 ID | |
| routeProps | 对象 | 将传递给目标路由组件的附加属性对象 | |
| preventRouter | 布尔值 | false | 如果设置,则不会被 Framework7 路由器处理 |
| <TreeviewItem> 操作相关属性 | |||
| panelOpen | 字符串 布尔值 | 点击时打开的面板的 CSS 选择器。或者可以是left或right如果 DOM 中只有左侧或右侧面板。 | |
| panelClose | 字符串 布尔值 | 点击时关闭面板 | |
| panelToggle | 字符串 布尔值 | 点击时切换的面板的 CSS 选择器。或者可以是left或right如果 DOM 中只有左侧或右侧面板。 | |
| actionsOpen | 字符串 布尔值 | 点击时打开的操作表的 CSS 选择器 | |
| actionsClose | 字符串 布尔值 | 点击时关闭的操作表的 CSS 选择器。或者为关闭当前打开的操作表的布尔属性 | |
| popupOpen | 字符串 布尔值 | 点击时打开的弹出的 CSS 选择器 | |
| popupClose | 字符串 布尔值 | 点击时关闭的弹出的 CSS 选择器。或者为关闭当前打开的弹出的布尔属性 | |
| popoverOpen | 字符串 布尔值 | 点击时打开的弹出窗口的 CSS 选择器 | |
| popoverClose | 字符串 布尔值 | 点击时关闭的弹出窗口的 CSS 选择器。或者为关闭当前打开的弹出窗口的布尔属性 | |
| sheetOpen | 字符串 布尔值 | 点击时打开的表单模态的 CSS 选择器 | |
| sheetClose | 字符串 布尔值 | 点击时关闭的表单模态的 CSS 选择器。或者为关闭当前打开的表单模态的布尔属性 | |
| loginScreenOpen | 字符串 布尔值 | 点击时打开的登录屏幕的 CSS 选择器 | |
| loginScreenClose | 字符串 布尔值 | 点击时关闭的登录屏幕的 CSS 选择器。或者为关闭当前打开的登录屏幕的布尔属性 | |
| sortableEnable | 字符串 布尔值 | 点击时启用的可排序列表的 CSS 选择器 | |
| sortableDisable | 字符串 布尔值 | 点击时禁用的可排序列表的 CSS 选择器。或者为关闭当前打开的可排序列表的布尔属性 | |
| sortableToggle | 字符串 布尔值 | 点击时切换的可排序列表的 CSS 选择器。或者为切换当前打开/关闭的可排序列表的布尔属性 | |
| searchbarEnable | 字符串 布尔值 | 点击时启用的可展开搜索栏的 CSS 选择器。或者为启用第一个找到的搜索栏的布尔属性 | |
| searchbarDisable | 字符串 布尔值 | 点击时禁用的可展开搜索栏的 CSS 选择器。或者为禁用第一个找到的搜索栏的布尔属性 | |
| searchbarToggle | 字符串 布尔值 | 点击时切换的可展开搜索栏的 CSS 选择器。或者为切换第一个找到的搜索栏的布尔属性 | |
| searchbarClear | 字符串 布尔值 | 点击时清除的可展开搜索栏的 CSS 选择器。或者为清除第一个找到的搜索栏的布尔属性 | |
| cardOpen | 字符串 布尔值 | 点击时打开的可展开卡片的 CSS 选择器。或者为打开第一个找到的可展开卡片的布尔值 | |
| cardClose | 字符串 布尔值 | 点击时关闭的可展开卡片的 CSS 选择器。或者为关闭当前打开的可展开卡片的布尔属性 | |
| cardPreventOpen | 布尔值 | 具有此属性的元素点击不会打开其父可展开卡片 | |
树形视图事件
| 事件 | 描述 |
|---|---|
| <TreeviewItem> 事件 | |
| click | 当用户点击树形视图项时将触发事件 |
| treeviewOpen | 在项展开时将触发事件 |
| treeviewClose | 在项关闭时将触发事件 |
| treeviewLoadChildren | 在具有 prop 的树形视图项首次打开时将触发事件。在loadChildren prop. In event.detail其中包含用于隐藏加载预加载器的函数。 |
树形视图项插槽
树形视图 Svelte 组件 (<TreeviewItem>)具有用于自定义元素的附加插槽:
root-start- 元素将被插入到树形视图项元素的开始处root/root-end- 元素将被插入到树形视图项元素的末尾处content-start- 元素将被插入到<div class="treeview-item-content">元素之前插入元素content/content-end- 元素将被插入到<div class="treeview-item-content">元素之前插入元素children-start- 元素将被插入到<div class="treeview-item-children">元素之前插入元素default- 元素将被插入到<div class="treeview-item-children">元素之前插入元素media- 元素将插入到<div class="treeview-item-label">元素之前插入元素label-start- 元素将被插入到开始处<div class="treeview-item-label">元素之前插入元素label- 元素将被插入到<div class="treeview-item-label">元素之前插入元素
<TreeviewItem label="Item 1">
<img src="path-to-my-image.jpg" slot="media">
<div slot="root-start">Root Start</div>
<div slot="root">Root End</div>
<div slot="content-start">Content Start</div>
<div slot="content">Content End</div>
<span slot="label-start">Before Label</span>
<TreeviewItem label="Sub Item 1" />
...
</TreeviewItem>
<!-- Renders to: -->
<div class="treeview-item">
<div class="treeview-item-root">
<div>Root Start</div>
<div class="treeview-toggle"></div>
<div class="treeview-item-content">
<div>Content Start</div>
<img src="path-to-my-image.jpg">
<div class="treeview-item-label">
<span>Before Label</span>
Item 1
</div>
<div>Content End</div>
</div>
</div>
<div class="treeview-item-children">
<div class="treeview-item">
<div class="treeview-item-root">
<div class="treeview-item-content">
<div class="treeview-item-label">Sub Item 1</div>
</div>
</div>
</div>
...
</div>
<div>Root End</div>
</div>
示例
treeview.svelte
<script>
import {
f7,
Page,
Navbar,
BlockTitle,
Block,
Treeview,
TreeviewItem,
Checkbox,
} from 'framework7-svelte';
let checkboxes = {
images: {
'avatar.png': false,
'background.jpg': false,
},
documents: {
'cv.docx': false,
'info.docx': false,
},
'.gitignore': false,
'index.html': false,
};
let selectedItem = null;
let loadedChildren = [];
function toggleSelectable(e, item) {
const $ = f7.$;
if ($(e.target).is('.treeview-toggle')) return;
selectedItem = item;
}
function loadChildren(done) {
setTimeout(() => {
// call done() to hide preloader
done();
loadedChildren = [
{
name: 'John Doe',
},
{
name: 'Jane Doe',
},
{
name: 'Calvin Johnson',
},
];
}, 2000);
}
</script>
<Page>
<Navbar title="Treeview" />
<BlockTitle>Basic tree view</BlockTitle>
<Block strong outlineIos class="no-padding-horizontal">
<Treeview>
<TreeviewItem label="Item 1">
<TreeviewItem label="Sub Item 1">
<TreeviewItem label="Sub Sub Item 1" />
<TreeviewItem label="Sub Sub Item 2" />
</TreeviewItem>
<TreeviewItem label="Sub Item 2">
<TreeviewItem label="Sub Sub Item 1" />
<TreeviewItem label="Sub Sub Item 2" />
</TreeviewItem>
</TreeviewItem>
<TreeviewItem label="Item 2">
<TreeviewItem label="Sub Item 1">
<TreeviewItem label="Sub Sub Item 1" />
<TreeviewItem label="Sub Sub Item 2" />
</TreeviewItem>
<TreeviewItem label="Sub Item 2">
<TreeviewItem label="Sub Sub Item 1" />
<TreeviewItem label="Sub Sub Item 2" />
</TreeviewItem>
</TreeviewItem>
<TreeviewItem label="Item 3" />
</Treeview>
</Block>
<BlockTitle>With icons</BlockTitle>
<Block strong outlineIos class="no-padding-horizontal">
<Treeview>
<TreeviewItem label="images" iconF7="folder_fill">
<TreeviewItem label="avatar.png" iconF7="photo_fill" />
<TreeviewItem label="background.jpg" iconF7="photo_fill" />
</TreeviewItem>
<TreeviewItem label="documents" iconF7="folder_fill">
<TreeviewItem label="cv.docx" iconF7="doc_text_fill" />
<TreeviewItem label="info.docx" iconF7="doc_text_fill" />
</TreeviewItem>
<TreeviewItem label=".gitignore" iconF7="logo_github" />
<TreeviewItem label="index.html" iconF7="doc_text_fill" />
</Treeview>
</Block>
<BlockTitle>With checkboxes</BlockTitle>
<Block strong outlineIos class="no-padding-horizontal">
<Treeview>
<TreeviewItem label="images" iconF7="folder_fill">
<span slot="content-start">
<Checkbox
checked={Object.values(checkboxes.images).indexOf(false) < 0}
indeterminate={Object.values(checkboxes.images).indexOf(false) >= 0 &&
Object.values(checkboxes.images).indexOf(true) >= 0}
onChange={(e) => {
Object.keys(checkboxes.images).forEach(
(k) => (checkboxes.images[k] = e.target.checked),
);
checkboxes = checkboxes;
}}
/>
</span>
<TreeviewItem label="avatar.png" iconF7="photo_fill" toggle={false}>
<span slot="content-start">
<Checkbox
checked={checkboxes.images['avatar.png']}
onChange={(e) => {
checkboxes.images['avatar.png'] = e.target.checked;
checkboxes = checkboxes;
}}
/>
</span>
</TreeviewItem>
<TreeviewItem label="background.jpg" iconF7="photo_fill" toggle={false}>
<span slot="content-start">
<Checkbox
checked={checkboxes.images['background.jpg']}
onChange={(e) => {
checkboxes.images['background.jpg'] = e.target.checked;
checkboxes = checkboxes;
}}
/>
</span>
</TreeviewItem>
</TreeviewItem>
<TreeviewItem label="documents" iconF7="folder_fill">
<span slot="content-start">
<Checkbox
checked={Object.values(checkboxes.documents).indexOf(false) < 0}
indeterminate={Object.values(checkboxes.documents).indexOf(false) >= 0 &&
Object.values(checkboxes.documents).indexOf(true) >= 0}
onChange={(e) => {
Object.keys(checkboxes.documents).forEach(
(k) => (checkboxes.documents[k] = e.target.checked),
);
checkboxes = checkboxes;
}}
/>
</span>
<TreeviewItem label="cv.docx" iconF7="doc_text_fill" toggle={false}>
<span slot="content-start">
<Checkbox
checked={checkboxes.documents['cv.docx']}
onChange={(e) => {
checkboxes.documents['cv.docx'] = e.target.checked;
checkboxes = checkboxes;
}}
/>
</span>
</TreeviewItem>
<TreeviewItem label="info.docx" iconF7="doc_text_fill" toggle={false}>
<span slot="content-start">
<Checkbox
checked={checkboxes.documents['info.docx']}
onChange={(e) => {
checkboxes.documents['info.docx'] = e.target.checked;
checkboxes = checkboxes;
}}
/>
</span>
</TreeviewItem>
</TreeviewItem>
<TreeviewItem label=".gitignore" iconF7="logo_github" toggle={false}>
<span slot="content-start">
<Checkbox
checked={checkboxes['.gitignore']}
onChange={(e) => {
checkboxes['.gitignore'] = e.target.checked;
checkboxes = checkboxes;
}}
/>
</span>
</TreeviewItem>
<TreeviewItem label="index.html" iconF7="doc_text_fill" toggle={false}>
<span slot="content-start">
<Checkbox
checked={checkboxes['index.html']}
onChange={(e) => {
checkboxes['index.html'] = e.target.checked;
checkboxes = checkboxes;
}}
/>
</span>
</TreeviewItem>
</Treeview>
</Block>
<BlockTitle>Whole item as toggle</BlockTitle>
<Block strong outlineIos class="no-padding-horizontal">
<Treeview>
<TreeviewItem itemToggle label="images" iconF7="folder_fill">
<TreeviewItem label="avatar.png" iconF7="photo_fill" />
<TreeviewItem label="background.jpg" iconF7="photo_fill" />
</TreeviewItem>
<TreeviewItem itemToggle label="documents" iconF7="folder_fill">
<TreeviewItem label="cv.docx" iconF7="doc_text_fill" />
<TreeviewItem label="info.docx" iconF7="doc_text_fill" />
</TreeviewItem>
<TreeviewItem label=".gitignore" iconF7="logo_github" />
<TreeviewItem label="index.html" iconF7="doc_text_fill" />
</Treeview>
</Block>
<BlockTitle>Selectable</BlockTitle>
<Block strong outlineIos class="no-padding-horizontal">
<Treeview>
<TreeviewItem
selectable
selected={selectedItem === 'images'}
label="images"
iconF7="folder_fill"
onClick={(e) => toggleSelectable(e, 'images')}
>
<TreeviewItem
selectable
selected={selectedItem === 'avatar.png'}
label="avatar.png"
iconF7="photo_fill"
onClick={(e) => toggleSelectable(e, 'avatar.png')}
/>
<TreeviewItem
selectable
selected={selectedItem === 'background.jpg'}
label="background.jpg"
iconF7="photo_fill"
onClick={(e) => toggleSelectable(e, 'background.jpg')}
/>
</TreeviewItem>
<TreeviewItem
selectable
selected={selectedItem === 'documents'}
label="documents"
iconF7="folder_fill"
onClick={(e) => toggleSelectable(e, 'documents')}
>
<TreeviewItem
selectable
selected={selectedItem === 'cv.docx'}
label="cv.docx"
iconF7="doc_text_fill"
onClick={(e) => toggleSelectable(e, 'cv.docx')}
/>
<TreeviewItem
selectable
selected={selectedItem === 'info.docx'}
label="info.docx"
iconF7="doc_text_fill"
onClick={(e) => toggleSelectable(e, 'info.docx')}
/>
</TreeviewItem>
<TreeviewItem
selectable
selected={selectedItem === '.gitignore'}
label=".gitignore"
iconF7="logo_github"
onClick={(e) => toggleSelectable(e, '.gitignore')}
/>
<TreeviewItem
selectable
selected={selectedItem === 'index.html'}
label="index.html"
iconF7="doc_text_fill"
onClick={(e) => toggleSelectable(e, 'index.html')}
/>
</Treeview>
</Block>
<BlockTitle>Preload children</BlockTitle>
<Block strong outlineIos class="no-padding-horizontal">
<Treeview>
<TreeviewItem
toggle
loadChildren
iconF7="person_2_fill"
label="Users"
onTreeviewLoadChildren={(el, done) => loadChildren(done)}
>
{#each loadedChildren as item, index (index)}
<TreeviewItem iconF7="person_fill" label={item.name} />
{/each}
</TreeviewItem>
</Treeview>
</Block>
<BlockTitle>With links</BlockTitle>
<Block strong outlineIos class="no-padding-horizontal">
<Treeview>
<TreeviewItem iconF7="square_grid_2x2_fill" itemToggle label="Modals">
<TreeviewItem link="/popup/" iconF7="link" label="Popup" />
<TreeviewItem link="/dialog/" iconF7="link" label="Dialog" />
<TreeviewItem link="/action-sheet/" iconF7="link" label="Action Sheet" />
</TreeviewItem>
<TreeviewItem iconF7="square_grid_2x2_fill" itemToggle label="Navigation Bars">
<TreeviewItem link="/navbar/" iconF7="link" label="Navbar" />
<TreeviewItem link="/toolbar-tabbar/" iconF7="link" label="Toolbar & Tabbar" />
</TreeviewItem>
</Treeview>
</Block>
</Page>