-
Notifications
You must be signed in to change notification settings - Fork 16
/
index.html
1908 lines (1907 loc) · 60 KB
/
index.html
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
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>
Input Events
</title>
<style>
.invisible-table table {
border: 0;
border-spacing: 0px;
border-collapse: collapse;
}
.invisible-table table td,
.invisible-table table th {
padding: 6px;
}
</style>
<script async class="remove" src=
"https://www.w3.org/Tools/respec/respec-w3c"></script>
<script class="remove">
var respecConfig = {
specStatus: "ED",
github: "w3c/input-events",
level: 2,
group: "webediting",
wgPublicList: "public-editing-tf",
editors: [
{
name: "Johannes Wilm",
mailto: "johannes@fiduswriter.org",
company: "Invited Expert",
w3cid: "75083",
},
],
formerEditors: [
{
name: "Ben Peters",
company: "Microsoft",
companyURL: "https://www.microsoft.com",
retiredDate: "2015-02-23"
},
],
otherLinks: [
{
key: "Latest published version by level",
data: [
{
value: "Level 2",
href: "https://www.w3.org/TR/input-events-2/",
},
],
},
{
key: "Latest editor's draft by level",
data: [
{
value: "Level 2",
href: "https://w3c.github.io/input-events/",
},
],
},
],
xref: ["dom", "html", "infra", "mimesniff", "uievents", "i18n-glossary",]
};
</script>
</head>
<body>
<section id="abstract">
<p>
This specification defines additions to events for text and related
input to allow for the monitoring and manipulation of default browser
behavior in the context of text editor applications and other
applications that deal with text input and text formatting. This
specification builds on the UI events spec [[UI-EVENTS]].
</p>
</section>
<section id="sotd">
<p>
Input Events Level 2 replaces the first version of Input Events
[[INPUT-EVENTS]] and includes:
</p>
<ul>
<li>Inputtypes for beforeinput events for the start and end of IME
compositions that allow isolation of the IME composition process.
</li>
<li>More requirements for cancelability of beforeinput events, so that
all beforeinput events apart from those being emited within an IME
composition process are cancelable.
</li>
</ul>
<p>
The <a href=
"https://github.com/web-platform-tests/wpt/tree/master/input-events">test
suite</a> and <a href=
"https://w3c.github.io/test-results/input-events/">implementation
reports</a> for the Input Events specification are still work in
progress.
</p>
</section>
<section>
<h2>
Introduction
</h2>
<p>
This document describes editing related additions to 2 events -
<a href="https://w3c.github.io/uievents/#event-type-input">input</a>
and <a href=
"https://w3c.github.io/uievents/#beforeinput">beforeinput</a> which are
described in the UI events spec [[UI-EVENTS]]. The goal of these events
is to allow authors to understand and/or override default edit behavior
both before and after editing occurs.
</p>
</section>
<section id="conformance"></section>
<section>
<h2>
Definitions
</h2>
<dl>
<dt>
<dfn>express intention</dfn>
</dt>
<dd>
A user can <a data-lt="express intention">express an intention</a> to
execute a specific editing operation by means of keyboard, IME,
speech, or similar method. Specific input actions are mapped to
intentions following platform-specific conventions.
</dd>
<dt>
<dfn>kill buffer</dfn>
</dt>
<dd>
<p>
<i>This definition is not normative.</i>
</p>A <a>kill buffer</a> is a in-memory store of richtext content
that is separate from the clipboard which allows for the temporal
storage of content that was deleted using specific deletion commands.
The user can replace the current selection with the content held in
the kill buffer by indicating an intention to yank the kill buffer.
</dd>
</dl>
</section>
<section>
<h2>
Problems solved
</h2>
<p>
<i>This section is not normative.</i>
</p>
<p>
Creating a webbased texteditor requires a considerable amount of
JavaScript on top of the browser code, among other things because:
</p>
<ol>
<li>Browsers do not handle all editing operations the same way.
</li>
<li>Browsers are often buggy in the way they handle certain editing
operations.
</li>
<li>Individual sites may have custom preferences for how they want to
handle certain editing operations.
</li>
<li>The development of high-level text editing features in browsers has
not followed the principles laid out in the <a href=
"https://extensiblewebmanifesto.org/">Extensible Web Manifesto</a> in
that development of these features has not always been in coordination
with the needs of the web developer community.
</li>
</ol>
<p>
This spec seeks to alleviate the problem by providing a simple way for
web developers to both override browser handling of all user input
related to text editing through the <a>beforeinput</a> event, and to
monitor what browsers have changed in the DOM due to user input through
the <a>input</a> event.
</p>
</section>
<section>
<h2>
Use cases
</h2>
<p>
<i>This section is not normative.</i>
</p>
<ol>
<li>Creating a JavaScript text editor in which the <strong>-tag
is used instead of the <b>-tag to mark text that the user marks
as bold, using any browser-builtin way to mark a text as bold, without
having access to all existing browsers.
</li>
<li>Creating a JavaScript text editor which works with a data model in
the background where JavaScript takes care of rendering changes to the
edited text to the DOM.
</li>
<li>Creating a JavaScript editor which only allows a subset of richtext
editing (for example: bold is allowed, but italic not).
</li>
<li>Creating a collaborative editor in which JavaScript is used to
render changes to the DOM, based on user intentions with users using
different browsers with different ways of expressing specific
intentions.
</li>
<li>Creating a JavaScript editor with different user access options,
where some users only can add or delete text and other users only can
add or remove certain types of formatting.
</li>
</ol>
</section>
<section id="events-inputevents">
<h3>
Input Event Types
</h3>
<p>
Input events are sent before (beforeinput event) and after (input
event) a user attempts to edit the markup. This includes insertion and
deletion of content, and formatting changes.
</p>
<p>
Input events are [=dispatched=] on elements that act as [=editing
hosts=], including elements with the contenteditable attribute set,
[^textarea^] elements, and [^input^] elements that permit text input.
</p>
<section id="interface-InputEvent">
<h4>
Interface InputEvent
</h4>
<pre class="idl">
partial interface InputEvent {
readonly attribute DataTransfer? dataTransfer;
sequence<StaticRange> getTargetRanges();
};
partial dictionary InputEventInit {
DataTransfer? dataTransfer = null;
sequence<StaticRange> targetRanges = [];
};
</pre>
<p data-dfn-for="InputEventInit">
The attributes {{InputEvent/inputType}}, <dfn>dataTransfer</dfn> and
<dfn data-lt="targetRange">targetRanges</dfn> of {{InputEventInit}}
initialize the corresponding attributes of the {{InputEvent}} object.
</p>
<section>
<h5>
Overview
</h5>
<p>
<i>This section is not normative.</i>
</p>
<p data-link-for="InputEvent">
The following table provides a summary of when the <a>data</a> and
<a>dataTransfer</a> attributes contain contents and when they are
null as well as when the <a>getTargetRanges()</a> method returns an
empty or non-empty Array, based on the inputType.
</p>
<table class="parameters simple">
<thead>
<tr>
<th>
Editing host
</th>
<th>
inputType
</th>
<th>
data
</th>
<th>
dataTransfer
</th>
<th>
getTargetRanges()
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
Contenteditable
</td>
<td>
<code>"insertText"</code>,
<code>"insertCompositionText"</code>,
<code>"formatSetBlockTextDirection"</code>,
<code>"formatSetInlineTextDirection"</code>,
<code>"formatBackColor"</code>,
<code>"formatFontColor"</code>,
<code>"formatFontName"</code>, <code>"insertLink"</code>
</td>
<td>
Yes
</td>
<td>
null
</td>
<td>
Non-empty Array
</td>
</tr>
<tr>
<td>
Contenteditable
</td>
<td>
<code>"insertFromPaste"</code>,
<code>"insertFromPasteAsQuotation"</code>,
<code>"insertFromDrop"</code>,
<code>"insertReplacementText"</code>,
<code>"insertFromYank"</code>
</td>
<td>
null
</td>
<td>
Yes
</td>
<td>
Non-empty Array
</td>
</tr>
<tr>
<td>
<code><textarea></code>, <code><input
type="text"></code>
</td>
<td>
<code>"insertText"</code>,
<code>"insertCompositionText"</code>,
<code>"insertFromPaste"</code>,
<code>"insertFromPasteAsQuotation"</code>,
<code>"insertFromDrop"</code>,
<code>"insertReplacementText"</code>,
<code>"insertFromYank"</code>,
<code>"formatSetBlockTextDirection"</code>,
<code>"formatSetInlineTextDirection"</code>,
<code>"formatBackColor"</code>,
<code>"formatFontColor"</code>,
<code>"formatFontName"</code>, <code>"insertLink"</code>
</td>
<td>
Yes
</td>
<td>
null
</td>
<td>
Empty Array
</td>
</tr>
<tr>
<td>
All
</td>
<td>
<code>"historyUndo"</code>, <code>"historyRedo"</code>
</td>
<td>
null
</td>
<td>
null
</td>
<td>
Empty Array
</td>
</tr>
<tr>
<td>
Contenteditable
</td>
<td>
All Remaining
</td>
<td>
null
</td>
<td>
null
</td>
<td>
Non-empty Array
</td>
</tr>
<tr>
<td>
<code><textarea></code>, <code><input
type="text"></code>
</td>
<td>
All Remaining
</td>
<td>
null
</td>
<td>
null
</td>
<td>
Empty Array
</td>
</tr>
</tbody>
</table>
</section>
<section id="interface-InputEvent-Attributes" data-dfn-for=
"InputEvent">
<h5>
Attributes
</h5>
<p>
The cancelability of the beforeinput event depends on the
inputType.
</p>
<p>
The inputType to be picked depends on the user's <a data-lt=
"express intention">expression of intention</a>, whether or not the
editing takes place during an IME composition and the state of the
selection.
</p>
<p>
This specification defines the inputType values as the values in
the inputType column of the following table.
</p>
<table class="parameters simple">
<thead>
<tr>
<th>
inputType
</th>
<th>
User's expression of intention
</th>
<th>
Part of IME composition
</th>
<th>
beforeinput cancelable
</th>
<th>
State of selection
</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<code>"insertText"</code>
</td>
<td>
insert typed plain text
</td>
<td>
No
</td>
<td>
Yes
</td>
<td>
Any
</td>
</tr>
<tr>
<td>
<code>"insertReplacementText"</code>
</td>
<td>
insert or replace existing text by means of a spell checker,
auto-correct, writing suggestions or similar
</td>
<td>
No
</td>
<td>
Yes
</td>
<td>
Any
</td>
</tr>
<tr>
<td>
<code>"insertLineBreak"</code>
</td>
<td>
insert a line break
</td>
<td>
No
</td>
<td>
Yes
</td>
<td>
Any
</td>
</tr>
<tr>
<td>
<code>"insertParagraph"</code>
</td>
<td>
insert a paragraph break
</td>
<td>
No
</td>
<td>
Yes
</td>
<td>
Any
</td>
</tr>
<tr>
<td>
<code>"insertOrderedList"</code>
</td>
<td>
insert a numbered list
</td>
<td>
No
</td>
<td>
Yes
</td>
<td>
Any
</td>
</tr>
<tr>
<td>
<code>"insertUnorderedList"</code>
</td>
<td>
insert a bulleted list
</td>
<td>
No
</td>
<td>
Yes
</td>
<td>
Any
</td>
</tr>
<tr>
<td>
<code>"insertHorizontalRule"</code>
</td>
<td>
insert a horizontal rule
</td>
<td>
No
</td>
<td>
Yes
</td>
<td>
Any
</td>
</tr>
<tr>
<td>
<code>"insertFromYank"</code>
</td>
<td>
replace the current selection with content stored in a
<a>kill buffer</a>
</td>
<td>
No
</td>
<td>
Yes
</td>
<td>
Any
</td>
</tr>
<tr>
<td>
<code>"insertFromDrop"</code>
</td>
<td>
insert content by means of drop
</td>
<td>
No
</td>
<td>
Yes
</td>
<td>
Any
</td>
</tr>
<tr>
<td>
<code>"insertFromPaste"</code>
</td>
<td>
paste content from clipboard or paste image from client
provided image library
</td>
<td>
No
</td>
<td>
Yes
</td>
<td>
Any
</td>
</tr>
<tr>
<td>
<code>"insertFromPasteAsQuotation"</code>
</td>
<td>
paste content from the clipboard as a quotation
</td>
<td>
No
</td>
<td>
Yes
</td>
<td>
Any
</td>
</tr>
<tr>
<td>
<code>"insertTranspose"</code>
</td>
<td>
transpose the last two [=grapheme cluster=]. that were
entered
</td>
<td>
No
</td>
<td>
Yes
</td>
<td>
Any
</td>
</tr>
<tr>
<td>
<code>"insertCompositionText"</code>
</td>
<td>
replace the current composition string
</td>
<td>
Yes
</td>
<td>
No
</td>
<td>
Any
</td>
</tr>
<tr>
<td>
<code>"insertLink"</code>
</td>
<td>
insert a link
</td>
<td>
No
</td>
<td>
Yes
</td>
<td>
Any
</td>
</tr>
<tr>
<td>
<code>"deleteWordBackward"</code>
</td>
<td>
delete a word directly before the caret position
</td>
<td>
No
</td>
<td>
Yes
</td>
<td>
Collapsed
</td>
</tr>
<tr>
<td>
<code>"deleteWordForward"</code>
</td>
<td>
delete a word directly after the caret position
</td>
<td>
No
</td>
<td>
Yes
</td>
<td>
Collapsed
</td>
</tr>
<tr>
<td>
<code>"deleteSoftLineBackward"</code>
</td>
<td>
delete from the caret to the nearest visual line break before
the caret position
</td>
<td>
No
</td>
<td>
Yes
</td>
<td>
Collapsed
</td>
</tr>
<tr>
<td>
<code>"deleteSoftLineForward"</code>
</td>
<td>
delete from the caret to the nearest visual line break after
the caret position
</td>
<td>
No
</td>
<td>
Yes
</td>
<td>
Collapsed
</td>
</tr>
<tr>
<td>
<code>"deleteEntireSoftLine"</code>
</td>
<td>
delete from the nearest visual line break before the caret
position to the nearest visual line break after the caret
position
</td>
<td>
No
</td>
<td>
Yes
</td>
<td>
Collapsed
</td>
</tr>
<tr>
<td>
<code>"deleteHardLineBackward"</code>
</td>
<td>
delete from the caret to the nearest beginning of a block
element or <code><a data-link-type="element" href=
"https://html.spec.whatwg.org/#the-br-element">br</a></code>
element before the caret position
</td>
<td>
No
</td>
<td>
Yes
</td>
<td>
Collapsed
</td>
</tr>
<tr>
<td>
<code>"deleteHardLineForward"</code>
</td>
<td>
delete from the caret to the nearest end of a block element
or <code><a data-link-type="element" href=
"https://html.spec.whatwg.org/#the-br-element">br</a></code>
element after the caret position
</td>
<td>
No
</td>
<td>
Yes
</td>
<td>
Collapsed
</td>
</tr>
<tr>
<td>
<code>"deleteByDrag"</code>
</td>
<td>
remove content from the DOM by means of drag
</td>
<td>
No
</td>
<td>
Yes
</td>
<td>
Any
</td>
</tr>
<tr>
<td>
<code>"deleteByCut"</code>
</td>
<td>
remove the current selection as part of a cut
</td>
<td>
No
</td>
<td>
Yes
</td>
<td>
Any
</td>
</tr>
<tr>
<td>
<code>"deleteContent"</code>
</td>
<td>
delete the selection without specifying the direction of the
deletion and this intention is not covered by another
inputType
</td>
<td>
No
</td>
<td>
Yes
</td>
<td>
Non-collapsed
</td>
</tr>
<tr>
<td>
<code>"deleteContentBackward"</code>
</td>
<td>
delete the content directly before the caret position and
this intention is not covered by another inputType or delete
the selection with the selection collapsing to its start
after the deletion
</td>
<td>
No
</td>
<td>
Yes
</td>
<td>
Any
</td>
</tr>
<tr>
<td>
<code>"deleteContentForward"</code>
</td>
<td>
delete the content directly after the caret position and this
intention is not covered by another inputType or delete the
selection with the selection collapsing to its end after the
deletion
</td>
<td>
No
</td>
<td>
Yes
</td>
<td>
Any
</td>
</tr>
<tr>
<td>
<code>"historyUndo"</code>
</td>
<td>
undo the last editing action
</td>
<td>
No
</td>
<td>
Yes
</td>
<td>
Any
</td>
</tr>
<tr>
<td>
<code>"historyRedo"</code>
</td>
<td>
to redo the last undone editing action
</td>
<td>
No
</td>
<td>
Yes
</td>
<td>
Any
</td>
</tr>
<tr>
<td>
<code>"formatBold"</code>
</td>
<td>
initiate bold text
</td>
<td>
No
</td>
<td>
Yes
</td>
<td>
Any
</td>
</tr>
<tr>
<td>
<code>"formatItalic"</code>
</td>
<td>
initiate italic text
</td>
<td>
No
</td>
<td>
Yes
</td>
<td>
Any
</td>
</tr>
<tr>
<td>
<code>"formatUnderline"</code>
</td>
<td>
initiate underline text
</td>
<td>
No
</td>
<td>
Yes
</td>
<td>
Any
</td>
</tr>
<tr>
<td>
<code>"formatStrikeThrough"</code>
</td>
<td>
initiate stricken through text