cq:EditConfig & dialog.xml

Avatar

Avatar

joshuau83969408

Avatar

joshuau83969408

joshuau83969408

17-07-2017

When creating a new component in AEM 6.2 I noticed it doesn't appear as an available component in the side rail or in design mode until I add the cq:EditConfig node to the component.  I also noticed if I add a dialog.xml node it will allow it to appear in the side rail and via design mode but my understanding is this is part of classic ui and isn't needed for touchui.  Any help with clarifying this would be appreciated.


Thanks!

Accepted Solutions (1)

Accepted Solutions (1)

Avatar

Avatar

Prince_Shivhare

Avatar

Prince_Shivhare

Prince_Shivhare

17-07-2017

Hi,

It is not mandatory to create a dialog node. However, some node is required indicating it is an editable component.

If you want to see your component in side rail then you can create either of the nodes:

  1. cq:editConfig [cq:EditConfig]
  2. dialog

~ Prince

Answers (4)

Answers (4)

Avatar

Avatar

zeeshank1500736

Avatar

zeeshank1500736

zeeshank1500736

17-07-2017

Hi

If you want to see the component in touch UI components list. The component Should have cq:editConfig node

cq:EditConfig is you can use it to get components to show up in the sidekick which do not have a dialog. This is something that I see every so often, usually with the developer instead creating an empty dialog. To get around this, simply create a cq:EditConfig where the cq:actions has every action except edit.

In touch ui no need to add dialog.xml .you can use simply touch ui dialog cd:dialog.

dialog.xml : Classic Ui dialog to appear in sidekick.No need to create in TouchUI.

If you want to see your component in design view then you can create either of the nodes:

  1. cq:editConfig [cq:EditConfig]
  2. dialog
  3. design_dialog

So in your case if you don't want a dialog node you can work with editConfig.

Please see this:

http://wcmaem.blogspot.in/2014/11/component-not-showing-in-touch-ui-in.html

The Great and Powerful cq:EditConfig | 6D Labs

Hope these might Helpful.

Avatar

Avatar

joshuau83969408

Avatar

joshuau83969408

joshuau83969408

17-07-2017

Thanks for all the feedback everyone!  Just to summarize and clarify to get a Touch UI component to appear in the side rail and design mode you must have the following:

  • cq:dialog node (if the component is to be editable) [OPTIONAL]
  • cq:editConfig [REQUIRED if you want it to appear in side rail/design mode]

Note: dialog.xml also works instead of cq:editConfig but since this is specific to Classic UI the approaches above should be utilized.

Avatar

Avatar

joshuau83969408

Avatar

joshuau83969408

joshuau83969408

17-07-2017

Isn't the dialog.xml for the Classic UI and the cq:dialog is for touch ui?  Why would we need a dialog.xml in this case?  It will appear in the side rail with a cq:EditConfig node and no dialog.xml.

Avatar

Avatar

smacdonald2008

Total Posts

12.7K

Likes

1.4K

Correct Reply

2.3K

Avatar

smacdonald2008

Total Posts

12.7K

Likes

1.4K

Correct Reply

2.3K
smacdonald2008

17-07-2017

In Touch UI, i have always built a dialog for a given component and have always seen the component in the siderail. I believe without a dialog, it will not appear in the Side rail.