Skip to content
This repository has been archived by the owner on Jun 26, 2020. It is now read-only.

Cleaned up Editor classes #114

Merged
merged 6 commits into from
Jan 11, 2018
Merged

Cleaned up Editor classes #114

merged 6 commits into from
Jan 11, 2018

Conversation

@coveralls
Copy link

Coverage Status

Coverage remained the same at 100.0% when pulling eba416f on t/110 into 7798bc3 on master.

@oskarwrobel oskarwrobel changed the title T/110 Cleaned up Editor classes Jan 10, 2018
*
* Besides it creates main {@link module:engine/model/rootelement~RootElement} using
* {@link module:engine/model/document~Document#createRoot createRoot} method what automatically creates
* corresponding {@link module:engine/view/rooteditableelement~RootEditableElement view root} element.
Copy link

@pjasiun pjasiun Jan 10, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Class representing the base of the editor. It is the API all plugins can expect to get when using editor property. Editors implementation (like Classic Editor or Inline Editor) should extend this class. They can add their own methods and properties.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we need to explain what the architecture is here (we need an article for it) and I don't think we should list properties (they will be listed anyway). Instead, I focused more what this subset of properties means.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can also add "see StandardEditor".

import isFunction from '@ckeditor/ckeditor5-utils/src/lib/lodash/isFunction';

import getDataFromElement from '@ckeditor/ckeditor5-utils/src/dom/getdatafromelement';
import setDataInElement from '@ckeditor/ckeditor5-utils/src/dom/setdatainelement';

/**
* Class representing a typical browser-based editor. It handles a single source element and
* uses {@link module:engine/controller/editingcontroller~EditingController}.
* Class provides API methods for getting and setting data.
Copy link

@pjasiun pjasiun Jan 10, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The standard editor class, extending base editor by adding methods needed in the typical editor implementations: editor with a single editable area created based on the DOM element. It provides base API to manage data and to integrate the editor with the form when it is initialized on the textarea element.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 100.0% when pulling 0ae4e11 on t/110 into 7798bc3 on master.

@pjasiun pjasiun merged commit 5a2031e into master Jan 11, 2018
@pjasiun pjasiun deleted the t/110 branch January 11, 2018 09:52
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
3 participants