Browse Source

Update block docs

pull/3725/head
Artur Arseniev 5 years ago
parent
commit
506ea6c717
  1. 17
      src/block_manager/model/Block.js

17
src/block_manager/model/Block.js

@ -1,28 +1,27 @@
import { Model } from 'common';
/**
* @property {String} [label=''] Block label, eg. `My block`
* @property {Boolean} [activate=false] If true, triggers an the 'active' event on dropped component
* @property {String} label Block label, eg. `My block`
* @property {String|Object} content The content of the block. Might be an HTML string or a [Component Defintion](/modules/Components.html#component-definition)
* @property {String} [media=''] HTML string for the media/icon of the block, eg. `<svg ...`, `<img ...`, etc.
* @property {String} [category=''] Block category
* @property {Boolean} [activate=false] If true, triggers an the `active` event on dropped component
* @property {Boolean} [select=false] If true, the dropped component will be selected
* @property {Boolean} [resetId=false] If true, all IDs of dropped components and their styles will be changed
* @property {Boolean} [disable=false] Disable the drag of the block
* @property {String} [media=''] HTML string for the media/icon of the block, eg. `<svg ...`, `<img ...`, etc.
* (**WARNING:** In order to support HTML strings, this property is not escaped)
* @property {String|Object} content The content of the block. Might be an HTML string or a [Component Defintion](/modules/Components.html#component-definition)
* @property {String} [category=''] Block category
* @property {Object} [attributes={}] Block attributes to apply in the view element
*/
export default class Block extends Model {
defaults() {
return {
label: '',
content: '',
media: '',
category: '',
activate: false,
select: false,
resetId: false,
disable: false,
media: '',
content: '',
category: '',
attributes: {}
};
}

Loading…
Cancel
Save