Chuyển đến nội dung chính

How to create a custom widget client-library

CQ5 provides an interface to add new JavaScript functionality to the WCM authoring interface through the Ext.JS framework. These so-called client-libraries provide the following:
  • add custom functionality or
  • override and extend existing features

Create custom client-library

The next steps outline what is required to build a custom client-library.
  • Goto CRXDE Lite (e.g. http://<host>:<port>/crxde)
  • Create a node with type cq:ClientLibraryFolder, e.g.
    • /apps/myapp/ui/mylib
  • set the String property sling:resourceType to widgets/clientlib
  • set (multi-value) property categories to one or more of the following
Category NameDescription
cq.wcm.adminSiteAdmin and Tools
cq.wcm.editContentFinder and edit page
cq.dam.adminDAM Admin
cq.dam.editDAM AssetShare, AssetEditor
  • if required, set (multi-value) String property dependencies to other client-libraries in the system
  • save all changes

Overlaying / Adding widgets

  • Create a source folder below the client-lib node, e.g.
    • /apps/myapp/ui/mylib/source
  • Create a file for each JS class and widget override, e.g.
    • /apps/myapp/ui/mylib/source/MyWidget.js
    • /apps/myapp/ui/mylib/source/override/ComponentList.js
  • Create a file js.txt to include above created files in the custom client-lib:
#base=source
MyWidget.js
override/ComponentList.js
  • save all changes
CQ5 automatically observes changes to a client-library in the repository and will re-register this library for subsequent usage in the corresponding category, e.g. when editing a page. Attached is an example CQ content package that does the following:
  • add custom client-library /apps/myapp/ui/mylib
  • category cq.wcm.edit
  • overwrite default values of the component-list in the SideKick
    • default max number of component groups to be shown
    • default min number of components required for a group

Nhận xét

Đăng nhận xét

Bài đăng phổ biến từ blog này

[PERFORMANCE] Adobe WEM/CQ performance tuning

Adobe WEM/CQ performance tuning Contents Caching-related configurations CRX Bundle cache CRX Search index handler (Lucene) cache Tar PM index cache Scalability Maintenance Optimizing Tar Files (for Tar Persistence Manager) Data Store Garbage Collection Main documentation you should consult first: http://dev.day.com/docs/en/cq/current/deploying/performance.html http://dev.day.com/content/kb/home/cq5/CQ5Troubleshooting/performancetuningtips.html Caching-related configurations CRX Bundle cache CRX caches bundles, consisting of a node with all its properties. This is used by all bundle-based Persistence Managers. The default size of BundleCache is 8 MB. If this is too small it can cause an excessive number of read-accesses to the underlying persistence layer. Set the bundleCacheSize to something larger than the default. See more here: http://dev.day.com/docs/en/cq/current/deploying/performance.html#CRX%20Bundle%20Cache CRX Search index handler (Lucene...
Đăng nhận xét
Đọc thêm

How to custom CQ Login Module

In order to manage the login process in our project, we will use a custom CQ Login Module. We will admit the root URL of CQ instance is: http://localhost:4502/ . This value may change depending of your environment. The %CQ_HOME% variable we will mention refers to the CQ install path. It admits you have defined %CQ_HOME% as an environment variable. 1.         Update the repository definitions The login module must be referenced in the repository definitions. You have to edit the next file: %CQ_HOME%/crx-quickstart/repository/repository.xml Do a copy of repository.xml to repository.xml.original In repostiory.xml, replace  security  part of repository.xml with following: <Security appName="com.day.crx">         <SecurityManager class="com.day.crx.core.CRXSecurityManager"> <WorkspaceAccessManager class="org.apache.jackrabbit.core.security.simple.SimpleWorkspaceAccessManager"/>  ...
Đăng nhận xét
Đọc thêm

[DAM] Custom DAM management / Add 'Alt' into images

Issue: We need, for each asset to be able to edit the ‘alt’ text. The ‘alt’ text must be used on the site each time an asset is displayed. When displaying an asset, the mechanism is the following : -       Get the Locale from the request -       When getting the asset, get the associated Alt property corresponding to the locale. -       Populate the alt attribute with this value. Resolution: To achieve this, we can customize the DAM Asset Editor. The AssetEditor is the form used to input asset properties and metadata. Below is a screenshot of a customized form with four “alt” input (for four different locales). The DAM uses the following nodes to render Asset Editor forms: -       /libs/dam/content/asseteditors/formitems -       /libs/dam/content/asseteditors/images/formitems -      ...
Đăng nhận xét
Đọc thêm