-
Notifications
You must be signed in to change notification settings - Fork 94
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Replace MenuBubble with menu bar entry for links
This replaces the popover MenuBubble used for inserting links with a menu entry in the menu bar, fixing #2392. This also allows to add links also to directories, previously only files were allowed as link targets, fixing #2162. Signed-off-by: Ferdinand Thiessen <rpm@fthiessen.de>
- Loading branch information
Showing
9 changed files
with
246 additions
and
258 deletions.
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
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,201 @@ | ||
| <!-- | ||
| - @copyright Copyright (c) 2022 | ||
| - | ||
| - @license AGPL-3.0-or-later | ||
| - | ||
| - This program is free software: you can redistribute it and/or modify | ||
| - it under the terms of the GNU Affero General Public License as | ||
| - published by the Free Software Foundation, either version 3 of the | ||
| - License, or (at your option) any later version. | ||
| - | ||
| - This program is distributed in the hope that it will be useful, | ||
| - but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| - GNU Affero General Public License for more details. | ||
| - | ||
| - You should have received a copy of the GNU Affero General Public License | ||
| - along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
| - | ||
| --> | ||
| <template> | ||
| <Actions ref="menu" | ||
| class="entry-action entry-action__insert-link" | ||
| aria-haspopup | ||
| :aria-label="actionEntry.label" | ||
| :class="activeClass" | ||
| :data-text-action-entry="actionEntry.key" | ||
| :title="actionEntry.label"> | ||
| <template #icon> | ||
| <component :is="icon" | ||
| :title="actionEntry.label" | ||
| :aria-label="actionEntry.label" | ||
| aria-haspopup /> | ||
| </template> | ||
| <ActionButton v-if="state.active" | ||
| close-after-click | ||
| :data-text-action-entry="`${actionEntry.key}-remove`" | ||
| @click="removeLink"> | ||
| <template #icon> | ||
| <LinkOff /> | ||
| </template> | ||
| {{ t('text', 'Remove Link') }} | ||
| </ActionButton> | ||
| <ActionButton close-after-click | ||
| :data-text-action-entry="`${actionEntry.key}-file`" | ||
| @click="linkFile"> | ||
| <template #icon> | ||
| <FileLink /> | ||
| </template> | ||
| {{ t('text', 'Link to File or Directory') }} | ||
| </ActionButton> | ||
| <ActionInput v-if="isInputMode" | ||
| type="text" | ||
| :value="href" | ||
| :data-text-action-entry="`${actionEntry.key}-input`" | ||
| @submit="linkWebsite"> | ||
| <template #icon> | ||
| <Web /> | ||
| </template> | ||
| {{ t('text', 'Link to Website') }} | ||
| </ActionInput> | ||
| <ActionButton v-else | ||
| :data-text-action-entry="`${actionEntry.key}-website`" | ||
| @click="linkWebsite"> | ||
| <template #icon> | ||
| <Web /> | ||
| </template> | ||
| {{ state.active ? t('text', 'Update Link') : t('text', 'Link to Website') }} | ||
| </ActionButton> | ||
| </Actions> | ||
| </template> | ||
|
|
||
| <script> | ||
| import Actions from '@nextcloud/vue/dist/Components/Actions' | ||
| import ActionButton from '@nextcloud/vue/dist/Components/ActionButton' | ||
| import ActionInput from '@nextcloud/vue/dist/Components/ActionInput' | ||
|
|
||
| import { Loading, FileLink, LinkOff, Web } from '../icons.js' | ||
| import { BaseActionEntry } from './BaseActionEntry.js' | ||
| import { useFileMixin } from '../EditorWrapper.provider.js' | ||
| import { optimalPath } from '../../helpers/files.js' | ||
| import { getMarkAttributes, isActive } from '@tiptap/core' | ||
|
|
||
| export default { | ||
| name: 'ActionInsertLink', | ||
| components: { | ||
| Actions, | ||
| ActionButton, | ||
| ActionInput, | ||
| Loading, | ||
| FileLink, | ||
| LinkOff, | ||
| Web, | ||
| }, | ||
| extends: BaseActionEntry, | ||
| mixins: [ | ||
| useFileMixin, | ||
| ], | ||
| data: () => { | ||
| return { | ||
| href: null, | ||
| isInputMode: false, | ||
| } | ||
| }, | ||
| computed: { | ||
| activeClass() { | ||
| return this.state.active ? 'is-active' : '' | ||
| }, | ||
| }, | ||
| methods: { | ||
| /** | ||
| * Open dialog and ask user which file to link to | ||
| * Triggered by the "link file" button | ||
| */ | ||
| linkFile() { | ||
| const startPath = this.$file.relativePath.split('/').slice(0, -1).join('/') | ||
| OC.dialogs.filepicker(t('text', 'Select file or directory to link to'), (file) => { | ||
| const client = OC.Files.getClient() | ||
| client.getFileInfo(file).then((_status, fileInfo) => { | ||
| const path = optimalPath(this.$file.relativePath, `${fileInfo.path}/${fileInfo.name}`) | ||
| const encodedPath = path.split('/').map(encodeURIComponent).join('/') + (fileInfo.type === 'dir' ? '/' : '') | ||
| const href = `${encodedPath}?fileId=${fileInfo.id}` | ||
| this.setLink(href, fileInfo.name) | ||
| }) | ||
| }, false, [], true, 1, startPath, { allowDirectoryChooser: true }) | ||
| }, | ||
| /** | ||
| * Allow user to enter an URL manually | ||
| * Triggered when by the "link url" button | ||
| * | ||
| * @param {Event} event Triggering event | ||
| */ | ||
| linkWebsite(event) { | ||
| if (event?.type === 'submit') { | ||
| const href = [...event.target.elements].filter(e => e?.type === 'text')[0].value | ||
| // Close menu manually as autoclose does not work form ActionInput | ||
| this.$refs.menu.closeMenu() | ||
| this.isInputMode = false | ||
| this.href = null | ||
| return this.setLink(href, href) | ||
| } | ||
|
|
||
| if (isActive(this.$editor.state, 'link')) { | ||
| const attrs = getMarkAttributes(this.$editor.state, 'link') | ||
| this.href = attrs.href | ||
| } | ||
| this.isInputMode = true | ||
| }, | ||
| /** | ||
| * Save user entered URL as a link markup | ||
| * Triggered when the user submits the ActionInput | ||
| * | ||
| * @param {string} url href attribute of the link | ||
| * @param {string} text Text part of the link | ||
| */ | ||
| setLink(url, text) { | ||
| // Heuristics for determining if we need a https:// prefix. | ||
| const noPrefixes = [ | ||
| /^[a-zA-Z]+:/, // url with protocol ("mailTo:email@domain.tld") | ||
| /^\//, // absolute path | ||
| /\?fileId=/, // relative link with fileId | ||
| /^\.\.?\//, // relative link starting with ./ or ../ | ||
| /^[^.]*[/$]/, // no dots before first '/' - not a domain name | ||
| /^#/, // url fragment | ||
| ] | ||
| if (url && !noPrefixes.find(regex => url.match(regex))) { | ||
| url = 'https://' + url | ||
| } | ||
|
|
||
| // Avoid issues when parsing urls later on in markdown that might be entered in an invalid format (e.g. "mailto: example@example.com") | ||
| const href = url.replaceAll(' ', '%20') | ||
| const chain = this.$editor.chain() | ||
| // Check if any text is selected, if not insert the lunk using the given text property | ||
| if (this.$editor.view.state?.selection.empty) { | ||
| chain.insertContent({ | ||
| type: 'paragraph', | ||
| content: [{ | ||
| type: 'text', | ||
| marks: [{ | ||
| type: 'link', | ||
| attrs: { | ||
| href, | ||
| }, | ||
| }], | ||
| text, | ||
| }], | ||
| }) | ||
| } else { | ||
| chain.setLink({ href }) | ||
| } | ||
| chain.focus().run() | ||
| }, | ||
| /** | ||
| * Remove link markup at current position | ||
| * Triggered by the "remove link" button | ||
| */ | ||
| removeLink() { | ||
| this.$editor.chain().unsetLink().focus().run() | ||
| }, | ||
| }, | ||
| } | ||
| </script> |
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
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
Oops, something went wrong.