Skip to content

Commit 86600ac

Browse files
harbournickharbournick
authored
feat(document-api): add paragraph direction ops and clarify format.rtl (#2474)
* feat(document-api): add paragraph direction ops and clarify format.rtl * chore: add doc api story test
1 parent 7de2864 commit 86600ac

27 files changed

Lines changed: 1338 additions & 17 deletions

File tree

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Use the tables below to see what operations are available and where each one is
3535
| Index | 11 | 0 | 11 | [Reference](/document-api/reference/index/index) |
3636
| Lists | 36 | 0 | 36 | [Reference](/document-api/reference/lists/index) |
3737
| Mutations | 2 | 0 | 2 | [Reference](/document-api/reference/mutations/index) |
38-
| Paragraph Formatting | 17 | 0 | 17 | [Reference](/document-api/reference/format/paragraph/index) |
38+
| Paragraph Formatting | 19 | 0 | 19 | [Reference](/document-api/reference/format/paragraph/index) |
3939
| Paragraph Styles | 2 | 0 | 2 | [Reference](/document-api/reference/styles/paragraph/index) |
4040
| Query | 1 | 0 | 1 | [Reference](/document-api/reference/query/index) |
4141
| Ranges | 1 | 0 | 1 | [Reference](/document-api/reference/ranges/index) |
@@ -332,6 +332,8 @@ Use the tables below to see what operations are available and where each one is
332332
| <span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}><code>editor.doc.format.paragraph.clearBorder(...)</code></span> | [`format.paragraph.clearBorder`](/document-api/reference/format/paragraph/clear-border) |
333333
| <span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}><code>editor.doc.format.paragraph.setShading(...)</code></span> | [`format.paragraph.setShading`](/document-api/reference/format/paragraph/set-shading) |
334334
| <span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}><code>editor.doc.format.paragraph.clearShading(...)</code></span> | [`format.paragraph.clearShading`](/document-api/reference/format/paragraph/clear-shading) |
335+
| <span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}><code>editor.doc.format.paragraph.setDirection(...)</code></span> | [`format.paragraph.setDirection`](/document-api/reference/format/paragraph/set-direction) |
336+
| <span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}><code>editor.doc.format.paragraph.clearDirection(...)</code></span> | [`format.paragraph.clearDirection`](/document-api/reference/format/paragraph/clear-direction) |
335337
| <span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}><code>editor.doc.styles.paragraph.setStyle(...)</code></span> | [`styles.paragraph.setStyle`](/document-api/reference/styles/paragraph/set-style) |
336338
| <span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}><code>editor.doc.styles.paragraph.clearStyle(...)</code></span> | [`styles.paragraph.clearStyle`](/document-api/reference/styles/paragraph/clear-style) |
337339
| <span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}><code>editor.doc.query.match(...)</code></span> | [`query.match`](/document-api/reference/query/match) |

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

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -177,6 +177,7 @@
177177
"apps/docs/document-api/reference/format/paragraph/clear-alignment.mdx",
178178
"apps/docs/document-api/reference/format/paragraph/clear-all-tab-stops.mdx",
179179
"apps/docs/document-api/reference/format/paragraph/clear-border.mdx",
180+
"apps/docs/document-api/reference/format/paragraph/clear-direction.mdx",
180181
"apps/docs/document-api/reference/format/paragraph/clear-indentation.mdx",
181182
"apps/docs/document-api/reference/format/paragraph/clear-shading.mdx",
182183
"apps/docs/document-api/reference/format/paragraph/clear-spacing.mdx",
@@ -185,6 +186,7 @@
185186
"apps/docs/document-api/reference/format/paragraph/reset-direct-formatting.mdx",
186187
"apps/docs/document-api/reference/format/paragraph/set-alignment.mdx",
187188
"apps/docs/document-api/reference/format/paragraph/set-border.mdx",
189+
"apps/docs/document-api/reference/format/paragraph/set-direction.mdx",
188190
"apps/docs/document-api/reference/format/paragraph/set-flow-options.mdx",
189191
"apps/docs/document-api/reference/format/paragraph/set-indentation.mdx",
190192
"apps/docs/document-api/reference/format/paragraph/set-keep-options.mdx",
@@ -637,7 +639,9 @@
637639
"format.paragraph.setBorder",
638640
"format.paragraph.clearBorder",
639641
"format.paragraph.setShading",
640-
"format.paragraph.clearShading"
642+
"format.paragraph.clearShading",
643+
"format.paragraph.setDirection",
644+
"format.paragraph.clearDirection"
641645
],
642646
"pagePath": "apps/docs/document-api/reference/format/paragraph/index.mdx",
643647
"title": "Paragraph Formatting"
@@ -982,5 +986,5 @@
982986
}
983987
],
984988
"marker": "{/* GENERATED FILE: DO NOT EDIT. Regenerate via `pnpm run docapi:sync`. */}",
985-
"sourceHash": "b1e07574718dbcf5b2b9c21f2d944fb24d5a487eeadd1fc07ea1c117bba8aa83"
989+
"sourceHash": "34852ca3a36fdbc4e68902541e89a9602b49b5031aacef23008f9c1f8d3f4677"
986990
}

‎apps/docs/document-api/reference/capabilities/get.mdx‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1077,6 +1077,11 @@ _No fields._
10771077
| `operations.format.paragraph.clearBorder.dryRun` | boolean | yes | |
10781078
| `operations.format.paragraph.clearBorder.reasons` | enum[] | no | |
10791079
| `operations.format.paragraph.clearBorder.tracked` | boolean | yes | |
1080+
| `operations.format.paragraph.clearDirection` | object | yes | |
1081+
| `operations.format.paragraph.clearDirection.available` | boolean | yes | |
1082+
| `operations.format.paragraph.clearDirection.dryRun` | boolean | yes | |
1083+
| `operations.format.paragraph.clearDirection.reasons` | enum[] | no | |
1084+
| `operations.format.paragraph.clearDirection.tracked` | boolean | yes | |
10801085
| `operations.format.paragraph.clearIndentation` | object | yes | |
10811086
| `operations.format.paragraph.clearIndentation.available` | boolean | yes | |
10821087
| `operations.format.paragraph.clearIndentation.dryRun` | boolean | yes | |
@@ -1112,6 +1117,11 @@ _No fields._
11121117
| `operations.format.paragraph.setBorder.dryRun` | boolean | yes | |
11131118
| `operations.format.paragraph.setBorder.reasons` | enum[] | no | |
11141119
| `operations.format.paragraph.setBorder.tracked` | boolean | yes | |
1120+
| `operations.format.paragraph.setDirection` | object | yes | |
1121+
| `operations.format.paragraph.setDirection.available` | boolean | yes | |
1122+
| `operations.format.paragraph.setDirection.dryRun` | boolean | yes | |
1123+
| `operations.format.paragraph.setDirection.reasons` | enum[] | no | |
1124+
| `operations.format.paragraph.setDirection.tracked` | boolean | yes | |
11151125
| `operations.format.paragraph.setFlowOptions` | object | yes | |
11161126
| `operations.format.paragraph.setFlowOptions.available` | boolean | yes | |
11171127
| `operations.format.paragraph.setFlowOptions.dryRun` | boolean | yes | |
@@ -3243,6 +3253,11 @@ _No fields._
32433253
"dryRun": true,
32443254
"tracked": false
32453255
},
3256+
"format.paragraph.clearDirection": {
3257+
"available": true,
3258+
"dryRun": true,
3259+
"tracked": false
3260+
},
32463261
"format.paragraph.clearIndentation": {
32473262
"available": true,
32483263
"dryRun": true,
@@ -3278,6 +3293,11 @@ _No fields._
32783293
"dryRun": true,
32793294
"tracked": false
32803295
},
3296+
"format.paragraph.setDirection": {
3297+
"available": true,
3298+
"dryRun": true,
3299+
"tracked": false
3300+
},
32813301
"format.paragraph.setFlowOptions": {
32823302
"available": true,
32833303
"dryRun": true,
@@ -11621,6 +11641,41 @@ _No fields._
1162111641
],
1162211642
"type": "object"
1162311643
},
11644+
"format.paragraph.clearDirection": {
11645+
"additionalProperties": false,
11646+
"properties": {
11647+
"available": {
11648+
"type": "boolean"
11649+
},
11650+
"dryRun": {
11651+
"type": "boolean"
11652+
},
11653+
"reasons": {
11654+
"items": {
11655+
"enum": [
11656+
"COMMAND_UNAVAILABLE",
11657+
"HELPER_UNAVAILABLE",
11658+
"OPERATION_UNAVAILABLE",
11659+
"TRACKED_MODE_UNAVAILABLE",
11660+
"DRY_RUN_UNAVAILABLE",
11661+
"NAMESPACE_UNAVAILABLE",
11662+
"STYLES_PART_MISSING",
11663+
"COLLABORATION_ACTIVE"
11664+
]
11665+
},
11666+
"type": "array"
11667+
},
11668+
"tracked": {
11669+
"type": "boolean"
11670+
}
11671+
},
11672+
"required": [
11673+
"available",
11674+
"tracked",
11675+
"dryRun"
11676+
],
11677+
"type": "object"
11678+
},
1162411679
"format.paragraph.clearIndentation": {
1162511680
"additionalProperties": false,
1162611681
"properties": {
@@ -11866,6 +11921,41 @@ _No fields._
1186611921
],
1186711922
"type": "object"
1186811923
},
11924+
"format.paragraph.setDirection": {
11925+
"additionalProperties": false,
11926+
"properties": {
11927+
"available": {
11928+
"type": "boolean"
11929+
},
11930+
"dryRun": {
11931+
"type": "boolean"
11932+
},
11933+
"reasons": {
11934+
"items": {
11935+
"enum": [
11936+
"COMMAND_UNAVAILABLE",
11937+
"HELPER_UNAVAILABLE",
11938+
"OPERATION_UNAVAILABLE",
11939+
"TRACKED_MODE_UNAVAILABLE",
11940+
"DRY_RUN_UNAVAILABLE",
11941+
"NAMESPACE_UNAVAILABLE",
11942+
"STYLES_PART_MISSING",
11943+
"COLLABORATION_ACTIVE"
11944+
]
11945+
},
11946+
"type": "array"
11947+
},
11948+
"tracked": {
11949+
"type": "boolean"
11950+
}
11951+
},
11952+
"required": [
11953+
"available",
11954+
"tracked",
11955+
"dryRun"
11956+
],
11957+
"type": "object"
11958+
},
1186911959
"format.paragraph.setFlowOptions": {
1187011960
"additionalProperties": false,
1187111961
"properties": {
@@ -19214,6 +19304,8 @@ _No fields._
1921419304
"format.paragraph.clearBorder",
1921519305
"format.paragraph.setShading",
1921619306
"format.paragraph.clearShading",
19307+
"format.paragraph.setDirection",
19308+
"format.paragraph.clearDirection",
1921719309
"lists.list",
1921819310
"lists.get",
1921919311
"lists.insert",

0 commit comments

Comments
 (0)