debian-mirror-gitlab/app/assets/javascripts/vue_shared/components/markdown/header.vue

281 lines
8.3 KiB
Vue
Raw Normal View History

2017-09-10 17:25:29 +05:30
<script>
2020-11-24 15:15:51 +05:30
import { GlPopover, GlButton, GlTooltipDirective, GlIcon } from '@gitlab/ui';
2021-03-11 19:13:27 +05:30
import $ from 'jquery';
2021-04-29 21:17:54 +05:30
import { keysFor, BOLD_TEXT, ITALIC_TEXT, LINK_TEXT } from '~/behaviors/shortcuts/keybindings';
2020-10-24 23:57:45 +05:30
import { getSelectedFragment } from '~/lib/utils/common_utils';
2021-03-11 19:13:27 +05:30
import { s__ } from '~/locale';
2020-10-24 23:57:45 +05:30
import { CopyAsGFM } from '../../../behaviors/markdown/copy_as_gfm';
2018-12-13 13:39:08 +05:30
import ToolbarButton from './toolbar_button.vue';
2017-09-10 17:25:29 +05:30
2018-12-13 13:39:08 +05:30
export default {
components: {
ToolbarButton,
2020-11-24 15:15:51 +05:30
GlIcon,
2019-09-04 21:01:54 +05:30
GlPopover,
2020-10-24 23:57:45 +05:30
GlButton,
2018-12-13 13:39:08 +05:30
},
directives: {
GlTooltip: GlTooltipDirective,
},
props: {
previewMarkdown: {
type: Boolean,
required: true,
2017-09-10 17:25:29 +05:30
},
2019-02-15 15:39:39 +05:30
lineContent: {
type: String,
required: false,
default: '',
},
canSuggest: {
type: Boolean,
required: false,
default: true,
},
2019-09-04 21:01:54 +05:30
showSuggestPopover: {
type: Boolean,
required: false,
default: false,
},
2021-04-29 21:17:54 +05:30
suggestionStartIndex: {
type: Number,
required: false,
default: 0,
},
2018-12-13 13:39:08 +05:30
},
2020-10-24 23:57:45 +05:30
data() {
return {
tag: '> ',
};
},
2018-12-13 13:39:08 +05:30
computed: {
mdTable() {
return [
2019-10-12 21:52:04 +05:30
// False positive i18n lint: https://gitlab.com/gitlab-org/frontend/eslint-plugin-i18n/issues/26
2020-04-22 19:07:51 +05:30
'| header | header |', // eslint-disable-line @gitlab/require-i18n-strings
2018-12-13 13:39:08 +05:30
'| ------ | ------ |',
2020-04-22 19:07:51 +05:30
'| cell | cell |', // eslint-disable-line @gitlab/require-i18n-strings
'| cell | cell |', // eslint-disable-line @gitlab/require-i18n-strings
2018-12-13 13:39:08 +05:30
].join('\n');
2017-09-10 17:25:29 +05:30
},
2019-02-15 15:39:39 +05:30
mdSuggestion() {
2021-04-29 21:17:54 +05:30
return [['```', `suggestion:-${this.suggestionStartIndex}+0`].join(''), `{text}`, '```'].join(
'\n',
);
2019-02-15 15:39:39 +05:30
},
2021-06-08 01:23:25 +05:30
mdCollapsibleSection() {
return ['<details><summary>Click to expand</summary>', `{text}`, '</details>'].join('\n');
},
2020-11-24 15:15:51 +05:30
isMac() {
// Accessing properties using ?. to allow tests to use
// this component without setting up window.gl.client.
// In production, window.gl.client should always be present.
return Boolean(window.gl?.client?.isMac);
},
modifierKey() {
return this.isMac ? '⌘' : s__('KeyboardKey|Ctrl+');
},
2018-12-13 13:39:08 +05:30
},
mounted() {
$(document).on('markdown-preview:show.vue', this.previewMarkdownTab);
$(document).on('markdown-preview:hide.vue', this.writeMarkdownTab);
},
beforeDestroy() {
$(document).off('markdown-preview:show.vue', this.previewMarkdownTab);
$(document).off('markdown-preview:hide.vue', this.writeMarkdownTab);
},
methods: {
isValid(form) {
return (
!form ||
(form.find('.js-vue-markdown-field').length && $(this.$el).closest('form')[0] === form[0])
);
2017-09-10 17:25:29 +05:30
},
2018-03-17 18:26:18 +05:30
2018-12-13 13:39:08 +05:30
previewMarkdownTab(event, form) {
if (event.target.blur) event.target.blur();
if (!this.isValid(form)) return;
2018-03-17 18:26:18 +05:30
2018-12-13 13:39:08 +05:30
this.$emit('preview-markdown');
},
2018-03-17 18:26:18 +05:30
2018-12-13 13:39:08 +05:30
writeMarkdownTab(event, form) {
if (event.target.blur) event.target.blur();
if (!this.isValid(form)) return;
2018-03-17 18:26:18 +05:30
2018-12-13 13:39:08 +05:30
this.$emit('write-markdown');
2017-09-10 17:25:29 +05:30
},
2019-09-04 21:01:54 +05:30
handleSuggestDismissed() {
this.$emit('handleSuggestDismissed');
},
2020-10-24 23:57:45 +05:30
handleQuote() {
const documentFragment = getSelectedFragment();
if (!documentFragment || !documentFragment.textContent) {
this.tag = '> ';
return;
}
this.tag = '';
const transformed = CopyAsGFM.transformGFMSelection(documentFragment);
const area = this.$el.parentNode.querySelector('textarea');
CopyAsGFM.nodeToGFM(transformed)
2021-03-08 18:12:59 +05:30
.then((gfm) => {
2020-10-24 23:57:45 +05:30
CopyAsGFM.insertPastedText(area, documentFragment.textContent, CopyAsGFM.quoted(gfm));
})
.catch(() => {});
},
2018-12-13 13:39:08 +05:30
},
2021-04-29 21:17:54 +05:30
shortcuts: {
bold: keysFor(BOLD_TEXT),
italic: keysFor(ITALIC_TEXT),
link: keysFor(LINK_TEXT),
},
2018-12-13 13:39:08 +05:30
};
2017-09-10 17:25:29 +05:30
</script>
<template>
<div class="md-header">
<ul class="nav-links clearfix">
2019-02-15 15:39:39 +05:30
<li :class="{ active: !previewMarkdown }" class="md-header-tab">
2020-07-28 23:09:34 +05:30
<button class="js-write-link" type="button" @click="writeMarkdownTab($event)">
2019-07-07 11:18:12 +05:30
{{ __('Write') }}
2018-12-13 13:39:08 +05:30
</button>
2017-09-10 17:25:29 +05:30
</li>
2019-02-15 15:39:39 +05:30
<li :class="{ active: previewMarkdown }" class="md-header-tab">
2018-12-13 13:39:08 +05:30
<button
2018-11-08 19:23:39 +05:30
class="js-preview-link js-md-preview-button"
2018-12-13 13:39:08 +05:30
type="button"
2019-03-02 22:35:43 +05:30
@click="previewMarkdownTab($event)"
2018-03-17 18:26:18 +05:30
>
2019-07-07 11:18:12 +05:30
{{ __('Preview') }}
2018-12-13 13:39:08 +05:30
</button>
2017-09-10 17:25:29 +05:30
</li>
2019-02-15 15:39:39 +05:30
<li :class="{ active: !previewMarkdown }" class="md-header-toolbar">
2019-09-04 21:01:54 +05:30
<div class="d-inline-block">
2020-11-24 15:15:51 +05:30
<toolbar-button
tag="**"
:button-title="
sprintf(s__('MarkdownEditor|Add bold text (%{modifierKey}B)'), { modifierKey })
"
2021-04-29 21:17:54 +05:30
:shortcuts="$options.shortcuts.bold"
2020-11-24 15:15:51 +05:30
icon="bold"
/>
<toolbar-button
tag="_"
:button-title="
sprintf(s__('MarkdownEditor|Add italic text (%{modifierKey}I)'), { modifierKey })
"
2021-04-29 21:17:54 +05:30
:shortcuts="$options.shortcuts.italic"
2020-11-24 15:15:51 +05:30
icon="italic"
/>
2019-09-04 21:01:54 +05:30
<toolbar-button
:prepend="true"
2020-10-24 23:57:45 +05:30
:tag="tag"
2019-09-04 21:01:54 +05:30
:button-title="__('Insert a quote')"
icon="quote"
2020-10-24 23:57:45 +05:30
@click="handleQuote"
2019-09-04 21:01:54 +05:30
/>
</div>
<div class="d-inline-block ml-md-2 ml-0">
<template v-if="canSuggest">
<toolbar-button
ref="suggestButton"
:tag="mdSuggestion"
:prepend="true"
:button-title="__('Insert suggestion')"
:cursor-offset="4"
:tag-content="lineContent"
icon="doc-code"
2021-03-11 19:13:27 +05:30
data-qa-selector="suggestion_button"
2019-12-26 22:10:19 +05:30
class="js-suggestion-btn"
2019-09-04 21:01:54 +05:30
@click="handleSuggestDismissed"
/>
<gl-popover
2020-03-13 15:44:24 +05:30
v-if="showSuggestPopover && $refs.suggestButton"
:target="$refs.suggestButton"
2019-09-04 21:01:54 +05:30
:css-classes="['diff-suggest-popover']"
placement="bottom"
:show="showSuggestPopover"
>
<strong>{{ __('New! Suggest changes directly') }}</strong>
<p class="mb-2">
2020-03-13 15:44:24 +05:30
{{
__(
'Suggest code changes which can be immediately applied in one click. Try it out!',
)
}}
2019-09-04 21:01:54 +05:30
</p>
2020-10-24 23:57:45 +05:30
<gl-button
variant="info"
category="primary"
size="sm"
@click="handleSuggestDismissed"
>
2019-09-04 21:01:54 +05:30
{{ __('Got it') }}
2020-10-24 23:57:45 +05:30
</gl-button>
2019-09-04 21:01:54 +05:30
</gl-popover>
</template>
<toolbar-button tag="`" tag-block="```" :button-title="__('Insert code')" icon="code" />
<toolbar-button
tag="[{text}](url)"
tag-select="url"
2020-11-24 15:15:51 +05:30
:button-title="
sprintf(s__('MarkdownEditor|Add a link (%{modifierKey}K)'), { modifierKey })
"
2021-04-29 21:17:54 +05:30
:shortcuts="$options.shortcuts.link"
2019-09-04 21:01:54 +05:30
icon="link"
/>
</div>
<div class="d-inline-block ml-md-2 ml-0">
<toolbar-button
:prepend="true"
2020-06-23 00:09:42 +05:30
tag="- "
2019-09-04 21:01:54 +05:30
:button-title="__('Add a bullet list')"
icon="list-bulleted"
/>
<toolbar-button
:prepend="true"
tag="1. "
:button-title="__('Add a numbered list')"
icon="list-numbered"
/>
<toolbar-button
:prepend="true"
2020-06-23 00:09:42 +05:30
tag="- [ ] "
2019-09-04 21:01:54 +05:30
:button-title="__('Add a task list')"
2019-12-26 22:10:19 +05:30
icon="list-task"
2019-09-04 21:01:54 +05:30
/>
2021-06-08 01:23:25 +05:30
<toolbar-button
:tag="mdCollapsibleSection"
:prepend="true"
tag-select="Click to expand"
:button-title="__('Add a collapsible section')"
icon="details-block"
/>
2019-09-04 21:01:54 +05:30
<toolbar-button
:tag="mdTable"
:prepend="true"
:button-title="__('Add a table')"
icon="table"
/>
</div>
<div class="d-inline-block ml-md-2 ml-0">
<button
v-gl-tooltip
:aria-label="__('Go full screen')"
class="toolbar-btn toolbar-fullscreen-btn js-zen-enter"
data-container="body"
tabindex="-1"
:title="__('Go full screen')"
type="button"
>
2020-11-24 15:15:51 +05:30
<gl-icon name="maximize" />
2019-09-04 21:01:54 +05:30
</button>
</div>
2017-09-10 17:25:29 +05:30
</li>
</ul>
</div>
</template>