-
Notifications
You must be signed in to change notification settings - Fork 534
/
MarkdownEditor.tsx
385 lines (353 loc) · 14.9 KB
/
MarkdownEditor.tsx
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
import {isMacOS} from '@primer/behaviors/utils'
import {useSSRSafeId} from '@react-aria/ssr'
import React, {forwardRef, useCallback, useEffect, useImperativeHandle, useMemo, useRef, useState} from 'react'
import Box from '../../Box'
import {FileType} from '../hooks/useUnifiedFileSelect'
import {useIgnoreKeyboardActionsWhileComposing} from '../hooks/useIgnoreKeyboardActionsWhileComposing'
import {useResizeObserver} from '../../hooks/useResizeObserver'
import {useSyntheticChange} from '../hooks/useSyntheticChange'
import MarkdownViewer from '../MarkdownViewer'
import {SxProp} from '../../sx'
import createSlots from '../../utils/create-slots'
import VisuallyHidden from '../../_VisuallyHidden'
import {FormattingTools} from './_FormattingTools'
import {MarkdownEditorContext} from './_MarkdownEditorContext'
import {CoreToolbar, DefaultToolbarButtons} from './Toolbar'
import {Footer} from './_Footer'
import {MarkdownInput} from './_MarkdownInput'
import {FileUploadResult, useFileHandling} from './_useFileHandling'
import {useIndenting} from './_useIndenting'
import {useListEditing} from './_useListEditing'
import {MarkdownViewMode, ViewSwitch} from './_ViewSwitch'
import {useSafeAsyncCallback} from '../hooks/useSafeAsyncCallback'
import {SavedRepliesContext, SavedRepliesHandle, SavedReply} from './_SavedReplies'
import {Emoji} from './suggestions/_useEmojiSuggestions'
import {Mentionable} from './suggestions/_useMentionSuggestions'
import {Reference} from './suggestions/_useReferenceSuggestions'
export type MarkdownEditorProps = SxProp & {
/** Current value of the editor as a multiline markdown string. */
value: string
/** Called when the value changes. */
onChange: (newMarkdown: string) => void
/**
* Accepts Markdown and returns rendered HTML. To prevent XSS attacks,
* the HTML should be sanitized and/or come from a trusted source.
*/
onRenderPreview: (markdown: string) => Promise<string>
children: React.ReactNode
/** Disable the editor and all related buttons. Users can still switch between preview & edit modes. */
disabled?: boolean
/** Placeholder text to show when the editor is empty. By default, no placeholder will be shown. */
placeholder?: string
/** Maximum number of characters the markdown can hold (includes formatting characters like `*`). */
maxLength?: number
/**
* Force the editor to take up the full height of the container and disallow resizing. Only
* use when the container height is tall enough that the user will never want to expand the
* input further, ie when it takes the full height of the viewport.
*/
fullHeight?: boolean
/** ID of the describing element. */
'aria-describedby'?: string
/** Optionally control the view mode. If uncontrolled, leave this `undefined`. */
viewMode?: MarkdownViewMode
/** If `viewMode` is controlled, this will be called on change. */
onChangeViewMode?: (newViewMode: MarkdownViewMode) => void
/**
* Called when the user presses `Ctrl`/`Cmd` + `Enter`. Should almost always be wired to
* the same event as clicking the primary `actionButton`.
*/
onPrimaryAction?: () => void
/**
* Minimum number of visible lines of text in the editor.
* @default 5
*/
minHeightLines?: number
/**
* Maximum number of visible lines of text in the editor. Has no effect if `fullHeight = true`.
* @default 35
*/
maxHeightLines?: number
/** Array of all possible emojis to suggest. Leave `undefined` to disable emoji autocomplete. */
emojiSuggestions?: Array<Emoji>
/** Array of all possible mention suggestions. Leave `undefined` to disable `@`-mention autocomplete. */
mentionSuggestions?: Array<Mentionable>
/** Array of all possible references to suggest. Leave `undefined` to disable `#`-reference autocomplete. */
referenceSuggestions?: Array<Reference>
/**
* Uploads a file to a hosting service and returns the URL. If not provided, file uploads
* will be disabled.
*/
onUploadFile?: (file: File) => Promise<FileUploadResult>
/**
* Array of allowed file types. If `onUploadFile` is defined but this array is not, all
* file types will be accepted. You can still reject file types by rejecting the `onUploadFile`
* promise, but setting this array provides a better user experience by preventing the
* upload in the first place.
*/
acceptedFileTypes?: FileType[]
/** Control whether the editor font is monospace. */
monospace?: boolean
/** Control whether the input is required. */
required?: boolean
/** The name that will be given to the `textarea`. */
name?: string
/** To enable the saved replies feature, provide an array of replies. */
savedReplies?: SavedReply[]
}
export interface MarkdownEditorHandle {
/** Focus on the markdown textarea (has no effect in preview mode). */
focus: (options?: FocusOptions) => void
/** Scroll to the editor. */
scrollIntoView: (options?: ScrollIntoViewOptions) => void
}
const a11yOnlyStyle = {clipPath: 'Circle(0)', position: 'absolute'} as const
const CONDENSED_WIDTH_THRESHOLD = 675
const {Slot, Slots} = createSlots(['Toolbar', 'Actions', 'Label'])
export const MarkdownEditorSlot = Slot
/**
* Markdown textarea with controls & keyboard shortcuts.
*/
const MarkdownEditor = forwardRef<MarkdownEditorHandle, MarkdownEditorProps>(
(
{
value,
onChange,
disabled = false,
placeholder,
maxLength,
'aria-describedby': describedBy,
fullHeight,
onRenderPreview,
sx,
onPrimaryAction,
viewMode: controlledViewMode,
onChangeViewMode: controlledSetViewMode,
minHeightLines = 5,
maxHeightLines = 35,
emojiSuggestions,
mentionSuggestions,
referenceSuggestions,
onUploadFile,
acceptedFileTypes,
monospace = false,
required = false,
name,
children,
savedReplies
},
ref
) => {
const [uncontrolledViewMode, uncontrolledSetViewMode] = useState<MarkdownViewMode>('edit')
const [view, setView] =
controlledViewMode === undefined
? [uncontrolledViewMode, uncontrolledSetViewMode]
: [controlledViewMode, controlledSetViewMode]
const [html, setHtml] = useState<string | null>(null)
const safeSetHtml = useSafeAsyncCallback(setHtml)
const previewStale = useRef(true)
useEffect(() => {
previewStale.current = true
}, [value])
const loadPreview = async () => {
if (!previewStale.current) return
previewStale.current = false // set to false before the preview is rendered to prevent multiple concurrent calls
safeSetHtml(null)
safeSetHtml(await onRenderPreview(value))
}
useEffect(() => {
// we have to be careful here - loading preview sets state which causes a render which can cause an infinite loop,
// however that should be prevented by previewStale.current being set immediately in loadPreview
if (view === 'preview' && previewStale.current) loadPreview()
})
const inputRef = useRef<HTMLTextAreaElement>(null)
useImperativeHandle(ref, () => ({
focus: opts => inputRef.current?.focus(opts),
scrollIntoView: opts => containerRef.current?.scrollIntoView(opts)
}))
const inputHeight = useRef(0)
if (inputRef.current && inputRef.current.offsetHeight) inputHeight.current = inputRef.current.offsetHeight
const onInputChange = useCallback(
(e: React.ChangeEvent<HTMLTextAreaElement>) => {
onChange(e.target.value)
},
[onChange]
)
const emitChange = useSyntheticChange({inputRef, fallbackEventHandler: onInputChange})
const fileHandler = useFileHandling({
emitChange,
value,
inputRef,
disabled,
onUploadFile,
acceptedFileTypes
})
const listEditor = useListEditing({emitChange})
const indenter = useIndenting({emitChange})
const formattingToolsRef = useRef<FormattingTools>(null)
// use state instead of ref since we need to recalculate when the element mounts
const containerRef = useRef<HTMLDivElement>(null)
const [condensed, setCondensed] = useState(false)
const onResize = useCallback(
// it's fine that this isn't debounced because calling setCondensed with the current value will not trigger a render
() => setCondensed(containerRef.current !== null && containerRef.current.clientWidth < CONDENSED_WIDTH_THRESHOLD),
[]
)
useResizeObserver(onResize, containerRef.current)
// the ID must be unique for each instance while remaining constant across renders
const id = useSSRSafeId()
const descriptionId = `${id}-description`
const savedRepliesRef = useRef<SavedRepliesHandle>(null)
const onSelectSavedReply = (reply: SavedReply) => {
// need to wait a tick to run after the selectmenu finishes closing
requestAnimationFrame(() => emitChange(reply.content))
}
const savedRepliesContext = savedReplies ? {savedReplies, onSelect: onSelectSavedReply, ref: savedRepliesRef} : null
const inputCompositionProps = useIgnoreKeyboardActionsWhileComposing(
(e: React.KeyboardEvent<HTMLTextAreaElement>) => {
const format = formattingToolsRef.current
if (disabled) return
if (e.ctrlKey && e.key === '.') {
// saved replies are always Control, even on Mac
savedRepliesRef.current?.openMenu()
e.preventDefault()
e.stopPropagation()
} else if (isMacOS() ? e.metaKey : e.ctrlKey) {
if (e.key === 'Enter') onPrimaryAction?.()
else if (e.key === 'b') format?.bold()
else if (e.key === 'i') format?.italic()
else if (e.shiftKey && e.key === '.') format?.quote()
else if (e.key === 'e') format?.code()
else if (e.key === 'k') format?.link()
else if (e.key === '8') format?.unorderedList()
else if (e.shiftKey && e.key === '7') format?.orderedList()
else if (e.shiftKey && e.key === 'l') format?.taskList()
else return
e.preventDefault()
e.stopPropagation()
} else {
listEditor.onKeyDown(e)
indenter.onKeyDown(e)
}
}
)
// If we don't memoize the context object, every child will rerender on every render even if memoized
const context = useMemo(
() => ({disabled, formattingToolsRef, condensed, required}),
[disabled, formattingToolsRef, condensed, required]
)
// We are using MarkdownEditorContext instead of the built-in Slots context because Slots' context is not typesafe
return (
<Slots context={{}}>
{slots => (
<MarkdownEditorContext.Provider value={context}>
<fieldset
aria-disabled={
disabled /* if we set disabled={true}, we can't enable the buttons that should be enabled */
}
aria-describedby={describedBy ? `${descriptionId} ${describedBy}` : descriptionId}
style={{appearance: 'none', border: 'none'}}
>
<FormattingTools ref={formattingToolsRef} forInputId={id} />
<div style={{display: 'none'}}>{children}</div>
{slots.Label}
<Box
sx={{
display: 'flex',
flexDirection: 'column',
width: '100%',
borderColor: 'border.default',
borderWidth: 1,
borderStyle: 'solid',
borderRadius: 2,
p: 2,
height: fullHeight ? '100%' : undefined,
minInlineSize: 'auto',
bg: 'canvas.default',
color: disabled ? 'fg.subtle' : 'fg.default',
...sx
}}
ref={containerRef}
>
<VisuallyHidden id={descriptionId} aria-live="polite">
Markdown input:
{view === 'preview' ? ' preview mode selected.' : ' edit mode selected.'}
</VisuallyHidden>
<Box sx={{display: 'flex', pb: 2, gap: 2, justifyContent: 'space-between'}} as="header">
<ViewSwitch
selectedView={view}
onViewSelect={setView}
disabled={fileHandler?.uploadProgress !== undefined}
onLoadPreview={loadPreview}
/>
<Box sx={{display: 'flex'}}>
<SavedRepliesContext.Provider value={savedRepliesContext}>
{view === 'edit' &&
(slots.Toolbar ?? (
<CoreToolbar>
<DefaultToolbarButtons />
</CoreToolbar>
))}
</SavedRepliesContext.Provider>
</Box>
</Box>
<MarkdownInput
value={value}
onChange={onInputChange}
emojiSuggestions={emojiSuggestions}
mentionSuggestions={mentionSuggestions}
referenceSuggestions={referenceSuggestions}
disabled={disabled}
placeholder={placeholder}
id={id}
maxLength={maxLength}
ref={inputRef}
fullHeight={fullHeight}
isDraggedOver={fileHandler?.isDraggedOver ?? false}
minHeightLines={minHeightLines}
maxHeightLines={maxHeightLines}
visible={view === 'edit'}
monospace={monospace}
required={required}
name={name}
{...inputCompositionProps}
{...fileHandler?.pasteTargetProps}
{...fileHandler?.dropTargetProps}
/>
{view === 'preview' && (
<Box
sx={{
p: 1,
overflow: 'auto',
height: fullHeight ? '100%' : undefined,
minHeight: inputHeight.current,
boxSizing: 'border-box'
}}
aria-live="polite"
>
<h2 style={a11yOnlyStyle}>Rendered Markdown Preview</h2>
<MarkdownViewer
dangerousRenderedHTML={{__html: html || 'Nothing to preview'}}
loading={html === null}
openLinksInNewTab
/>
</Box>
)}
<Footer
actionButtons={slots.Actions}
fileDraggedOver={fileHandler?.isDraggedOver ?? false}
fileUploadProgress={fileHandler?.uploadProgress}
uploadButtonProps={fileHandler?.clickTargetProps ?? null}
errorMessage={fileHandler?.errorMessage}
previewMode={view === 'preview'}
/>
</Box>
</fieldset>
</MarkdownEditorContext.Provider>
)}
</Slots>
)
}
)
MarkdownEditor.displayName = 'MarkdownEditor'
export default MarkdownEditor