Skip to content

Commit 8473abf

Browse files
authored
Merge pull request #376 from contentstack/docs-update
docs: add docs for start edit button configuration
2 parents d925933 + a575819 commit 8473abf

1 file changed

Lines changed: 21 additions & 0 deletions

File tree

docs/live-preview-configs.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,27 @@ ContentstackLivePreview.init({
124124
});
125125
```
126126

127+
### `editButtonBuilder`
128+
the editButtonBuilder object allows you to manage the "Start Editing" button outside Visual Builder. It offers the following features:
129+
- Enable/disable the "Start Editing" button
130+
- Adjust the position of the "Start Editing" button using four predefined positions
131+
132+
The editButtonBuilder object contains two keys:
133+
134+
1. #### `enable`
135+
| type | default | optional |
136+
| ------- | ------- | -------- |
137+
| boolean | true | yes |
138+
139+
This key lets you specify whether you want to display the “Start Editing” button or not. It is of type “Boolean” with value true/false.
140+
2. #### `position`
141+
| type | default | optional |
142+
| ------- | ------- | -------- |
143+
| string | bottom-right | yes |
144+
145+
The user can place the "Start Editing" button in four predefined positions
146+
top-left, top-right, bottom-left, and bottom-right.
147+
127148
### `cleanCslpOnProduction`
128149

129150
| type | default | optional |

0 commit comments

Comments
 (0)