Skip to content

Commit

Permalink
chore: Revert "Revert "Updated order of parameters in changeFieldCont…
Browse files Browse the repository at this point in the history
…ro… (#200)

This reverts commit 3740a3a.
  • Loading branch information
Khaledgarbaya authored Jul 2, 2019
1 parent 3740a3a commit 0f6c5e6
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@
- [`editField(id[, opts])` : [Field](#field)](#editfieldid-opts--fieldfield)
- [`deleteField(id)` : void](#deletefieldid--void)
- [`changeFieldId (currentId, newId)` : void](#changefieldid-currentid-newid--void)
- [`changeFieldControl (fieldId, widgetNamespace, widgetId[, settings])` : void](#changefieldcontrol-fieldid-widgetid-widgetnamespace-settings--void)
- [`changeFieldControl (fieldId, widgetId, widgetNamespace[, settings])` : void](#changefieldcontrol-fieldid-widgetid-widgetnamespace-settings--void)
- [`resetFieldControl (fieldId)` : void](#resetfieldcontrol-fieldid--void)
- [`copyFieldControl (sourceFieldId, destinationFieldId)` : void](#copyfieldcontrol-sourcefieldid-destinationfieldid--void)
- [`addSidebarWidget (widgetNamespace, widgetId[, settings, insertBeforeWidgetId])` : void](#addsidebarwidget-widgetnamespace-widgetid-settings-insertbeforewidgetid--void)
Expand Down Expand Up @@ -523,18 +523,18 @@ module.exports = function (migration) {
};
```

#### `changeFieldControl (fieldId, widgetNamespace, widgetId[, settings])` : void
#### `changeFieldControl (fieldId, widgetId, widgetNamespace[, settings])` : void

Changes control interface of given field's ID.

**`fieldId : string`** – The ID of the field.

**`widgetId : string`** – The new widget ID for the field. See the [editor interface documentation](https://www.contentful.com/developers/docs/concepts/editor-interfaces/) for a list of available widgets.

**`widgetNamespace : string`** – The namespace of the widget, one of the following values:
- `builtin` (Standard widget)
- `extension` (Custom UI extension)

**`widgetId : string`** – The new widget ID for the field. See the [editor interface documentation](https://www.contentful.com/developers/docs/concepts/editor-interfaces/) for a list of available widgets.

**`settings : Object`** – Widget settings and extension instance parameters. Key-value pairs of type (string, number | boolean | string). For builtin widgets, the the following options are available:

- **`helpText : string`** – This help text will show up below the field.
Expand Down

0 comments on commit 0f6c5e6

Please sign in to comment.