-
Notifications
You must be signed in to change notification settings - Fork 13.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(editor): Implement breadcrumbs component (#13317)
Co-authored-by: Rob Squires <robtf9@icloud.com>
- Loading branch information
1 parent
36b1fa8
commit 29857ff
Showing
8 changed files
with
1,174 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
123 changes: 123 additions & 0 deletions
123
packages/design-system/src/components/N8nBreadcrumbs/AsyncLoadingCacheDemo.vue
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,123 @@ | ||
| <script setup lang="ts"> | ||
| import { ref } from 'vue'; | ||
| import type { PathItem } from './Breadcrumbs.vue'; | ||
| import Breadcrumbs from './Breadcrumbs.vue'; | ||
| /** | ||
| * Demo component to showcase different usage of Breadcrumbs component | ||
| */ | ||
| defineOptions({ name: 'AsyncLoadingCacheDemo' }); | ||
| const FETCH_TIMEOUT = 1000; | ||
| type Props = { | ||
| title: string; | ||
| mode: 'sync' | 'async'; | ||
| testCache?: boolean; | ||
| // Breadcrumbs props | ||
| theme?: 'small' | 'medium'; | ||
| showBorder?: boolean; | ||
| }; | ||
| const props = withDefaults(defineProps<Props>(), { | ||
| mode: 'sync', | ||
| testCache: false, | ||
| theme: 'medium', | ||
| showBorder: false, | ||
| }); | ||
| // We'll use this to break the cache after a few fetches in the demo | ||
| const fetchCount = ref(0); | ||
| const items = ref<PathItem[]>([ | ||
| { id: '1', label: 'Home', href: '/' }, | ||
| { id: '2', label: 'Parent', href: '/parent' }, | ||
| ]); | ||
| // For async version, hidden items are a promise, we can also make it reactive like this | ||
| const hiddenItemsPromise = ref<Promise<PathItem[]>>(new Promise(() => {})); | ||
| // For sync version, hidden items are a just a reactive array | ||
| const hiddenItemsSync = ref<PathItem[]>([ | ||
| { id: 'folder2', label: 'Folder 2' }, | ||
| { id: 'folder3', label: 'Folder 3' }, | ||
| ]); | ||
| const onDropdownOpened = () => { | ||
| // In the current implementation, we need to init a promise only when needed | ||
| if (fetchCount.value === 0) { | ||
| hiddenItemsPromise.value = fetchHiddenItems(); | ||
| } | ||
| // Demo code | ||
| fetchCount.value++; | ||
| if (props.testCache) { | ||
| if (fetchCount.value > 2 && props.mode === 'async') { | ||
| updatePromise(); | ||
| } else if (props.mode === 'sync') { | ||
| updateSyncItems(); | ||
| } | ||
| } | ||
| }; | ||
| const fetchHiddenItems = async (): Promise<PathItem[]> => { | ||
| await new Promise((resolve) => setTimeout(resolve, FETCH_TIMEOUT)); | ||
| return [ | ||
| { id: 'home', label: 'Home' }, | ||
| { id: 'projects', label: 'Projects' }, | ||
| { id: 'folder1', label: 'Folder 1' }, | ||
| ]; | ||
| }; | ||
| // Updates the promise ref with new items to showcase it's reactivity | ||
| const updatePromise = () => { | ||
| hiddenItemsPromise.value = new Promise((resolve) => { | ||
| setTimeout(() => { | ||
| resolve([ | ||
| { id: 'folder1', label: 'New Folder 1' }, | ||
| { id: 'folder2', label: 'Folder 2' }, | ||
| { id: 'folder3', label: 'Folder 3' }, | ||
| ]); | ||
| }, FETCH_TIMEOUT); | ||
| }); | ||
| }; | ||
| // Updates the sync array to showcase it's reactivity | ||
| const updateSyncItems = () => { | ||
| const newId = fetchCount.value + 3; | ||
| const newItem = { id: `'folder${newId}'`, label: `Folder ${newId}` }; | ||
| hiddenItemsSync.value.push(newItem); | ||
| }; | ||
| </script> | ||
|
|
||
| <template> | ||
| <div :class="$style.container"> | ||
| <div :class="$style.heading">{{ title }}</div> | ||
| <div :class="$style.breadcrumbs"> | ||
| <Breadcrumbs | ||
| v-if="props.mode === 'sync'" | ||
| :items="items" | ||
| :hidden-items="hiddenItemsSync" | ||
| :theme="theme" | ||
| :show-border="props.showBorder" | ||
| @tooltip-opened="onDropdownOpened" | ||
| /> | ||
| <Breadcrumbs | ||
| v-else-if="props.mode === 'async'" | ||
| :items="items" | ||
| :hidden-items="hiddenItemsPromise" | ||
| :theme="theme" | ||
| :show-border="props.showBorder" | ||
| @tooltip-opened="onDropdownOpened" | ||
| /> | ||
| </div> | ||
| </div> | ||
| </template> | ||
|
|
||
| <style lang="scss" module> | ||
| .container { | ||
| display: flex; | ||
| flex-direction: column; | ||
| gap: 1em; | ||
| } | ||
| </style> |
Oops, something went wrong.