Skip to content

Commit aeec1e9

Browse files
committedJun 3, 2018
chore(api): announce setEditorConfig change
1 parent 7e18d73 commit aeec1e9

File tree

1 file changed

+3
-8
lines changed

1 file changed

+3
-8
lines changed
 

‎README.md

+3-8
Original file line numberDiff line numberDiff line change
@@ -502,17 +502,12 @@ var embed = new Flat.Embed(container, {
502502

503503
### `setEditorConfig(config: object): Promise<object, Error>`
504504

505+
**NOTE: "Modes" are now deprecated and new options will be available for this method in the upcoming weeks. [Please contact our team](mailto:developers@flat.io) if you are interested in customizing the embed editor.**
506+
505507
Set a new config for the editor (e.g. the different tools available in the embed). This one will be used at the next loading score.
506508

507509
```js
508-
// For example: hide the Articulation mode, and only display the durations tools in the Note mode
509-
embed.setEditorConfig({
510-
noteMode: {
511-
durations: true
512-
},
513-
articulationMode: false,
514-
defaultMode: 'note'
515-
}).then(function (config) {
510+
embed.setEditorConfig({}).then(function (config) {
516511
// The config of the embed
517512
console.log(config);
518513
});

0 commit comments

Comments
 (0)
Please sign in to comment.