adobe / adobe/aem-core-wcm-components

Modal Experience Fragment Component

Open
#509 8 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Java
Stars
796
Forks
776
Avg merge
3d 22h
Merged PRs (30d)
8

Description

[Request To Comment] To anybody who intends to use the Core Components, please provide your feedback about the following requirements. We want to make sure that we build a component that fits your needs, so don't hesitate to tell us how that component should work, so that you will be able to use it.

User Story:

As a content author, I want to be able to curate modal content as an experience and easily create a link to open that experience in a modal window

Acceptance Criteria:

  • Modal content can be authored inside an experience fragment using arbitrary components,
    When the authored modal link is clicked, the XF is requested via ajax and it's content is displayed in a modal
  • The modal can be closed by clicking outside the modal window or by clicking an "x" icon to close
  • Modal will be implemented as a new template for experience fragments, which authors will use to create the Modal content
  • A Sling rewriter extension will check for any links to XF pages created using this template, adding a class "cq-xf-modal" to the anchor tag to indicate it will be opened as a modal
  • client library javascript code will check for links with the "cq-xf-modal" class applied and bind a click event which will request the xf page content via ajax and show it in the modal.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files or tests are named. Start by tracing the existing experience-fragment template, Sling rewriter extension, and client-library JavaScript entry points described in the request. Done means modal content can be authored, opened through marked links, fetched via Ajax, and closed as specified.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
content, frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.