Initialization Option Author API

description

Configuration options for the description.

Values

Request object key config.item_edit.item.details.description

Type object

This object has the following properties which can be configured.

  • edit boolean

    Controls whether the description field can be changed.

    You would want to use this so that you can prevent authors from editing the Item description.

    Default: true

    var initializationOptions = {
        "config": {
            "item_edit": {
                "item": {
                    "details": {
                        "description": {
                            "edit": false
                        }
                    }
                }
            }
        }
    };
  • show boolean

    Controls whether the description field is shown.

    You would want to use this to allow authors to add acknowledgements information for Items.

    Default: true

    var initializationOptions = {
        "config": {
            "item_edit": {
                "item": {
                    "details": {
                        "description": {
                            "show": false
                        }
                    }
                }
            }
        }
    };
Was this article helpful?