adobe-consulting-services.github.io icon indicating copy to clipboard operation
adobe-consulting-services.github.io copied to clipboard

Add generic page around wrapper client libraries

Open kwin opened this issue 5 years ago • 5 comments

The only mention of wrapper client libraries (required due to https://github.com/Adobe-Consulting-Services/acs-aem-commons/issues/1614) are at https://adobe-consulting-services.github.io/acs-aem-commons/pages/releases/4-0-0.html (where most links do no longer work). There should be a generic page (for all version >= 4.0) which lists

  1. the default AEM client library categories to extend per use case
    1. outer Touch UI editor
    2. page (inside iframe) if not in wcmmode!=disabled
    3. component dialogs (specific, all)
    4. page properties (via page editor, via sites, via page creation wizard)
  2. limitations with regards to embeds (i.e. nested embeds not working)

kwin avatar Apr 14 '20 11:04 kwin

  1. IMHO the correct categories to use are
    1. cq.authoring.editor.sites.page.hook (https://docs.adobe.com/content/help/en/experience-manager-65/developing/extending-aem/customizing-page-authoring-touch.html)
    2. cq.authoring.page
    3. use extraClientlibs for component specific JS/CSS (https://docs.adobe.com/content/help/en/experience-manager-65/developing/components/developing-components.html#creating-a-client-library-for-style-and-behavior), or category cq.authoring.dialog if JS/CSS should be loaded for all dialogs (not recommended)
    4. see above for page editor and sites, TODO: unclear which category to use for page creation wizard

kwin avatar Apr 14 '20 11:04 kwin

@davidjgonzalez WDYT about the categories, especially the one to use for the page creation wizard?

kwin avatar Apr 14 '20 11:04 kwin

@kwin are you thinking a page documenting clientlibs categories in general and which can be used to hook into various aspects of the AEM UI? Why did you stop at the 4 use-cases you listed, vs things like DAM UI, or other aspects of AEM UI?

FWIW - the categories you list look right (and dont recall the page wizard CL category off the top of my head)..

davidjgonzalez avatar Apr 14 '20 18:04 davidjgonzalez

IMHO it makes sense to document those categories centrally instead of per feature (especially as some JS might make sense in multiple use cases). As I don’t know of any other documentation page listing the categories it would make sense to maintain that at acs-aem-commons. The list is not complete but we can extend it once such a page is in place.

kwin avatar Apr 14 '20 19:04 kwin

@kwin sure - I think that would be good documentation to exist. In terms of using a feature, I'd rather just have the snippet that tells me exactly where it needs to go. I think asking users of features to try to understand where the right place to hook into is not good though; basically I think both could live in parallel, and the consolidated list would be more for feature-contributors to hook understand where to hook in. Ideally, this would be documented my Adobe Docs but I don't expect that to happen.

davidjgonzalez avatar Apr 14 '20 19:04 davidjgonzalez