From 294647c16425b36e8adc48c7633c992268391c60 Mon Sep 17 00:00:00 2001 From: Benedikt Kulmann Date: Wed, 6 Dec 2023 16:05:40 +0100 Subject: [PATCH] refactor: rename open and sideBarOpen to isOpen and isSideBarOpen --- .../src/components/AppTemplate.vue | 12 +++--- .../src/views/Groups.vue | 2 +- .../src/views/Spaces.vue | 8 ++-- .../src/views/Users.vue | 4 +- .../tests/unit/components/AppTemplate.spec.ts | 6 +-- .../views/__snapshots__/General.spec.ts.snap | 2 +- .../src/components/Search/List.vue | 8 +++- .../components/Shares/SharedWithMeSection.vue | 4 +- .../src/components/Spaces/SpaceHeader.vue | 4 +- .../useResourcesViewDefaults.ts | 2 +- .../web-app-files/src/views/Favorites.vue | 6 +-- .../src/views/shares/SharedViaLink.vue | 6 +-- .../src/views/shares/SharedWithMe.vue | 17 ++++++--- .../src/views/shares/SharedWithOthers.vue | 6 +-- .../src/views/spaces/GenericSpace.vue | 8 ++-- .../src/views/spaces/GenericTrash.vue | 6 +-- .../src/views/spaces/Projects.vue | 10 +++-- .../mocks/useResourcesViewDefaultsMock.ts | 2 +- .../components/Spaces/SpaceHeader.spec.ts | 6 +-- .../__snapshots__/Projects.spec.ts.snap | 4 +- .../trash/__snapshots__/Overview.spec.ts.snap | 2 +- packages/web-app-preview/src/App.vue | 2 +- packages/web-client/src/helpers/index.ts | 3 +- .../web-pkg/src/components/AppBar/AppBar.vue | 8 ++-- .../src/components/AppBar/SidebarToggle.vue | 6 +-- .../components/AppTemplates/AppWrapper.vue | 2 +- packages/web-pkg/src/components/AppTopBar.vue | 6 +-- .../src/components/SideBar/FileSideBar.vue | 10 ++--- .../src/components/SideBar/SideBar.vue | 8 ++-- .../src/composables/sideBar/useSideBar.ts | 14 +++---- .../components/AppBar/SidebarToggle.spec.ts | 8 ++-- .../AppBar/__snapshots__/AppBar.spec.ts.snap | 6 +-- .../composables/sideBar/useSideBar.spec.ts | 38 +++++++++---------- 33 files changed, 124 insertions(+), 112 deletions(-) diff --git a/packages/web-app-admin-settings/src/components/AppTemplate.vue b/packages/web-app-admin-settings/src/components/AppTemplate.vue index 6c31d798d0d..e2c0ac38d2d 100644 --- a/packages/web-app-admin-settings/src/components/AppTemplate.vue +++ b/packages/web-app-admin-settings/src/components/AppTemplate.vue @@ -51,12 +51,12 @@ }, - sideBarOpen: { + isSideBarOpen: { required: false, type: Boolean, default: false @@ -165,7 +165,7 @@ export default defineComponent({ const appBarRef = ref() const limitedScreenSpace = ref(false) const onResize = () => { - limitedScreenSpace.value = props.sideBarOpen + limitedScreenSpace.value = props.isSideBarOpen ? window.innerWidth <= 1600 : window.innerWidth <= 1200 } @@ -213,12 +213,12 @@ export default defineComponent({ }, computed: { toggleSidebarButtonLabel() { - return this.sideBarOpen + return this.isSideBarOpen ? this.$gettext('Close sidebar to hide details') : this.$gettext('Open sidebar to view details') }, toggleSidebarButtonIconFillType() { - return this.sideBarOpen ? 'fill' : 'line' + return this.isSideBarOpen ? 'fill' : 'line' } } }) diff --git a/packages/web-app-admin-settings/src/views/Groups.vue b/packages/web-app-admin-settings/src/views/Groups.vue index 131ee79cd76..ddca20ae59c 100644 --- a/packages/web-app-admin-settings/src/views/Groups.vue +++ b/packages/web-app-admin-settings/src/views/Groups.vue @@ -7,7 +7,7 @@ :side-bar-active-panel="sideBarActivePanel" :side-bar-available-panels="sideBarAvailablePanels" :side-bar-panel-context="sideBarPanelContext" - :side-bar-open="sideBarOpen" + :is-side-bar-open="isSideBarOpen" :show-batch-actions="!!selectedGroups.length" :batch-actions="batchActions" :batch-action-items="selectedGroups" diff --git a/packages/web-app-admin-settings/src/views/Spaces.vue b/packages/web-app-admin-settings/src/views/Spaces.vue index c02b5c0ecc0..ecf35b29dac 100644 --- a/packages/web-app-admin-settings/src/views/Spaces.vue +++ b/packages/web-app-admin-settings/src/views/Spaces.vue @@ -7,7 +7,7 @@ :side-bar-active-panel="sideBarActivePanel" :side-bar-available-panels="sideBarAvailablePanels" :side-bar-panel-context="sideBarPanelContext" - :side-bar-open="sideBarOpen" + :is-side-bar-open="isSideBarOpen" :is-side-bar-header-compact="selectedSpaces.length === 1" :show-batch-actions="!!selectedSpaces.length" :batch-actions="batchActions" @@ -41,7 +41,7 @@
{ }) describe('sideBar', () => { it('should show when opened', () => { - const { wrapper } = getWrapper({ props: { sideBarOpen: true } }) + const { wrapper } = getWrapper({ props: { isSideBarOpen: true } }) expect(wrapper.find(stubSelectors.sideBar).exists()).toBeTruthy() }) it('should not show when closed', () => { - const { wrapper } = getWrapper({ props: { sideBarOpen: false } }) + const { wrapper } = getWrapper({ props: { isSideBarOpen: false } }) expect(wrapper.find(stubSelectors.sideBar).exists()).toBeFalsy() }) it('can be toggled', async () => { @@ -129,7 +129,7 @@ function getWrapper({ props = {}, isMobileWidth = false } = {}) { props: { loading: false, breadcrumbs: [], - sideBarOpen: true, + isSideBarOpen: true, sideBarAvailablePanels: [], sideBarActivePanel: '', ...props diff --git a/packages/web-app-admin-settings/tests/unit/views/__snapshots__/General.spec.ts.snap b/packages/web-app-admin-settings/tests/unit/views/__snapshots__/General.spec.ts.snap index c01ad2d76c9..d3ca4e1d51c 100644 --- a/packages/web-app-admin-settings/tests/unit/views/__snapshots__/General.spec.ts.snap +++ b/packages/web-app-admin-settings/tests/unit/views/__snapshots__/General.spec.ts.snap @@ -2,6 +2,6 @@ exports[`General view renders component 1`] = `
- +
`; diff --git a/packages/web-app-files/src/components/Search/List.vue b/packages/web-app-files/src/components/Search/List.vue index c6c2177c0f9..4686ff5c6a5 100644 --- a/packages/web-app-files/src/components/Search/List.vue +++ b/packages/web-app-files/src/components/Search/List.vue @@ -1,7 +1,11 @@ diff --git a/packages/web-app-files/src/components/Shares/SharedWithMeSection.vue b/packages/web-app-files/src/components/Shares/SharedWithMeSection.vue index 08a479bd2a5..b2ef5ac5134 100644 --- a/packages/web-app-files/src/components/Shares/SharedWithMeSection.vue +++ b/packages/web-app-files/src/components/Shares/SharedWithMeSection.vue @@ -19,7 +19,7 @@ v-model:selectedIds="selectedResourcesIds" :data-test-share-status="shareStatus" class="files-table" - :class="{ 'files-table-squashed': sideBarOpen }" + :class="{ 'files-table-squashed': isSideBarOpen }" :fields-displayed="displayedFields" sidebar-closed :are-thumbnails-displayed="displayThumbnails" @@ -171,7 +171,7 @@ export default defineComponent({ type: Boolean, default: true }, - sideBarOpen: { + isSideBarOpen: { type: Boolean, default: false }, diff --git a/packages/web-app-files/src/components/Spaces/SpaceHeader.vue b/packages/web-app-files/src/components/Spaces/SpaceHeader.vue index 16a37c6d2e7..fc5716f8b46 100644 --- a/packages/web-app-files/src/components/Spaces/SpaceHeader.vue +++ b/packages/web-app-files/src/components/Spaces/SpaceHeader.vue @@ -1,7 +1,7 @@ - +
diff --git a/packages/web-app-files/src/views/spaces/Projects.vue b/packages/web-app-files/src/views/spaces/Projects.vue index e15067a43dd..d5bdc8a45de 100644 --- a/packages/web-app-files/src/views/spaces/Projects.vue +++ b/packages/web-app-files/src/views/spaces/Projects.vue @@ -9,7 +9,7 @@ :has-hidden-files="false" :has-file-extensions="false" :has-pagination="false" - :side-bar-open="sideBarOpen" + :is-side-bar-open="isSideBarOpen" :view-modes="viewModes" :view-mode-default="ViewModeConstants.tilesView.name" > @@ -92,7 +92,7 @@ v-model:selectedIds="selectedResourcesIds" :resources="paginatedItems" class="spaces-table" - :class="{ 'spaces-table-squashed': sideBarOpen }" + :class="{ 'spaces-table-squashed': isSideBarOpen }" :sticky="false" :fields-displayed="tableDisplayFields" :are-thumbnails-displayed="true" @@ -151,7 +151,11 @@ - + diff --git a/packages/web-app-files/tests/mocks/useResourcesViewDefaultsMock.ts b/packages/web-app-files/tests/mocks/useResourcesViewDefaultsMock.ts index 7b13b2e554a..ae8382e544c 100644 --- a/packages/web-app-files/tests/mocks/useResourcesViewDefaultsMock.ts +++ b/packages/web-app-files/tests/mocks/useResourcesViewDefaultsMock.ts @@ -26,7 +26,7 @@ export const useResourcesViewDefaultsMock = ( selectedResourcesIds: ref([]), selectedResourceSpace: ref(mock()), isResourceInSelection: jest.fn(() => false), - sideBarOpen: ref(false), + isSideBarOpen: ref(false), sideBarActivePanel: ref(''), scrollToResource: jest.fn(), scrollToResourceFromRoute: jest.fn(), diff --git a/packages/web-app-files/tests/unit/components/Spaces/SpaceHeader.spec.ts b/packages/web-app-files/tests/unit/components/Spaces/SpaceHeader.spec.ts index e86fd6353ab..ba151b53473 100644 --- a/packages/web-app-files/tests/unit/components/Spaces/SpaceHeader.spec.ts +++ b/packages/web-app-files/tests/unit/components/Spaces/SpaceHeader.spec.ts @@ -14,7 +14,7 @@ describe('SpaceHeader', () => { it('should add the "squashed"-class when the sidebar is opened', () => { const wrapper = getWrapper({ space: buildSpace({ id: '1' } as unknown as Drive), - sideBarOpen: true + isSideBarOpen: true }) expect(wrapper.find('.space-header-squashed').exists()).toBeTruthy() expect(wrapper.html()).toMatchSnapshot() @@ -46,13 +46,13 @@ describe('SpaceHeader', () => { }) }) -function getWrapper({ space = {}, sideBarOpen = false, isMobileWidth = false }) { +function getWrapper({ space = {}, isSideBarOpen = false, isMobileWidth = false }) { const mocks = defaultComponentMocks() const store = createStore(defaultStoreMockOptions) return mount(SpaceHeader, { props: { space, - sideBarOpen + isSideBarOpen }, global: { mocks, diff --git a/packages/web-app-files/tests/unit/views/spaces/__snapshots__/Projects.spec.ts.snap b/packages/web-app-files/tests/unit/views/spaces/__snapshots__/Projects.spec.ts.snap index a43548847ae..35d6f593365 100644 --- a/packages/web-app-files/tests/unit/views/spaces/__snapshots__/Projects.spec.ts.snap +++ b/packages/web-app-files/tests/unit/views/spaces/__snapshots__/Projects.spec.ts.snap @@ -4,7 +4,7 @@ exports[`Projects view different files view states lists all available project s
- +
@@ -23,6 +23,6 @@ exports[`Projects view different files view states lists all available project s
- +
`; diff --git a/packages/web-app-files/tests/unit/views/trash/__snapshots__/Overview.spec.ts.snap b/packages/web-app-files/tests/unit/views/trash/__snapshots__/Overview.spec.ts.snap index f808ef486e0..0a9b67f2c0e 100644 --- a/packages/web-app-files/tests/unit/views/trash/__snapshots__/Overview.spec.ts.snap +++ b/packages/web-app-files/tests/unit/views/trash/__snapshots__/Overview.spec.ts.snap @@ -4,7 +4,7 @@ exports[`TrashOverview view states should render spaces list 1`] = `
- +
diff --git a/packages/web-app-preview/src/App.vue b/packages/web-app-preview/src/App.vue index 4688b6aabaf..437dd31450b 100644 --- a/packages/web-app-preview/src/App.vue +++ b/packages/web-app-preview/src/App.vue @@ -64,7 +64,7 @@ @toggle-next="next" />
- +
diff --git a/packages/web-client/src/helpers/index.ts b/packages/web-client/src/helpers/index.ts index 1bad5ec785e..a46e6eb91fb 100644 --- a/packages/web-client/src/helpers/index.ts +++ b/packages/web-client/src/helpers/index.ts @@ -1,8 +1,7 @@ export * from './group' +export * from './item' export * from './publicLink' export * from './resource' export * from './share' export * from './space' export * from './user' - -export * from './item' diff --git a/packages/web-pkg/src/components/AppBar/AppBar.vue b/packages/web-pkg/src/components/AppBar/AppBar.vue index 75801eda724..3d04fd7e528 100644 --- a/packages/web-pkg/src/components/AppBar/AppBar.vue +++ b/packages/web-pkg/src/components/AppBar/AppBar.vue @@ -1,5 +1,5 @@ diff --git a/packages/web-pkg/src/components/AppTopBar.vue b/packages/web-pkg/src/components/AppTopBar.vue index 973dd4c3a0c..8105f168143 100644 --- a/packages/web-pkg/src/components/AppTopBar.vue +++ b/packages/web-pkg/src/components/AppTopBar.vue @@ -74,7 +74,7 @@
- {{ sideBarOpen }} + {{ isSideBarOpen }}
@@ -152,7 +152,7 @@ export default defineComponent({ const toggleSideBar = () => { eventBus.publish(SideBarEventTopics.toggle) } - const { sideBarOpen } = useSideBar() + const { isSideBarOpen } = useSideBar() return { pathPrefix, @@ -161,7 +161,7 @@ export default defineComponent({ closeButtonLabel, parentFolderName, parentFolderLinkIconAdditionalAttributes, - sideBarOpen, + isSideBarOpen, toggleSideBar } } diff --git a/packages/web-pkg/src/components/SideBar/FileSideBar.vue b/packages/web-pkg/src/components/SideBar/FileSideBar.vue index b7223c31108..ac9857a1f6b 100644 --- a/packages/web-pkg/src/components/SideBar/FileSideBar.vue +++ b/packages/web-pkg/src/components/SideBar/FileSideBar.vue @@ -1,10 +1,10 @@