aboutsummaryrefslogtreecommitdiffstats
path: root/apps/files/src/composables/useNavigation.ts
blob: 2a6f22a1232d3f3798b91618aff41876f3312a6e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
/**
 * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */
import type { View } from '@nextcloud/files'
import type { ShallowRef } from 'vue'

import { getNavigation } from '@nextcloud/files'
import { subscribe } from '@nextcloud/event-bus'
import { onMounted, onUnmounted, shallowRef, triggerRef } from 'vue'

/**
 * Composable to get the currently active files view from the files navigation
 * @param _loaded If set enforce a current view is loaded
 */
// eslint-disable-next-line @typescript-eslint/no-unused-vars
export function useNavigation<T extends boolean>(_loaded?: T) {
	type MaybeView = T extends true ? View : (View | null);
	const navigation = getNavigation()
	const views: ShallowRef<View[]> = shallowRef(navigation.views)
	const currentView: ShallowRef<MaybeView> = shallowRef(navigation.active as MaybeView)

	/**
	 * Event listener to update the `currentView`
	 * @param event The update event
	 */
	function onUpdateActive(event: CustomEvent<View|null>) {
		currentView.value = event.detail as MaybeView
	}

	/**
	 * Event listener to update all registered views
	 */
	function onUpdateViews() {
		views.value = navigation.views
		triggerRef(views)
	}

	onMounted(() => {
		navigation.addEventListener('update', onUpdateViews)
		navigation.addEventListener('updateActive', onUpdateActive)
		subscribe('files:navigation:updated', onUpdateViews)
	})
	onUnmounted(() => {
		navigation.removeEventListener('update', onUpdateViews)
		navigation.removeEventListener('updateActive', onUpdateActive)
	})

	return {
		currentView,
		views,
	}
}