@liferay-editor-custom-fields/framework 7.4.8 → 74.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Lawrence Behar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,37 +1,19 @@
 # Liferay Custom Fields Framework
 
-The engine behind Liferay Editor Custom Fields.
+The engine behind Liferay Editor Custom Fields. 
+
+You only need this if you are creating a new Liferay Editor Custom Fields package, otherwise it is provided as a dependency on existing ones.
 
 ## Before You Start
 
 Any client extension using this framework should not run on a production or pre-prod staging environment. It is only intended for the fragment and web content editors. Any JS that will end up on the page should be elsewhere, either in a separate client extension or in the fragment/web content template.
 
-You only need this if you are creating a new Liferay Editor Custom Fields package, otherwise it is provided as a dependency on existing ones.
+If you are creating/appending DOM elements, make sure that you check for an existing element to avoid infinite MutationObserver loops.
 
 ## Getting Started
 
-- Install @liferay-editor-custom-fields/framework
-  - Make sure the version matches the minor version of Liferay you are using
-  - For example `yarn add @liferay-editor-custom-fields/framework@~7.4.0` for Liferay 7.4.
-- In the index.ts of your app:
-  - Declare the Liferay global object
-  - Import the default exported function from @liferay-editor-custom-fields/framework. You can call it something short like initFramework();
-- Create a default exported function of your own and call that function
-- Write a Liferay.on event subscriber for each event that your app will be using. See the Events section of this document for a list of events.
-
-```
-declare const Liferay;
-
-import initFramework from '@liferay-editor-custom-fields/framework';
-
-const initImageTools: () => void = () => {
-    initFramework();
-    Liferay.on('EditorCustomFields_WebContentFields_OnLoad', ()=>{});
-    Liferay.on('EditorCustomFields_FragmenConfig_OnLoad', ()=>{});
-    Liferay.on('EditorCustomFields_Image_OnChange', ()=>{});
-}
-export default initImageTools;
-```
+- Download the boilerplate starter at https://github.com/lbeharxtivia/liferay-editor-custom-fields-sample
+- See below for available events and helper functions
 
 ## Events
 

package/package.json

@@ -25,5 +25,5 @@
     "start": "webpack serve",
     "watch": "tsc --watch"
   },
-  "version": "7.4.8"
+  "version": "74.0.0"
 }