Important
You are browsing the documentation for version 4.1 of OroCommerce, OroCRM and OroPlatform, which is no longer maintained. Read version 5.1 (the latest LTS version) of the Oro documentation to get up-to-date information.
See our Release Process documentation for more information on the currently supported and upcoming releases.
WYSIWYG Field¶
WYSIWYG field type utilizes an editor that provides advanced editing capabilities. Any such editor can be integrated with WYSIWYG fields, and the GrapesJS editor is integrated out of the box. An administrator can add a new WYSIWYG field to any entity available in Entity Management. Landing Page and Content Blocks entities use WYSIWYG for their content fields by default.
Structure¶
Each WYSIWYG field stores data in three separate pieces:
content- a field (database column) to save the HTML markup of the content;
styles- a field (database column) to save the CSS styles applied by the editor to the content;
properties- a field (database column) to save additional JSON metadata stored by the editor to properly initialize its UI.
When using Entity Management UI, the system takes care of managing the additional fields in the background. For example, if you add a WYSIWYG field called description to some entity, the system will automatically create fields called description_styles and description_properties. When adding a WYSIWYG field programatically, developers should create and name all three fields and databases columns themselves.