aem-core-wcm-components icon indicating copy to clipboard operation
aem-core-wcm-components copied to clipboard

[Search] Create search result component

Open kweku5 opened this issue 5 years ago • 6 comments

Feature Request

As an AEM Author, I want a search results page that displays page results from a search term entered in the search field, so I can provide search a results page as a core component.

Details:

Search Results page contains:

  • Search
  • Field
  • Results of search term
    • Page Title
    • Page Description (Metadata Property)
    • Date Published
    • Tags
  • Facets
    • Configurable tags (Author has the ability to add existing tags and they are displayed as facets on the page)
    • Facets will display tag terms and be represented by link and number of results associated with term
    • If user selects the link it becomes bold and results are filtered with content associated with selected term
    • Facets will only display if resulting matches exist
    • Facets should be optional (display / do not display)
  • Pagination
    • Results total represented by a displayed total number
    • forward link to move to the next page (does not display on the last page
    • back link to move to the previous page (does not display on the first page)
  • Configurable default result number (Author has the ability to enter a number in the component to display the default total results)
  • Sort by:
    • Relevance
    • A-Z
    • Z-A
    • Newest to Oldest
    • Oldest to Newest
  1. The component should call an endpoint and pass it a keyword then generate a JSON result that includes:
  • Result items
  • Title
  • Tags
  • Description
  • Publish Date
  • Author
  • Total Results (to generate the total pages with 10/20 per page)
  1. facets
  • Category Tags
  • Total (items matching tags)

Acceptance Criteria:

  1. Author is able to add search component to a page
  2. Author is able to configure:
  • Facets
    • Include categories yes/no (default no)
    • If yes: - option opens to navigate to Tag group - select a tag root
    • Selected tag root will be displayed as Category label
    • All content with category tag will be displayed
  1. Default total for page results 10/20/40 (or enter a #)
  2. User is able to see results displayed matching criteria
  3. User is able to select Category filter and results re-load with matching filter
  4. User is able to turn off facets/categories image

kweku5 avatar Mar 26 '19 03:03 kweku5

Regarding search facets, I would want a bit more flexibility:

  1. The "root" of a facet could be any level in the taxonomy, not just the top-level namespace
  2. The category name displayed on the page can default to the tag label but should also be customizable
  3. Need the ability to have multiple facet categories on the page
  4. Showing the number of matches for a tag should be optional

JasonUSC avatar Apr 03 '19 11:04 JasonUSC

Initial proposal at https://github.com/adobe/aem-core-wcm-components/pull/653, still being worked on.

vladbailescu avatar Jun 25 '19 09:06 vladbailescu

Few updates to above RTC:-

  1. Instead of pagination 1 2 3.. we will be having load more button.
  2. Sort options will be titile, last modified date and relevence

aahlawat avatar Jul 02 '19 06:07 aahlawat

As per earlier discussion, the following requirement was mentioned: Search path - Auto-detecting the current page language and use it to derive the search path for executing the search query.

Is it required for this first release of the search component?

abhishekagg19 avatar Jul 04 '19 05:07 abhishekagg19

Hopefully this component gets traction soon, it's one of those basic building blocks for websites that would be great to leverage out of the box.

JasonUSC avatar Feb 03 '20 19:02 JasonUSC

Is this one going to happen?

tamelang avatar May 09 '22 12:05 tamelang