Skip to content

fix(readonly-bar): Clean up read-only menu bar to behave consistently with normal menu bar #7560

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

Merged
mejo- merged 3 commits into from
Sep 17, 2025
Merged

fix(readonly-bar): Clean up read-only menu bar to behave consistently with normal menu bar #7560

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
152e1cb
fix(readonly-bar): Clean up read-only menu bar to behave consistently…
pbirrer Aug 22, 2025
f1d3c95
chore: code style fixes by prettier
mejo- Sep 17, 2025
5515deb
text(cy): Fix CSS selectors for readonly bar
mejo- Sep 17, 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
14 changes: 7 additions & 7 deletions cypress/e2e/openreadonly.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ describe('Open read-only mode', function () {

describe('Disabled', function () {
const checkMenubar = function () {
cy.get('.text-editor--readonly-bar').should('not.exist')
cy.get('[data-text-el="readonly-bar"]').should('not.exist')
cy.get('.text-menubar', { timeout: 10000 })
.getActionEntry('done')
.should('not.exist')
Expand Down Expand Up @@ -52,14 +52,14 @@ describe('Open read-only mode', function () {

describe('Enabled', function () {
const requireReadOnlyBar = function () {
cy.get('.text-editor--readonly-bar').should('exist')
cy.get('.text-editor--readonly-bar')
cy.get('[data-text-el="readonly-bar"]').should('exist')
cy.get('[data-text-el="readonly-bar"]')
.getActionEntry('edit')
.should('exist')
}

const requireMenubar = function () {
cy.get('.text-editor--readonly-bar').should('not.exist')
cy.get('[data-text-el="readonly-bar"]').should('not.exist')
cy.get('.text-menubar').getActionEntry('done').should('exist')
}

Expand All @@ -82,7 +82,7 @@ describe('Open read-only mode', function () {
requireReadOnlyBar()

// Switch to edit-mode
cy.get('.text-editor--readonly-bar').getActionEntry('edit').click()
cy.get('[data-text-el="readonly-bar"]').getActionEntry('edit').click()

requireMenubar()

Expand All @@ -98,10 +98,10 @@ describe('Open read-only mode', function () {
requireReadOnlyBar()

// Switch to edit-mode
cy.get('.text-editor--readonly-bar').getActionEntry('edit').click()
cy.get('[data-text-el="readonly-bar"]').getActionEntry('edit').click()

// Check that read-only bar does not exist
cy.get('.text-editor--readonly-bar').should('not.exist')
cy.get('[data-text-el="readonly-bar"]').should('not.exist')
})
})
})
2 changes: 1 addition & 1 deletion cypress/e2e/share.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ describe('Open test.md in viewer', function () {
.find('h2')
.should('contain', 'Hello world')

cy.get('.text-editor--readonly-bar')
cy.get('[data-text-el="readonly-bar"]')
.getActionEntry('outline')
.click()

Expand Down
14 changes: 6 additions & 8 deletions src/components/Editor.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,19 +23,19 @@
@outline-toggled="outlineToggled">
<MainContainer v-if="contentLoaded">
<!-- Readonly -->
<div
v-if="readOnly || (openReadOnlyEnabled && !editMode)"
class="text-editor--readonly-bar">
<template v-if="readOnly || (openReadOnlyEnabled && !editMode)">
<slot name="readonlyBar">
Copy link
Collaborator

@max-nextcloud max-nextcloud Aug 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This slot is used by the collectives app to alter the content of the read only bar. I think we need to keep it so that collectives can continue doing that.

Copy link
Contributor Author

@pbirrer pbirrer Aug 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're right, sorry about that! I readded the slot. However, it's now a direct child of the MainContainer component, which is the same setup as here:

text/src/components/Editor/MarkdownContentEditor.vue

Lines 11 to 19 in f405547

<MainContainer>
<template v-if="showMenuBar">
<MenuBar v-if="!readOnly" :autohide="false" />
<slot v-else name="readonlyBar">
<ReadonlyBar />
</slot>
</template>
<ContentContainer />
</MainContainer>

Do you think that could be an issue? Personally, I feel it’s better to let the ReadonlyBar handle its own CSS styling.

<ReadonlyBar :open-read-only="openReadOnlyEnabled">
<ReadonlyBar
:is-hidden="hideMenu"
:open-read-only="openReadOnlyEnabled">
<Status
:document="document"
:dirty="dirty"
:sync-error="syncError"
:has-connection-issue="requireReconnect" />
</ReadonlyBar>
</slot>
</div>
</template>
<!-- Rich Menu -->
<template v-else>
<MenuBar
Expand Down Expand Up @@ -858,8 +858,7 @@ export default defineComponent({
}
}

.menubar-placeholder,
.text-editor--readonly-bar {
.menubar-placeholder {
position: fixed;
position: -webkit-sticky;
position: sticky;
Expand All @@ -873,7 +872,6 @@ export default defineComponent({
padding-block: var(--default-grid-baseline);
}

.text-editor--readonly-bar,
.menubar-placeholder--with-slot {
opacity: unset;
visibility: unset;
Expand Down
106 changes: 98 additions & 8 deletions src/components/Menu/ReadonlyBar.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,15 @@
-->

<template>
<div data-text-el="readonly-bar" class="text-readonly-bar">
<div
data-text-el="readonly-bar"
class="text-readonly-bar"
:class="{
'text-readonly-bar--ready': isReady,
'text-readonly-bar--is-workspace': isRichWorkspace,
'text-readonly-bar--hide': isHidden,
'is-mobile': $isMobile,
}">
<div
ref="menubar"
role="toolbar"
Expand All @@ -25,7 +33,7 @@
:can-be-focussed="activeMenuEntry === index"
@disabled="disableMenuEntry(actionEntry.key, $event)" />
</div>
<div class="text-menubar__slot">
<div class="text-readonly-bar__slot">
<slot />
</div>
</div>
Expand All @@ -36,45 +44,127 @@ import { defineComponent } from 'vue'
import { OutlineEntries, ReadOnlyEditEntries } from './entries.js'

import { t } from '@nextcloud/l10n'
import { useEditorFlags } from '../../composables/useEditorFlags.ts'
import { useIsMobileMixin } from '../Editor.provider.ts'
import ActionList from './ActionList.vue'
import ActionSingle from './ActionSingle.vue'
import ToolBarLogic from './ToolBarLogic.js'

export default defineComponent({
name: 'ReadonlyBar',

components: {
ActionList,
ActionSingle,
},

extends: ToolBarLogic,

mixins: [useIsMobileMixin],

props: {
isHidden: {
type: Boolean,
default: false,
},
openReadOnly: {
type: Boolean,
default: false,
},
},

emits: ['update:loaded'],

setup() {
const { isRichWorkspace } = useEditorFlags()
return {
isRichWorkspace,
}
},

data() {
return {
entries: this.openReadOnly
? [...ReadOnlyEditEntries, ...OutlineEntries]
: [...OutlineEntries],
isReady: false,
}
},

mounted() {
this.$nextTick(() => {
this.isReady = true
this.$emit('update:loaded', true)
})
},

methods: {
t,
},
})
</script>

<style scoped>
<style scoped lang="scss">
.text-readonly-bar {
display: flex;
height: var(--default-clickable-area);
--background-blur: blur(10px);
position: sticky;
top: 0;
bottom: var(--default-grid-baseline);
width: 100%;
z-index: 10021; // above modal-header so menubar is always on top
background-color: var(--color-main-background-translucent);
backdrop-filter: var(--background-blur);
max-height: var(
--default-clickable-area
); // important for mobile so that the buttons are always inside the container
border-bottom: 1px solid var(--color-border);
padding-block: var(--default-grid-baseline);
}
.text-readonly-bar__entries {

visibility: hidden;

display: flex;
flex-grow: 1;
justify-content: flex-end;
align-items: center;

&.is-mobile {
border-top: 1px solid var(--color-border);
border-bottom: unset;
}

&.text-readonly-bar--ready:not(.text-readonly-bar--hide) {
visibility: visible;
animation-name: fadeInDown;
animation-duration: 0.3s;
}

&.text-readonly-bar--hide {
opacity: 0;
transition:
visibility 0.2s 0.4s,
opacity 0.2s 0.4s;
}
.text-readonly-bar__entries {
display: flex;
flex-grow: 1;
margin-left: max(0px, calc((100% - var(--text-editor-max-width)) / 2));
}

.text-readonly-bar__slot {
justify-content: flex-end;
display: flex;
min-width: max(0px, min(100px, (100% - var(--text-editor-max-width)) / 2));
}

&.text-readonly-bar--is-workspace {
.text-readonly-bar__entries {
margin-left: 0;
}
}

@media (max-width: 660px) {
.text-readonly-bar__entries {
margin-left: 0;
}
}
}
</style>
Loading