appbaseio/reactivesearch

Feature: Add support for `nested` object mapping

Open

#595 opened on Oct 31, 2018

View on GitHub
 (13 comments) (1 reaction) (0 assignees)JavaScript (4,835 stars) (487 forks)batch import
Vue.JSenhancementgood first issue :wave:help wanted

Description

Issue Type:

Enhancement

Platform:

ReactiveSearch for Web

Description:

ReactiveSearch today doesn't support querying the fields of an object field with a nested mapping.

A nested object requires a different query (where a path for the nested field needs to be specified) along with the original query. The same applies to an aggregation.

This issue proposes to add a nestedField prop in all the data-driven components we have to support the use-case of a nested object.

Prop definition for the field looks like:

nestedField String [optional]
When your dataField is present inside an object of type nested, this can be used to set the path of the nested field. Setting this allows searching within documents belonging to the path.

Reactivesearch version: x.y.z

2.12.1

Components to support this in:

  • MultiDropdownList
  • SingleDropdownList
  • MultiList
  • SingleList
  • SingleRange
  • MultiRange
  • SingleDropdownRange
  • MultiDropdownRange
  • DataSearch
  • CategorySearch
  • TextField
  • ToggleButton
  • TagCloud
  • SingleDataList
  • MultiDataList
  • RangeSlider
  • DynamicRangeSlider
  • RangeInput
  • NumberBox
  • DatePicker
  • DateRange
  • RatingsFilter
  • GeoDistanceSlider
  • GeoDistanceDropdown

Contributor guide

Tech stack
javascriptreact
Domain
frontendsearch
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
over 1 week
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
React knowledgeElasticsearch nested mapping
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
20
Research direction
Review the implementations for the already completed components (MultiDropdownList, SingleDropdownList, MultiList, SingleList) to understand the pattern used for the nestedField prop. Then apply the same pattern to the remaining components listed in the issue, ensuring correct nested query syntax per Elasticsearch documentation. Check the issue comments for any additional guidance or maintainer feedback.