Skip to content

Commit 1d6d4bb

Browse files
harbournickharbournick
authored
feat(document-api): list creation and style edit commands (#2457)
* feat(document-api): list creation and style edit commands * chore: fix type * fix: sequence-local list style edits and add restart regression coverage
1 parent 26cef26 commit 1d6d4bb

34 files changed

Lines changed: 5844 additions & 174 deletions

‎apps/docs/document-api/available-operations.mdx‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Use the tables below to see what operations are available and where each one is
3333
| Hyperlinks | 6 | 0 | 6 | [Reference](/document-api/reference/hyperlinks/index) |
3434
| Images | 27 | 0 | 27 | [Reference](/document-api/reference/images/index) |
3535
| Index | 11 | 0 | 11 | [Reference](/document-api/reference/index/index) |
36-
| Lists | 29 | 0 | 29 | [Reference](/document-api/reference/lists/index) |
36+
| Lists | 36 | 0 | 36 | [Reference](/document-api/reference/lists/index) |
3737
| Mutations | 2 | 0 | 2 | [Reference](/document-api/reference/mutations/index) |
3838
| Paragraph Formatting | 17 | 0 | 17 | [Reference](/document-api/reference/format/paragraph/index) |
3939
| Paragraph Styles | 2 | 0 | 2 | [Reference](/document-api/reference/styles/paragraph/index) |
@@ -306,6 +306,13 @@ Use the tables below to see what operations are available and where each one is
306306
| <span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}><code>editor.doc.lists.setLevelTrailingCharacter(...)</code></span> | [`lists.setLevelTrailingCharacter`](/document-api/reference/lists/set-level-trailing-character) |
307307
| <span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}><code>editor.doc.lists.setLevelMarkerFont(...)</code></span> | [`lists.setLevelMarkerFont`](/document-api/reference/lists/set-level-marker-font) |
308308
| <span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}><code>editor.doc.lists.clearLevelOverrides(...)</code></span> | [`lists.clearLevelOverrides`](/document-api/reference/lists/clear-level-overrides) |
309+
| <span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}><code>editor.doc.lists.getStyle(...)</code></span> | [`lists.getStyle`](/document-api/reference/lists/get-style) |
310+
| <span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}><code>editor.doc.lists.applyStyle(...)</code></span> | [`lists.applyStyle`](/document-api/reference/lists/apply-style) |
311+
| <span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}><code>editor.doc.lists.restartAt(...)</code></span> | [`lists.restartAt`](/document-api/reference/lists/restart-at) |
312+
| <span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}><code>editor.doc.lists.setLevelNumberStyle(...)</code></span> | [`lists.setLevelNumberStyle`](/document-api/reference/lists/set-level-number-style) |
313+
| <span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}><code>editor.doc.lists.setLevelText(...)</code></span> | [`lists.setLevelText`](/document-api/reference/lists/set-level-text) |
314+
| <span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}><code>editor.doc.lists.setLevelStart(...)</code></span> | [`lists.setLevelStart`](/document-api/reference/lists/set-level-start) |
315+
| <span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}><code>editor.doc.lists.setLevelLayout(...)</code></span> | [`lists.setLevelLayout`](/document-api/reference/lists/set-level-layout) |
309316
| <span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}><code>editor.doc.mutations.preview(...)</code></span> | [`mutations.preview`](/document-api/reference/mutations/preview) |
310317
| <span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}><code>editor.doc.mutations.apply(...)</code></span> | [`mutations.apply`](/document-api/reference/mutations/apply) |
311318
| <span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}><code>editor.doc.format.paragraph.resetDirectFormatting(...)</code></span> | [`format.paragraph.resetDirectFormatting`](/document-api/reference/format/paragraph/reset-direct-formatting) |

‎apps/docs/document-api/reference/_generated-manifest.json‎

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -278,6 +278,7 @@
278278
"apps/docs/document-api/reference/info.mdx",
279279
"apps/docs/document-api/reference/insert.mdx",
280280
"apps/docs/document-api/reference/lists/apply-preset.mdx",
281+
"apps/docs/document-api/reference/lists/apply-style.mdx",
281282
"apps/docs/document-api/reference/lists/apply-template.mdx",
282283
"apps/docs/document-api/reference/lists/attach.mdx",
283284
"apps/docs/document-api/reference/lists/can-continue-previous.mdx",
@@ -288,21 +289,27 @@
288289
"apps/docs/document-api/reference/lists/convert-to-text.mdx",
289290
"apps/docs/document-api/reference/lists/create.mdx",
290291
"apps/docs/document-api/reference/lists/detach.mdx",
292+
"apps/docs/document-api/reference/lists/get-style.mdx",
291293
"apps/docs/document-api/reference/lists/get.mdx",
292294
"apps/docs/document-api/reference/lists/indent.mdx",
293295
"apps/docs/document-api/reference/lists/index.mdx",
294296
"apps/docs/document-api/reference/lists/insert.mdx",
295297
"apps/docs/document-api/reference/lists/join.mdx",
296298
"apps/docs/document-api/reference/lists/list.mdx",
297299
"apps/docs/document-api/reference/lists/outdent.mdx",
300+
"apps/docs/document-api/reference/lists/restart-at.mdx",
298301
"apps/docs/document-api/reference/lists/separate.mdx",
299302
"apps/docs/document-api/reference/lists/set-level-alignment.mdx",
300303
"apps/docs/document-api/reference/lists/set-level-bullet.mdx",
301304
"apps/docs/document-api/reference/lists/set-level-indents.mdx",
305+
"apps/docs/document-api/reference/lists/set-level-layout.mdx",
302306
"apps/docs/document-api/reference/lists/set-level-marker-font.mdx",
307+
"apps/docs/document-api/reference/lists/set-level-number-style.mdx",
303308
"apps/docs/document-api/reference/lists/set-level-numbering.mdx",
304309
"apps/docs/document-api/reference/lists/set-level-picture-bullet.mdx",
305310
"apps/docs/document-api/reference/lists/set-level-restart.mdx",
311+
"apps/docs/document-api/reference/lists/set-level-start.mdx",
312+
"apps/docs/document-api/reference/lists/set-level-text.mdx",
306313
"apps/docs/document-api/reference/lists/set-level-trailing-character.mdx",
307314
"apps/docs/document-api/reference/lists/set-level.mdx",
308315
"apps/docs/document-api/reference/lists/set-type.mdx",
@@ -567,7 +574,14 @@
567574
"lists.setLevelIndents",
568575
"lists.setLevelTrailingCharacter",
569576
"lists.setLevelMarkerFont",
570-
"lists.clearLevelOverrides"
577+
"lists.clearLevelOverrides",
578+
"lists.getStyle",
579+
"lists.applyStyle",
580+
"lists.restartAt",
581+
"lists.setLevelNumberStyle",
582+
"lists.setLevelText",
583+
"lists.setLevelStart",
584+
"lists.setLevelLayout"
571585
],
572586
"pagePath": "apps/docs/document-api/reference/lists/index.mdx",
573587
"title": "Lists"
@@ -962,5 +976,5 @@
962976
}
963977
],
964978
"marker": "{/* GENERATED FILE: DO NOT EDIT. Regenerate via `pnpm run docapi:sync`. */}",
965-
"sourceHash": "7c98e8a222685ebb7801111b454a2e5bc6ef18b1ce4a9d7d576a5e48aa69bd5f"
979+
"sourceHash": "455ce1c9b3cf75b22ae1ebc76bddb66f31f70f0ab46cea0f178063c87e476dbd"
966980
}

0 commit comments

Comments
 (0)