Skip to content

feat(document-api): add table convenience ops and sync reference doc #2471

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
harbournick merged 2 commits into from
Mar 19, 2026
Merged

feat(document-api): add table convenience ops and sync reference doc #2471

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
712ce93
feat(document-api): add table convenience ops and sync reference doc
harbournick Mar 19, 2026
9624559
fix(document-api): correct table convenience style, margin, and borde…
harbournick Mar 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion apps/docs/document-api/available-operations.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Use the tables below to see what operations are available and where each one is
| Styles | 1 | 0 | 1 | [Reference](/document-api/reference/styles/index) |
| Table of Authorities | 11 | 0 | 11 | [Reference](/document-api/reference/authorities/index) |
| Table of Contents | 10 | 0 | 10 | [Reference](/document-api/reference/toc/index) |
| Tables | 42 | 0 | 42 | [Reference](/document-api/reference/tables/index) |
| Tables | 45 | 0 | 45 | [Reference](/document-api/reference/tables/index) |
| Track Changes | 3 | 0 | 3 | [Reference](/document-api/reference/track-changes/index) |

| Editor method | Operation |
Expand Down Expand Up @@ -412,6 +412,9 @@ Use the tables below to see what operations are available and where each one is
| <span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}><code>editor.doc.tables.setCellPadding(...)</code></span> | [`tables.setCellPadding`](/document-api/reference/tables/set-cell-padding) |
| <span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}><code>editor.doc.tables.setCellSpacing(...)</code></span> | [`tables.setCellSpacing`](/document-api/reference/tables/set-cell-spacing) |
| <span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}><code>editor.doc.tables.clearCellSpacing(...)</code></span> | [`tables.clearCellSpacing`](/document-api/reference/tables/clear-cell-spacing) |
| <span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}><code>editor.doc.tables.applyStyle(...)</code></span> | [`tables.applyStyle`](/document-api/reference/tables/apply-style) |
| <span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}><code>editor.doc.tables.setBorders(...)</code></span> | [`tables.setBorders`](/document-api/reference/tables/set-borders) |
| <span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}><code>editor.doc.tables.setTableOptions(...)</code></span> | [`tables.setTableOptions`](/document-api/reference/tables/set-table-options) |
| <span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}><code>editor.doc.tables.get(...)</code></span> | [`tables.get`](/document-api/reference/tables/get) |
| <span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}><code>editor.doc.tables.getCells(...)</code></span> | [`tables.getCells`](/document-api/reference/tables/get-cells) |
| <span style={{ whiteSpace: 'nowrap', wordBreak: 'normal', overflowWrap: 'normal' }}><code>editor.doc.tables.getProperties(...)</code></span> | [`tables.getProperties`](/document-api/reference/tables/get-properties) |
Expand Down
8 changes: 7 additions & 1 deletion apps/docs/document-api/reference/_generated-manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -348,6 +348,7 @@
"apps/docs/document-api/reference/styles/paragraph/index.mdx",
"apps/docs/document-api/reference/styles/paragraph/set-style.mdx",
"apps/docs/document-api/reference/tables/apply-border-preset.mdx",
"apps/docs/document-api/reference/tables/apply-style.mdx",
"apps/docs/document-api/reference/tables/clear-border.mdx",
"apps/docs/document-api/reference/tables/clear-cell-spacing.mdx",
"apps/docs/document-api/reference/tables/clear-contents.mdx",
Expand All @@ -374,6 +375,7 @@
"apps/docs/document-api/reference/tables/move.mdx",
"apps/docs/document-api/reference/tables/set-alt-text.mdx",
"apps/docs/document-api/reference/tables/set-border.mdx",
"apps/docs/document-api/reference/tables/set-borders.mdx",
"apps/docs/document-api/reference/tables/set-cell-padding.mdx",
"apps/docs/document-api/reference/tables/set-cell-properties.mdx",
"apps/docs/document-api/reference/tables/set-cell-spacing.mdx",
Expand All @@ -385,6 +387,7 @@
"apps/docs/document-api/reference/tables/set-shading.mdx",
"apps/docs/document-api/reference/tables/set-style-option.mdx",
"apps/docs/document-api/reference/tables/set-style.mdx",
"apps/docs/document-api/reference/tables/set-table-options.mdx",
"apps/docs/document-api/reference/tables/set-table-padding.mdx",
"apps/docs/document-api/reference/tables/sort.mdx",
"apps/docs/document-api/reference/tables/split-cell.mdx",
Expand Down Expand Up @@ -686,6 +689,9 @@
"tables.setCellPadding",
"tables.setCellSpacing",
"tables.clearCellSpacing",
"tables.applyStyle",
"tables.setBorders",
"tables.setTableOptions",
"tables.get",
"tables.getCells",
"tables.getProperties",
Expand Down Expand Up @@ -976,5 +982,5 @@
}
],
"marker": "{/* GENERATED FILE: DO NOT EDIT. Regenerate via `pnpm run docapi:sync`. */}",
"sourceHash": "5eb339719530fd6ff1e69c9c90c36637fedce9fc426b3aba84f973c73facf3e0"
"sourceHash": "31ad98dfc8659ebef07fbe3070add1c26fbbc8e0fbfa284e52d0b17e9fdd6b0f"
}
138 changes: 138 additions & 0 deletions apps/docs/document-api/reference/capabilities/get.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1862,6 +1862,11 @@ _No fields._
| `operations.tables.applyBorderPreset.dryRun` | boolean | yes | |
| `operations.tables.applyBorderPreset.reasons` | enum[] | no | |
| `operations.tables.applyBorderPreset.tracked` | boolean | yes | |
| `operations.tables.applyStyle` | object | yes | |
| `operations.tables.applyStyle.available` | boolean | yes | |
| `operations.tables.applyStyle.dryRun` | boolean | yes | |
| `operations.tables.applyStyle.reasons` | enum[] | no | |
| `operations.tables.applyStyle.tracked` | boolean | yes | |
| `operations.tables.clearBorder` | object | yes | |
| `operations.tables.clearBorder.available` | boolean | yes | |
| `operations.tables.clearBorder.dryRun` | boolean | yes | |
Expand Down Expand Up @@ -1987,6 +1992,11 @@ _No fields._
| `operations.tables.setBorder.dryRun` | boolean | yes | |
| `operations.tables.setBorder.reasons` | enum[] | no | |
| `operations.tables.setBorder.tracked` | boolean | yes | |
| `operations.tables.setBorders` | object | yes | |
| `operations.tables.setBorders.available` | boolean | yes | |
| `operations.tables.setBorders.dryRun` | boolean | yes | |
| `operations.tables.setBorders.reasons` | enum[] | no | |
| `operations.tables.setBorders.tracked` | boolean | yes | |
| `operations.tables.setCellPadding` | object | yes | |
| `operations.tables.setCellPadding.available` | boolean | yes | |
| `operations.tables.setCellPadding.dryRun` | boolean | yes | |
Expand Down Expand Up @@ -2042,6 +2052,11 @@ _No fields._
| `operations.tables.setStyleOption.dryRun` | boolean | yes | |
| `operations.tables.setStyleOption.reasons` | enum[] | no | |
| `operations.tables.setStyleOption.tracked` | boolean | yes | |
| `operations.tables.setTableOptions` | object | yes | |
| `operations.tables.setTableOptions.available` | boolean | yes | |
| `operations.tables.setTableOptions.dryRun` | boolean | yes | |
| `operations.tables.setTableOptions.reasons` | enum[] | no | |
| `operations.tables.setTableOptions.tracked` | boolean | yes | |
| `operations.tables.setTablePadding` | object | yes | |
| `operations.tables.setTablePadding.available` | boolean | yes | |
| `operations.tables.setTablePadding.dryRun` | boolean | yes | |
Expand Down Expand Up @@ -4013,6 +4028,11 @@ _No fields._
"dryRun": true,
"tracked": false
},
"tables.applyStyle": {
"available": true,
"dryRun": true,
"tracked": false
},
"tables.clearBorder": {
"available": true,
"dryRun": true,
Expand Down Expand Up @@ -4138,6 +4158,11 @@ _No fields._
"dryRun": true,
"tracked": false
},
"tables.setBorders": {
"available": true,
"dryRun": true,
"tracked": false
},
"tables.setCellPadding": {
"available": true,
"dryRun": true,
Expand Down Expand Up @@ -4193,6 +4218,11 @@ _No fields._
"dryRun": true,
"tracked": false
},
"tables.setTableOptions": {
"available": true,
"dryRun": true,
"tracked": false
},
"tables.setTablePadding": {
"available": true,
"dryRun": true,
Expand Down Expand Up @@ -17086,6 +17116,41 @@ _No fields._
],
"type": "object"
},
"tables.applyStyle": {
"additionalProperties": false,
"properties": {
"available": {
"type": "boolean"
},
"dryRun": {
"type": "boolean"
},
"reasons": {
"items": {
"enum": [
"COMMAND_UNAVAILABLE",
"HELPER_UNAVAILABLE",
"OPERATION_UNAVAILABLE",
"TRACKED_MODE_UNAVAILABLE",
"DRY_RUN_UNAVAILABLE",
"NAMESPACE_UNAVAILABLE",
"STYLES_PART_MISSING",
"COLLABORATION_ACTIVE"
]
},
"type": "array"
},
"tracked": {
"type": "boolean"
}
},
"required": [
"available",
"tracked",
"dryRun"
],
"type": "object"
},
"tables.clearBorder": {
"additionalProperties": false,
"properties": {
Expand Down Expand Up @@ -17961,6 +18026,41 @@ _No fields._
],
"type": "object"
},
"tables.setBorders": {
"additionalProperties": false,
"properties": {
"available": {
"type": "boolean"
},
"dryRun": {
"type": "boolean"
},
"reasons": {
"items": {
"enum": [
"COMMAND_UNAVAILABLE",
"HELPER_UNAVAILABLE",
"OPERATION_UNAVAILABLE",
"TRACKED_MODE_UNAVAILABLE",
"DRY_RUN_UNAVAILABLE",
"NAMESPACE_UNAVAILABLE",
"STYLES_PART_MISSING",
"COLLABORATION_ACTIVE"
]
},
"type": "array"
},
"tracked": {
"type": "boolean"
}
},
"required": [
"available",
"tracked",
"dryRun"
],
"type": "object"
},
"tables.setCellPadding": {
"additionalProperties": false,
"properties": {
Expand Down Expand Up @@ -18346,6 +18446,41 @@ _No fields._
],
"type": "object"
},
"tables.setTableOptions": {
"additionalProperties": false,
"properties": {
"available": {
"type": "boolean"
},
"dryRun": {
"type": "boolean"
},
"reasons": {
"items": {
"enum": [
"COMMAND_UNAVAILABLE",
"HELPER_UNAVAILABLE",
"OPERATION_UNAVAILABLE",
"TRACKED_MODE_UNAVAILABLE",
"DRY_RUN_UNAVAILABLE",
"NAMESPACE_UNAVAILABLE",
"STYLES_PART_MISSING",
"COLLABORATION_ACTIVE"
]
},
"type": "array"
},
"tracked": {
"type": "boolean"
}
},
"required": [
"available",
"tracked",
"dryRun"
],
"type": "object"
},
"tables.setTablePadding": {
"additionalProperties": false,
"properties": {
Expand Down Expand Up @@ -19165,6 +19300,9 @@ _No fields._
"tables.setCellPadding",
"tables.setCellSpacing",
"tables.clearCellSpacing",
"tables.applyStyle",
"tables.setBorders",
"tables.setTableOptions",
"tables.get",
"tables.getCells",
"tables.getProperties",
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/document-api/reference/content-controls/get-binding.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Returns the ContentControlBinding or null if no binding is set.

## Output fields

### Variant 1 (storeItemId, xpath)
### Variant 1 (required: storeItemId, xpath)

| Field | Type | Required | Description |
| --- | --- | --- | --- |
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/document-api/reference/delete.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Returns a TextMutationReceipt with applied status; receipt reports NO_OP if the
| `target.kind` | `"selection"` | yes | Constant: `"selection"` |
| `target.start` | SelectionPoint | yes | SelectionPoint |

### Variant 2 (ref)
### Variant 2 (required: ref)

| Field | Type | Required | Description |
| --- | --- | --- | --- |
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/document-api/reference/format/apply.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ Returns a TextMutationReceipt confirming inline styles were applied to the targe
| `target.kind` | `"selection"` | yes | Constant: `"selection"` |
| `target.start` | SelectionPoint | yes | SelectionPoint |

### Variant 2 (ref, inline)
### Variant 2 (required: ref, inline)

| Field | Type | Required | Description |
| --- | --- | --- | --- |
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/document-api/reference/format/b-cs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Returns a TextMutationReceipt confirming the inline run property patch was appli
| `target.start` | SelectionPoint | yes | SelectionPoint |
| `value` | boolean \\| null | no | One of: boolean, null |

### Variant 2 (ref)
### Variant 2 (required: ref)

| Field | Type | Required | Description |
| --- | --- | --- | --- |
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/document-api/reference/format/bold.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Returns a TextMutationReceipt confirming the inline run property patch was appli
| `target.start` | SelectionPoint | yes | SelectionPoint |
| `value` | boolean \\| null | no | One of: boolean, null |

### Variant 2 (ref)
### Variant 2 (required: ref)

| Field | Type | Required | Description |
| --- | --- | --- | --- |
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/document-api/reference/format/border.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Returns a TextMutationReceipt confirming the inline run property patch was appli
| `target.start` | SelectionPoint | yes | SelectionPoint |
| `value` | object \\| null | yes | One of: object, null |

### Variant 2 (ref, value)
### Variant 2 (required: ref, value)

| Field | Type | Required | Description |
| --- | --- | --- | --- |
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/document-api/reference/format/caps.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Returns a TextMutationReceipt confirming the inline run property patch was appli
| `target.start` | SelectionPoint | yes | SelectionPoint |
| `value` | boolean \\| null | no | One of: boolean, null |

### Variant 2 (ref)
### Variant 2 (required: ref)

| Field | Type | Required | Description |
| --- | --- | --- | --- |
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/document-api/reference/format/char-scale.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Returns a TextMutationReceipt confirming the inline run property patch was appli
| `target.start` | SelectionPoint | yes | SelectionPoint |
| `value` | number \\| null | yes | One of: number, null |

### Variant 2 (ref, value)
### Variant 2 (required: ref, value)

| Field | Type | Required | Description |
| --- | --- | --- | --- |
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/document-api/reference/format/color.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Returns a TextMutationReceipt confirming the inline run property patch was appli
| `target.start` | SelectionPoint | yes | SelectionPoint |
| `value` | string \\| null | yes | One of: string, null |

### Variant 2 (ref, value)
### Variant 2 (required: ref, value)

| Field | Type | Required | Description |
| --- | --- | --- | --- |
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/document-api/reference/format/contextual-alternates.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Returns a TextMutationReceipt confirming the inline run property patch was appli
| `target.start` | SelectionPoint | yes | SelectionPoint |
| `value` | boolean \\| null | no | One of: boolean, null |

### Variant 2 (ref)
### Variant 2 (required: ref)

| Field | Type | Required | Description |
| --- | --- | --- | --- |
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/document-api/reference/format/cs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Returns a TextMutationReceipt confirming the inline run property patch was appli
| `target.start` | SelectionPoint | yes | SelectionPoint |
| `value` | boolean \\| null | no | One of: boolean, null |

### Variant 2 (ref)
### Variant 2 (required: ref)

| Field | Type | Required | Description |
| --- | --- | --- | --- |
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/document-api/reference/format/dstrike.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Returns a TextMutationReceipt confirming the inline run property patch was appli
| `target.start` | SelectionPoint | yes | SelectionPoint |
| `value` | boolean \\| null | no | One of: boolean, null |

### Variant 2 (ref)
### Variant 2 (required: ref)

| Field | Type | Required | Description |
| --- | --- | --- | --- |
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/document-api/reference/format/east-asian-layout.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Returns a TextMutationReceipt confirming the inline run property patch was appli
| `target.start` | SelectionPoint | yes | SelectionPoint |
| `value` | object \\| null | yes | One of: object, null |

### Variant 2 (ref, value)
### Variant 2 (required: ref, value)

| Field | Type | Required | Description |
| --- | --- | --- | --- |
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/document-api/reference/format/em.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Returns a TextMutationReceipt confirming the inline run property patch was appli
| `target.start` | SelectionPoint | yes | SelectionPoint |
| `value` | string \\| null | yes | One of: string, null |

### Variant 2 (ref, value)
### Variant 2 (required: ref, value)

| Field | Type | Required | Description |
| --- | --- | --- | --- |
Expand Down
Loading
Loading