release : rich text editor (TipTap) (#38)
All checks were successful
Release / release (push) Successful in 1m6s
All checks were successful
Release / release (push) Successful in 1m6s
## Résumé Release de `develop` vers `main` pour déclencher `semantic-release` (publication sur Gitea Packages). Inclut : - **#37** — `feat(input-rich-text) : ajout d'un éditeur de texte riche basé sur TipTap v3` Le commit `feat:` déclenchera un bump **minor** (rétrocompatible). ## Test plan - [x] Tests verts sur `develop` (315/315) - [x] Lint OK (0 erreur sur les fichiers ajoutés) - [x] Histoire build OK - [ ] Vérifier le run du workflow `release.yml` après merge - [ ] Vérifier la nouvelle version publiée sur Gitea Packages Co-authored-by: kevin <kevin@yuno.malio.fr> Co-authored-by: tristan <tristan@yuno.malio.fr> Co-authored-by: Kevin Boudet <kevin@yuno.malio.fr> Reviewed-on: #38
This commit was merged in pull request #38.
This commit is contained in:
326
app/components/malio/input/InputRichText.vue
Normal file
326
app/components/malio/input/InputRichText.vue
Normal file
@@ -0,0 +1,326 @@
|
||||
<template>
|
||||
<div :class="mergedGroupClass">
|
||||
<label
|
||||
v-if="label"
|
||||
:for="editorId"
|
||||
:class="mergedLabelClass"
|
||||
>
|
||||
{{ label }}
|
||||
</label>
|
||||
|
||||
<!-- Mode lecture seule (rendu uniquement) -->
|
||||
<div
|
||||
v-if="!editable"
|
||||
:id="editorId"
|
||||
:class="mergedReadonlyClass"
|
||||
>
|
||||
<EditorContent :editor="editor" />
|
||||
</div>
|
||||
|
||||
<!-- Mode éditable -->
|
||||
<div
|
||||
v-else
|
||||
:id="editorId"
|
||||
:class="mergedEditorWrapperClass"
|
||||
@click="focusEditor"
|
||||
>
|
||||
<div
|
||||
class="flex flex-wrap items-center gap-0.5 border-b border-m-border bg-m-bg p-1"
|
||||
@click.stop
|
||||
>
|
||||
<button
|
||||
v-for="btn in toolbarButtons"
|
||||
:key="btn.key"
|
||||
type="button"
|
||||
class="flex h-8 w-8 items-center justify-center rounded text-m-text transition-colors hover:bg-m-primary/10 disabled:cursor-not-allowed disabled:opacity-40"
|
||||
:class="btn.isActive() ? 'bg-m-primary/15 text-m-primary' : ''"
|
||||
:title="btn.title"
|
||||
:disabled="disabled || readonly"
|
||||
:aria-label="btn.title"
|
||||
:aria-pressed="btn.isActive()"
|
||||
@mousedown.prevent
|
||||
@click="btn.action()"
|
||||
>
|
||||
<IconifyIcon :icon="btn.icon" :width="18" :height="18" />
|
||||
</button>
|
||||
|
||||
<span class="mx-1 h-5 w-px bg-m-border" aria-hidden="true" />
|
||||
|
||||
<button
|
||||
type="button"
|
||||
class="flex h-8 w-8 items-center justify-center rounded text-m-text transition-colors hover:bg-m-primary/10 disabled:cursor-not-allowed disabled:opacity-40"
|
||||
title="Annuler"
|
||||
aria-label="Annuler"
|
||||
:disabled="disabled || readonly || !editor?.can().undo()"
|
||||
@mousedown.prevent
|
||||
@click="editor?.chain().focus().undo().run()"
|
||||
>
|
||||
<IconifyIcon icon="mdi:undo" :width="18" :height="18" />
|
||||
</button>
|
||||
<button
|
||||
type="button"
|
||||
class="flex h-8 w-8 items-center justify-center rounded text-m-text transition-colors hover:bg-m-primary/10 disabled:cursor-not-allowed disabled:opacity-40"
|
||||
title="Rétablir"
|
||||
aria-label="Rétablir"
|
||||
:disabled="disabled || readonly || !editor?.can().redo()"
|
||||
@mousedown.prevent
|
||||
@click="editor?.chain().focus().redo().run()"
|
||||
>
|
||||
<IconifyIcon icon="mdi:redo" :width="18" :height="18" />
|
||||
</button>
|
||||
</div>
|
||||
|
||||
<EditorContent
|
||||
:editor="editor"
|
||||
class="malio-rich-text flex flex-1 cursor-text"
|
||||
:style="{ minHeight }"
|
||||
:aria-invalid="hasError || undefined"
|
||||
:aria-describedby="describedBy"
|
||||
/>
|
||||
</div>
|
||||
|
||||
<p
|
||||
v-if="hint || hasError || hasSuccess"
|
||||
:id="`${editorId}-describedby`"
|
||||
:class="[
|
||||
hasError
|
||||
? 'text-m-danger'
|
||||
: hasSuccess
|
||||
? 'text-m-success'
|
||||
: 'text-m-muted',
|
||||
'mt-1 text-xs ml-[2px]',
|
||||
]"
|
||||
>
|
||||
{{ error || success || hint }}
|
||||
</p>
|
||||
</div>
|
||||
</template>
|
||||
|
||||
<script setup lang="ts">
|
||||
import { computed, onBeforeUnmount, onMounted, shallowRef, useId, watch } from 'vue'
|
||||
import { Icon as IconifyIcon } from '@iconify/vue'
|
||||
import { Editor, EditorContent } from '@tiptap/vue-3'
|
||||
import StarterKit from '@tiptap/starter-kit'
|
||||
import Placeholder from '@tiptap/extension-placeholder'
|
||||
import { Markdown } from 'tiptap-markdown'
|
||||
import { twMerge } from 'tailwind-merge'
|
||||
|
||||
defineOptions({ name: 'MalioInputRichText', inheritAttrs: false })
|
||||
|
||||
type OutputFormat = 'markdown' | 'html'
|
||||
|
||||
const props = withDefaults(
|
||||
defineProps<{
|
||||
id?: string
|
||||
label?: string
|
||||
modelValue?: string | null | undefined
|
||||
placeholder?: string
|
||||
minHeight?: string
|
||||
editable?: boolean
|
||||
disabled?: boolean
|
||||
readonly?: boolean
|
||||
hint?: string
|
||||
error?: string
|
||||
success?: string
|
||||
outputFormat?: OutputFormat
|
||||
groupClass?: string
|
||||
labelClass?: string
|
||||
editorClass?: string
|
||||
}>(),
|
||||
{
|
||||
id: '',
|
||||
label: '',
|
||||
modelValue: undefined,
|
||||
placeholder: '',
|
||||
minHeight: '160px',
|
||||
editable: true,
|
||||
disabled: false,
|
||||
readonly: false,
|
||||
hint: '',
|
||||
error: '',
|
||||
success: '',
|
||||
outputFormat: 'markdown',
|
||||
groupClass: '',
|
||||
labelClass: '',
|
||||
editorClass: '',
|
||||
},
|
||||
)
|
||||
|
||||
const emit = defineEmits<{
|
||||
(event: 'update:modelValue', value: string): void
|
||||
}>()
|
||||
|
||||
const generatedId = useId()
|
||||
const editor = shallowRef<Editor>()
|
||||
const isFocused = shallowRef(false)
|
||||
|
||||
const editorId = computed(() => props.id?.toString() || `malio-input-rich-text-${generatedId}`)
|
||||
const hasError = computed(() => !!props.error)
|
||||
const hasSuccess = computed(() => !!props.success && !hasError.value)
|
||||
const isInteractionLocked = computed(() => props.disabled || props.readonly)
|
||||
|
||||
const describedBy = computed(() =>
|
||||
hasError.value || hasSuccess.value || props.hint ? `${editorId.value}-describedby` : undefined,
|
||||
)
|
||||
|
||||
const mergedGroupClass = computed(() => twMerge('w-full', props.groupClass))
|
||||
|
||||
const mergedLabelClass = computed(() =>
|
||||
twMerge(
|
||||
'mb-1 block text-sm font-medium',
|
||||
hasError.value
|
||||
? 'text-m-danger'
|
||||
: hasSuccess.value
|
||||
? 'text-m-success'
|
||||
: isFocused.value
|
||||
? 'text-m-primary'
|
||||
: 'text-m-text',
|
||||
props.disabled ? 'text-black/60' : '',
|
||||
props.labelClass,
|
||||
),
|
||||
)
|
||||
|
||||
const mergedEditorWrapperClass = computed(() =>
|
||||
twMerge(
|
||||
'rich-text-wrapper flex flex-col overflow-hidden rounded-md border bg-white transition-colors',
|
||||
hasError.value
|
||||
? 'border-m-danger focus-within:border-m-danger'
|
||||
: hasSuccess.value
|
||||
? 'border-m-success focus-within:border-m-success'
|
||||
: isFocused.value
|
||||
? 'border-m-primary'
|
||||
: 'border-m-muted hover:border-m-text/60',
|
||||
props.disabled ? 'cursor-not-allowed bg-m-bg/50 opacity-70' : '',
|
||||
props.editorClass,
|
||||
),
|
||||
)
|
||||
|
||||
const mergedReadonlyClass = computed(() =>
|
||||
twMerge(
|
||||
'malio-rich-text prose prose-sm max-w-none rounded-md border border-m-border bg-white p-3',
|
||||
'prose-headings:font-semibold prose-a:text-m-primary',
|
||||
'prose-code:rounded prose-code:bg-m-bg prose-code:px-1.5 prose-code:py-0.5 prose-code:before:content-none prose-code:after:content-none',
|
||||
'prose-pre:bg-m-text prose-pre:text-white',
|
||||
props.editorClass,
|
||||
),
|
||||
)
|
||||
|
||||
const focusEditor = () => {
|
||||
if (isInteractionLocked.value) return
|
||||
editor.value?.commands.focus()
|
||||
}
|
||||
|
||||
const promptForLink = () => {
|
||||
if (!editor.value) return
|
||||
const previous = editor.value.getAttributes('link').href as string | undefined
|
||||
const url = window.prompt('URL du lien (vide pour retirer)', previous ?? '')
|
||||
if (url === null) return
|
||||
if (url === '') {
|
||||
editor.value.chain().focus().extendMarkRange('link').unsetLink().run()
|
||||
return
|
||||
}
|
||||
editor.value.chain().focus().extendMarkRange('link').setLink({ href: url }).run()
|
||||
}
|
||||
|
||||
const toolbarButtons = computed(() => {
|
||||
const e = editor.value
|
||||
return [
|
||||
{ key: 'bold', icon: 'mdi:format-bold', title: 'Gras', isActive: () => !!e?.isActive('bold'), action: () => e?.chain().focus().toggleBold().run() },
|
||||
{ key: 'italic', icon: 'mdi:format-italic', title: 'Italique', isActive: () => !!e?.isActive('italic'), action: () => e?.chain().focus().toggleItalic().run() },
|
||||
{ key: 'strike', icon: 'mdi:format-strikethrough', title: 'Barré', isActive: () => !!e?.isActive('strike'), action: () => e?.chain().focus().toggleStrike().run() },
|
||||
{ key: 'h2', icon: 'mdi:format-header-2', title: 'Titre H2', isActive: () => !!e?.isActive('heading', { level: 2 }), action: () => e?.chain().focus().toggleHeading({ level: 2 }).run() },
|
||||
{ key: 'h3', icon: 'mdi:format-header-3', title: 'Titre H3', isActive: () => !!e?.isActive('heading', { level: 3 }), action: () => e?.chain().focus().toggleHeading({ level: 3 }).run() },
|
||||
{ key: 'bulletList', icon: 'mdi:format-list-bulleted', title: 'Liste à puces', isActive: () => !!e?.isActive('bulletList'), action: () => e?.chain().focus().toggleBulletList().run() },
|
||||
{ key: 'orderedList', icon: 'mdi:format-list-numbered', title: 'Liste numérotée', isActive: () => !!e?.isActive('orderedList'), action: () => e?.chain().focus().toggleOrderedList().run() },
|
||||
{ key: 'blockquote', icon: 'mdi:format-quote-close', title: 'Citation', isActive: () => !!e?.isActive('blockquote'), action: () => e?.chain().focus().toggleBlockquote().run() },
|
||||
{ key: 'code', icon: 'mdi:code-tags', title: 'Code inline', isActive: () => !!e?.isActive('code'), action: () => e?.chain().focus().toggleCode().run() },
|
||||
{ key: 'codeBlock', icon: 'mdi:code-braces-box', title: 'Bloc de code', isActive: () => !!e?.isActive('codeBlock'), action: () => e?.chain().focus().toggleCodeBlock().run() },
|
||||
{ key: 'link', icon: 'mdi:link-variant', title: 'Lien', isActive: () => !!e?.isActive('link'), action: promptForLink },
|
||||
]
|
||||
})
|
||||
|
||||
const getCurrentValue = (): string => {
|
||||
if (!editor.value) return ''
|
||||
if (props.outputFormat === 'html') return editor.value.getHTML()
|
||||
const storage = editor.value.storage.markdown as { getMarkdown: () => string } | undefined
|
||||
return storage ? storage.getMarkdown() : editor.value.getHTML()
|
||||
}
|
||||
|
||||
onMounted(() => {
|
||||
editor.value = new Editor({
|
||||
content: props.modelValue ?? '',
|
||||
editable: props.editable && !props.disabled && !props.readonly,
|
||||
extensions: [
|
||||
StarterKit.configure({
|
||||
heading: { levels: [2, 3] },
|
||||
link: {
|
||||
openOnClick: false,
|
||||
autolink: true,
|
||||
HTMLAttributes: { rel: 'noopener noreferrer nofollow', target: '_blank' },
|
||||
},
|
||||
}),
|
||||
Placeholder.configure({
|
||||
placeholder: props.placeholder,
|
||||
}),
|
||||
Markdown.configure({
|
||||
html: false,
|
||||
tightLists: true,
|
||||
bulletListMarker: '-',
|
||||
linkify: true,
|
||||
breaks: false,
|
||||
transformPastedText: true,
|
||||
transformCopiedText: true,
|
||||
}),
|
||||
],
|
||||
editorProps: {
|
||||
attributes: {
|
||||
class: 'prose prose-sm max-w-none w-full p-3 focus:outline-none prose-headings:font-semibold prose-a:text-m-primary prose-code:rounded prose-code:bg-m-bg prose-code:px-1.5 prose-code:py-0.5 prose-code:before:content-none prose-code:after:content-none prose-pre:bg-m-text prose-pre:text-white',
|
||||
},
|
||||
},
|
||||
onUpdate: () => {
|
||||
emit('update:modelValue', getCurrentValue())
|
||||
},
|
||||
onFocus: () => {
|
||||
isFocused.value = true
|
||||
},
|
||||
onBlur: () => {
|
||||
isFocused.value = false
|
||||
},
|
||||
})
|
||||
})
|
||||
|
||||
onBeforeUnmount(() => {
|
||||
editor.value?.destroy()
|
||||
})
|
||||
|
||||
watch(() => props.modelValue, (incoming) => {
|
||||
if (!editor.value) return
|
||||
if ((incoming ?? '') === getCurrentValue()) return
|
||||
editor.value.commands.setContent(incoming ?? '', { emitUpdate: false })
|
||||
})
|
||||
|
||||
watch(() => [props.editable, props.disabled, props.readonly], () => {
|
||||
editor.value?.setEditable(props.editable && !props.disabled && !props.readonly)
|
||||
})
|
||||
</script>
|
||||
|
||||
<style scoped>
|
||||
.malio-rich-text :deep(.ProseMirror) {
|
||||
outline: none;
|
||||
flex: 1 1 auto;
|
||||
min-width: 0;
|
||||
}
|
||||
.malio-rich-text :deep(.ProseMirror > *:first-child) {
|
||||
margin-top: 0;
|
||||
}
|
||||
.malio-rich-text :deep(.ProseMirror > *:last-child) {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
.malio-rich-text :deep(.ProseMirror p.is-editor-empty:first-child::before) {
|
||||
content: attr(data-placeholder);
|
||||
float: left;
|
||||
color: rgb(var(--m-muted));
|
||||
pointer-events: none;
|
||||
height: 0;
|
||||
}
|
||||
</style>
|
||||
Reference in New Issue
Block a user