Browse Source

Up docs (#6436)

Typo api docs
up-docs-banner
Artur Arseniev 11 months ago
committed by GitHub
parent
commit
5c238713bf
No known key found for this signature in database GPG Key ID: B5690EEEBB952194
  1. 2
      packages/core/src/block_manager/model/Block.ts
  2. 2
      packages/core/src/dom_components/model/Component.ts
  3. 2
      packages/core/src/style_manager/model/Sector.ts

2
packages/core/src/block_manager/model/Block.ts

@ -62,7 +62,7 @@ export interface BlockProperties extends DraggableContent {
/** /**
* @property {String} label Block label, eg. `My block` * @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|Object} content The content of the block. Might be an HTML string or a [Component Definition](/modules/Components.html#component-definition)
* @property {String} [media=''] HTML string for the media/icon of the block, eg. `<svg ...`, `<img ...`, etc. * @property {String} [media=''] HTML string for the media/icon of the block, eg. `<svg ...`, `<img ...`, etc.
* @property {String} [category=''] Block category, eg. `Basic blocks` * @property {String} [category=''] Block category, eg. `Basic blocks`
* @property {Boolean} [activate=false] If true, triggers the `active` event on the dropped component. * @property {Boolean} [activate=false] If true, triggers the `active` event on the dropped component.

2
packages/core/src/dom_components/model/Component.ts

@ -95,7 +95,7 @@ export const keyUpdateInside = ComponentsEvents.updateInside;
* @property {String} [name=''] Name of the component. Will be used, for example, in Layers and badges * @property {String} [name=''] Name of the component. Will be used, for example, in Layers and badges
* @property {Boolean} [removable=true] When `true` the component is removable from the canvas, default: `true` * @property {Boolean} [removable=true] When `true` the component is removable from the canvas, default: `true`
* @property {Boolean|String|Function} [draggable=true] Indicates if it's possible to drag the component inside others. * @property {Boolean|String|Function} [draggable=true] Indicates if it's possible to drag the component inside others.
* You can also specify a query string to indentify elements, * You can also specify a query string to identify elements,
* eg. `'.some-class[title=Hello], [data-gjs-type=column]'` means you can drag the component only inside elements * eg. `'.some-class[title=Hello], [data-gjs-type=column]'` means you can drag the component only inside elements
* containing `some-class` class and `Hello` title, and `column` components. In the case of a function, target and destination components are passed as arguments, return a Boolean to indicate if the drag is possible. Default: `true` * containing `some-class` class and `Hello` title, and `column` components. In the case of a function, target and destination components are passed as arguments, return a Boolean to indicate if the drag is possible. Default: `true`
* @property {Boolean|String|Function} [droppable=true] Indicates if it's possible to drop other components inside. You can use * @property {Boolean|String|Function} [droppable=true] Indicates if it's possible to drop other components inside. You can use

2
packages/core/src/style_manager/model/Sector.ts

@ -24,7 +24,7 @@ export interface SectorProperties {
* @property {String} id Sector id, eg. `typography` * @property {String} id Sector id, eg. `typography`
* @property {String} name Sector name, eg. `Typography` * @property {String} name Sector name, eg. `Typography`
* @property {Boolean} [open=true] Indicates the open state. * @property {Boolean} [open=true] Indicates the open state.
* @property {Array<Object>} [properties=[]] Indicate an array of Property defintions. * @property {Array<Object>} [properties=[]] Indicate an array of Property definitions.
*/ */
export default class Sector extends Model<SectorProperties> { export default class Sector extends Model<SectorProperties> {
em: EditorModel; em: EditorModel;

Loading…
Cancel
Save