Skip to content

[DESIGN DRAFT] feat(NcAppSettingsDialog): redesign and only show a single section via navigation #7107

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
+154 −130
Draft

[DESIGN DRAFT] feat(NcAppSettingsDialog): redesign and only show a single section via navigation #7107

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bb5ce18
WIP
ShGKme Jan 13, 2025
8886baf
wip
ShGKme Jan 17, 2025
ed6cd13
wip
ShGKme Jul 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
256 changes: 138 additions & 118 deletions src/components/NcAppSettingsDialog/NcAppSettingsDialog.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,10 @@ You can also add icons to the section navigation:
Twitch setting
</p>
</NcAppSettingsSection>
<NcAppSettingsSection id="asci-name-4" name="Twitter">
<NcAppSettingsSection id="asci-name-4" name="No icon">
No icon settings
</NcAppSettingsSection>
<NcAppSettingsSection id="asci-name-5" name="Twitter">
<template #icon>
<Twitter :size="20" />
</template>
Expand Down Expand Up @@ -123,60 +126,78 @@ export default {
</docs>

<template>
<NcDialog v-if="open"
:navigation-aria-label="settingsNavigationAriaLabel"
v-bind="dialogProperties"
@update:open="handleCloseModal">
<template v-if="hasNavigation" #navigation="{ isCollapsed }">
<ul v-if="!isCollapsed"
class="navigation-list">
<li v-for="section in sections" :key="section.id">
<a :aria-current="`${section.id === selectedSection}`"
:class="{
'navigation-list__link': true,
'navigation-list__link--active': section.id === selectedSection,
'navigation-list__link--icon': hasNavigationIcons,
}"
:href="`#settings-section_${section.id}`"
tabindex="0"
@click.prevent="handleSettingsNavigationClick(section.id)"
@keydown.enter="handleSettingsNavigationClick(section.id)">
<div v-if="hasNavigationIcons" class="navigation-list__link-icon">
<NcVNodes v-if="section.icon" :vnodes="section.icon" />
</div>
<span class="navigation-list__link-text">
<NcModal v-if="open"
:additional-trap-elements="additionalTrapElements"
:close-button-contained="!isMobile"
close-on-click-outside
class="app-settings"
:container="container"
size="large"
:name="name"
@update:show="handleCloseModal">
<div class="app-settings__wrapper">
<nav v-if="sections.length > 1"
class="app-settings__nav"
:aria-label="t('Application settings')"
tabindex="-1">
<ul class="app-settings__nav-list">
<li v-for="(section, sectionIndex) in sections" :key="section.id">
<NcButton ref="navigationButton"
:aria-current="section.id === selectedSection ? 'page' : undefined"
:href="`#settings-section_${section.id}`"
:variant="section.id === selectedSection ? 'primary' : 'tertiary'"
alignment="start"
wide
@keydown.down="openSection(sectionIndex + 1)"
@keydown.up="openSection(sectionIndex - 1)"
@keydown.left="openSection(sectionIndex + (isRTL ? 1 : -1))"
@keydown.right="openSection(sectionIndex + (isRTL ? -1 : +1))"
@keydown.tab.prevent="() => $refs.settingsScroller.focus()"
@click.prevent="openSection(sectionIndex)">
<template v-if="hasNavigationIcons" #icon>
<div class="app-settings__nav-button-icon">
<NcVNodes v-if="section.icon" :vnodes="section.icon" />
</div>
</template>
{{ section.name }}
</span>
</a>
</li>
</ul>
</template>
<div ref="settingsScroller">
<slot />
</NcButton>
</li>
</ul>
</nav>
<div ref="settingsScroller"
class="app-settings__content"
tabindex="-1"
@keydown.shift.tab="$refs.navigationButton?.[selectedSectionIndex]?.$el.focus()">
<slot />
</div>
</div>
</NcDialog>
</NcModal>
</template>

<script>
import debounce from 'debounce'
import { warn } from 'vue'
import { useIsMobile } from '../../composables/useIsMobile/index.ts'
import { t } from '../../l10n.js'
import { isRTL as checkRTL } from '@nextcloud/l10n'
import NcButton from '../NcButton/index.js'
import NcModal from '../NcModal/index.js'
import NcVNodes from '../NcVNodes/index.js'

import NcDialog from '../NcDialog/index.ts'
import NcVNodes from '../NcVNodes/index.ts'
const isRTL = checkRTL()

export default {

name: 'NcAppSettingsDialog',

components: {
NcDialog,
NcButton,
NcModal,
NcVNodes,
},

provide() {
return {
getSelectedSection: () => this.selectedSection,
registerSection: this.registerSection,
unregisterSection: this.unregisterSection,
}
Expand Down Expand Up @@ -228,6 +249,8 @@ export default {

setup() {
return {
t,
isRTL,
isMobile: useIsMobile(),
}
},
Expand All @@ -247,17 +270,8 @@ export default {
},

computed: {
dialogProperties() {
return {
additionalTrapElements: this.additionalTrapElements,
closeOnClickOutside: true,
class: 'app-settings',
container: this.container,
contentClasses: 'app-settings__content',
size: 'large',
name: this.name,
navigationClasses: 'app-settings__navigation',
}
selectedSectionIndex() {
return this.sections.findIndex(({ id }) => id === this.selectedSection)
},

/**
Expand All @@ -280,19 +294,19 @@ export default {
},
},

updated() {
// Check that the scroller element has been mounted
if (!this.$refs.settingsScroller) {
return
}
// Get the scroller element
this.scroller = this.$refs.settingsScroller
if (!this.addedScrollListener) {
this.scroller.addEventListener('scroll', this.handleScroll)
this.addedScrollListener = true
}
// updated() {
// // Check that the scroller element has been mounted
// if (!this.$refs.settingsScroller) {
// return
// }
// // Get the scroller element
// this.scroller = this.$refs.settingsScroller
// if (!this.addedScrollListener) {
// this.scroller.addEventListener('scroll', this.handleScroll)
// this.addedScrollListener = true
// }

},
// },

methods: {
/**
Expand Down Expand Up @@ -342,15 +356,25 @@ export default {
* @param {string} item the ID of the section
*/
handleSettingsNavigationClick(item) {
this.linkClicked = true
document.getElementById('settings-section_' + item).scrollIntoView({
behavior: 'smooth',
inline: 'nearest',
})
this.selectedSection = item
setTimeout(() => {
this.linkClicked = false
}, 1000)
// --- WIP ---
// this.linkClicked = true
// document.getElementById('settings-section_' + item).scrollIntoView({
// behavior: 'smooth',
// inline: 'nearest',
// })
// this.selectedSection = item
// setTimeout(() => {
// this.linkClicked = false
// }, 1000)
},

openSection(sectionIndex) {
if (sectionIndex < 0 || sectionIndex >= this.sections.length) {
return
}
this.selectedSection = this.sections[sectionIndex].id
this.$refs.navigationButton[sectionIndex].$el.focus()
},

handleCloseModal(isOpen) {
Expand All @@ -360,9 +384,9 @@ export default {

this.$emit('update:open', false)
// Remove scroll listener each time the modal is closed
this.scroller.removeEventListener('scroll', this.handleScroll)
this.addedScrollListener = false
this.scroller.scrollTop = 0
// this.scroller.removeEventListener('scroll', this.handleScroll)
// this.addedScrollListener = false
// this.scroller.scrollTop = 0
},

handleScroll() {
Expand All @@ -372,73 +396,69 @@ export default {
},

// Remove selected section once the user starts scrolling
unfocusNavigationItem: debounce(function() {
this.selectedSection = ''
if (document.activeElement.className.includes('navigation-list__link')) {
document.activeElement.blur()
}
}, 300),
// unfocusNavigationItem: debounce(function() {
// this.selectedSection = ''
// if (document.activeElement.className.includes('navigation-list__link')) {
// document.activeElement.blur()
// }
// }, 300),
},
}

</script>

<style lang="scss" scoped>
.app-settings {
:deep &__navigation {
min-width: 200px;
margin-inline-end: calc(4 * var(--default-grid-baseline));
overflow-x: hidden;
overflow-y: auto;
position: relative;
* {
box-sizing: border-box;
}
:deep &__content {
padding-inline: calc(4 * var(--default-grid-baseline));

:deep(.modal-wrapper .modal-container) {
// Scroll the content and navigation separately instead of an entire modal
overflow: hidden;
min-height: 70vh;
}
}

.navigation-list {
height: 100%;
overflow-y: auto;
padding: calc(3 * var(--default-grid-baseline));
.app-settings {
&__wrapper {
display: flex;
flex-direction: row;
// gap: calc(4 * var(--default-grid-baseline));
height: 100%;
}

&__link {
&__nav {
background-color: var(--color-background-dark);
padding: calc(2 * var(--default-grid-baseline));
overflow-y: auto;
}

&__nav-list {
display: flex;
align-content: center;
font-size: 16px;
height: var(--default-clickable-area);
margin: 4px 0;
line-height: var(--default-clickable-area);
border-radius: var(--border-radius-element, var(--border-radius-pill));
font-weight: bold;
padding: 0 calc(4 * var(--default-grid-baseline));
cursor: pointer;
white-space: nowrap;
text-overflow: ellipsis;
overflow: hidden;
background-color: transparent;
border: none;
flex-direction: column;
align-items: stretch;
gap: calc(2 * var(--default-grid-baseline));
}

&:hover,
&:focus {
background-color: var(--color-background-hover);
}
&__nav-button-icon {
width: 20px;
}

&--active {
background-color: var(--color-primary-element-light) !important;
}
&__content {
overflow-y: auto;
flex: 1;
}
}

&--icon {
padding-inline-start: calc(2 * var(--default-grid-baseline));
gap: var(--default-grid-baseline);
@media only screen and (max-width: $breakpoint-mobile) {
.app-settings {
&__wrapper {
flex-direction: column;
}

&-icon {
display: flex;
justify-content: center;
align-content: center;
width: calc(var(--default-clickable-area) - 2 * var(--default-grid-baseline));
max-width: calc(var(--default-clickable-area) - 2 * var(--default-grid-baseline));
.navigation-list {
flex-direction: row;
}
}
}
Expand Down
Loading