Skip to content

Commit f952739

Browse files
committed
docs(template-builder): revert lock mode additions
Template builder does not support lockMode in FieldDefinition or TemplateField types yet. Remove premature documentation.
1 parent 2fb1f83 commit f952739

2 files changed

Lines changed: 0 additions & 27 deletions

File tree

apps/docs/solutions/template-builder/api-reference.mdx

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -138,12 +138,9 @@ interface FieldDefinition {
138138
metadata?: Record<string, any>; // Custom metadata
139139
mode?: "inline" | "block"; // Field insertion mode (default: "inline")
140140
group?: string; // Category/group name
141-
lockMode?: StructuredContentLockMode; // Editing restrictions (default: "unlocked")
142141
}
143142
```
144143

145-
The `lockMode` property controls what users can do with the field once inserted. See the [Structured Content extension](/extensions/structured-content#lock-modes) for details on each mode.
146-
147144
### TemplateField
148145

149146
Fields that exist in the template document:
@@ -156,7 +153,6 @@ interface TemplateField {
156153
position?: number; // Position in document
157154
mode?: "inline" | "block"; // Rendering mode
158155
group?: string; // Group ID for related fields
159-
lockMode?: StructuredContentLockMode; // Current lock state
160156
}
161157
```
162158

apps/docs/solutions/template-builder/configuration.mdx

Lines changed: 0 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -43,35 +43,12 @@ Define which fields users can insert:
4343
label: "Signature",
4444
mode: "block", // Force block-level insertion
4545
},
46-
{
47-
id: "3",
48-
label: "Account ID",
49-
lockMode: "sdtContentLocked", // Fully protected — no edits, no deletion
50-
},
51-
{
52-
id: "4",
53-
label: "Editable Clause",
54-
lockMode: "sdtLocked", // Users can edit content but not delete the field
55-
},
5646
],
5747
allowCreate: true, // Let users create new fields on the fly
5848
}}
5949
/>
6050
```
6151

62-
### Lock modes
63-
64-
Control what users can do with each field using the `lockMode` property:
65-
66-
| Lock mode | Field wrapper | Field content | Use case |
67-
|-----------|---------------|---------------|----------|
68-
| `unlocked` | Deletable | Editable | Default — no restrictions |
69-
| `sdtLocked` | Protected | Editable | Protect field structure, allow value changes |
70-
| `contentLocked` | Deletable | Read-only | Display a computed value users can remove |
71-
| `sdtContentLocked` | Protected | Read-only | Fully protected (e.g., system-generated ID) |
72-
73-
Lock modes are compatible with Microsoft Word — exported documents preserve the `w:lock` element per the ECMA-376 standard. See the [Structured Content extension](/extensions/structured-content#lock-modes) for full details.
74-
7552
### Field creation
7653

7754
Allow users to create new fields while building templates:

0 commit comments

Comments
 (0)