You're viewing help content for version:

The example of extending components uses the comment system, which is actually composed of two components

  • comments - the encompassing comment system which is the component placed on a page
  • comment - the component which captures an instance of a posted comment
Both components needs to be put in place, especially if customizing the appearance of a posted comment.

Note:

Only one comment system per site page is allowed.

Many Communities features already include a comment system whose resourceType can be modified to reference the extended comment system.

Create the Comments Component

These directions specify a Group value other than .hidden so the component may be made available from the component browser (sidekick).

The deletion of the auto-created JSP file is because the default HBS file will be used instead.

  1. Browse to CRXDE|Lite (http://localhost:4502/crx/de/index.jsp)
  2. create a location for custom applications :
    • select the /apps node
      • Create Folder named custom
    • select the /apps/custom node 
      • Create Folder named components
  3. select the /apps/custom/components node
    • Create > Component...
      • Label : comments
      • Title : Alt Comments
      • Description : Alternative comments style
      • Super Type : social/commons/components/hbs/comments
      • Group : Custom
    • Select Next
    • Select Next
    • Select Next
    • Select OK
  4. Expand the node just created : /apps/custom/components/comments
  5. Select Save All
  6. Right-click comments.jsp
  7. Select Delete
  8. Select Save All
chlImage_1

Create the Child Comment Component

These directions set Group to .hidden as only the parent component should be included within a page.

The deletion of the auto-created JSP file is because the default HBS file will be used instead.

  1. Navigate to the /apps/custom/components/comments node
  2. Right-click the node 
    • Select Create > Component...
      • Label : comment
      • Title : Alt Comment
      • Description : Alternative comment style
      • Super Type : social/commons/components/hbs/comments/comment
      • Group : .hidden
    • Select Next
    • Select Next
    • Select Next
    • Select OK
  3. Expand the node just created : /apps/custom/components/comments/comment
  4. Select Save All
  5. Right-click comment.jsp
  6. Select Delete
  7. Select Save All
chlImage_1
chlImage_1

Copy and Modify the Default HBS Scripts

Using CRXDE Lite :

  • copy comments.hbs
  • edit comments.hbs to :
    • change the value of the data-scf-component attribute (~line 20) :
      • from social/commons/components/hbs/comments
      • to /apps/custom/components/comments
    • modify to include the custom comment component (~line 75) :
      • replace {{include this resourceType='social/commons/components/hbs/comments/comment'}}
      • with {{include this resourceType='/apps/custom/components/comments/comment'}}
  • select /apps/custom node
  • select Save All

Create a Client Library Folder

To avoid having to explicitly include this client library, the categories value for the default comment system's clientlib could be used (cq.social.author.hbs.comments), but then this clientlib would be included for all instances of the default component as well.

Using CRXDE Lite :

  • select /apps/custom/components/comments node
  • select Create Node
    • Name: clientlibs
    • Type : cq:ClientLibraryFolder
    • add to Properties tab :
      • Name categories  Type String  Value cq.social.author.hbs.comments  Multi
      • Name dependencies  Type String Value cq.social.scf  Multi
  • select Save All
  • with /apps/custom/components/comments/clientlibs node selected, create 3 files :
    • Name: css.txt
    • Name: js.txt
    • Name: customcommentsystem.js
  • enter 'customcommentsystem.js' as the content of js.txt
  • select Save All
chlImage_1

Register the SCF Model & View

When extending (overriding) an SCF component, the resourceType is different (overlaying makes use of the relative search mechanism that searches through /apps before /libs so that the resourceType remains the same). This is why it is necessary to write JavaScript (in the client library) to register the SCF JS model and view for the custom resourceType. 

Enter the following text as the content of customcommentsystem.js :

customcommentsystem.js

(function($CQ, _, Backbone, SCF) {
    "use strict";
 
    var CustomComment = SCF.Components["social/commons/components/hbs/comments/comment"].Model;
    var CustomCommentView = SCF.Components["social/commons/components/hbs/comments/comment"].View;

    var CustomCommentSystem = SCF.Components["social/commons/components/hbs/comments"].Model;
    var CustomCommentSystemView = SCF.Components["social/commons/components/hbs/comments"].View;
 
    SCF.registerComponent('/apps/custom/components/comments/comment', CustomComment, CustomCommentView);
    SCF.registerComponent('/apps/custom/components/comments', CustomCommentSystem, CustomCommentSystemView);

})($CQ, _, Backbone, SCF);
  • select Save All

Publish the App

In order to experience the extended component in the publish environment, it is necessary to replicate the custom component.

One way to do so is 

  • from global navigation
    • select Tools > Deployment > Replication
    • select Activate Tree
    • set Start Path: to /apps/custom
    • uncheck Only Modified
    • select Activate button

This work is licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License  Twitter™ and Facebook posts are not covered under the terms of Creative Commons.

Legal Notices   |   Online Privacy Policy