Thanks to GatsbyJs and Reactjs.org

Replace @appbaseio/reactivebase-native with @appbaseio/reactivesearch-native in all the code snippets.

• Add annotated image

Also figure out a way for 404 page

Add Map Components to the component overview.

A new component has been added, we need to document it -
appbaseio/reactivebase#106

• Add codepen to Syntax and Examples section
• Add playground links.

Components:

• PlacesSearch
• GeoDistanceDropdown
• GeoDistanceSlider
• ReactiveMap

• We need to create a version switcher for React Native. Using a different repo

• Getting Started Section

  • Install and Quickstart
  • Import Data
  • ReactiveBase
  • Components Overview

• Component References
  One doc per component

• Advanced

  • Add a snack snippet for the ReactiveComponent doc.
  • Performance Tips @metagrover
  • Creating Themes, Styles Unsupported in current version

File to update: https://github.com/appbaseio/reactivebase-manual/tree/master/docs/v1.0.0/components/NumberBox.md

• Annotated image

It should appear over here - https://opensource.appbase.io/reactive-manual/v1.0.0/components/NumberBox.html

Change docs navbar layout to match visually with the kind of components.

Proposed new layout:

• Getting Started
  • Change components overview doc
• ReactiveSearch Components
  • Base
    • Base components
  • List
    • List components
  • Range
    • Range components
  • Search
    • Search components
  • Result
    • Result components
• Theming
  • Themes @metagrover
  • How Styles Work @metagrover
  • InnerClass @metagrover
• Advanced
  • React prop (Review, @siddharthlatest)
  • customQuery (Review, @siddharthlatest)
  • Indexing and Mapping guide #28 (@siddharthlatest)
  • How to use events: onData, onAllData @siddharthlatest
  • ReactiveComponent @metagrover
  • How to change props programmatically | Integrating your own React UI components
  • How to use a middleware to secure all requests @siddharthlatest
  • How to build a native app with ReactiveSearch
  • Comparison: Searchkit, Instantsearch @siddharthlatest
• ReactiveMaps Components

  Same arrangement as before

Props Changes

• customQuery: callback would receive the updated props in addition to the updated value. The function definition would be (value, props). Also allow for extending the use case by using useful props like fuzziness, fieldWeights directly in the callback to generate custom query.

• componentId: we're using certain internal components which end with __internal. We should mention this. If the user sets this on a reactive component, the filter values and URL params won't be set for that component Not mentioning in docs

• pagination: the issue with infinite loading in ReactiveList (native) is that there should be enough components to make the list scrollable. Need to think more on this subject

• queryFormat: document the different date formats supported via this prop in date components

• fieldWeights: the prop name changes for both weights and searchWeight

• showFilter and filterLabel: will update only when the underlying query changes

• queryFormat: will only update the query when there's a change in the selected items (eg -
  MultiList)

• title: Remove title prop in actuators

• range: prop is not optional

• placeholder: remove placeholder prop in actuators

• debounce: new prop for text input based components like TextField, DataSearch, CategorySearch

• beforeValueChange: the components goes in a locked state when beforeValueChange is present so any changes to the component's state are ignored. beforeValueChange should be used with care since a long resolving function can block the user interaction with the component.

New Components

• RangeInput: is a new component which extends the functionality of RangeSlider. Add docs for it.

• ReactiveComponent: add docs

Components updates

• NumberBox: accepts no props for filters. showFilter and filterLabel will not work therefore

• RangeSlider: accepts no props for filters. showFilter and filterLabel will not work therefore

• RangeSlider: provides a snap prop which uses the stepValue to snap the slider in position. Defaults to true. When set to false, the slider doesn't use the stepValue

• SelectedFilters: update the docs

• DatePicker: update the docs

• DateRange: update the docs

• SelectedFilters: props

• ToggleButton: now expects a string or array in defaultSelected depending on multiSelect value

• ReactiveList: onAllData prop update

Concepts

Theming

• Theming concepts have changed, we now use a ThemeProvider from emotion which makes it easy to overwrite/add styles easily using ReactiveBase. Add docs related to these.

• For extending component styles each component accepts an object which applies the provided className. Document the innerClass object for all components

• Notes on specificity so the custom styles have higher preference. For ref - https://material-ui-next.com/customization/overrides/

• Can we use withTheme from emotion for react components which are children of ReactiveBase?

Proxying

• server request via a middleware

Final Review

• Review all props with v2 code

The codepens are using v1. There are a lot of changes involved from v1 to v2 (including some breaking changes)

Integrate code sandbox for all components

• Talk what the library is about briefly,
• Get a more concise CTA

• Working snack snippets for each component story.
• Ability to run the app via Expo or an inline emulator.
• App demos using snack.

Notice the package name here: const { ReactiveBase, NumberBox } = UmdReactiveBase;

• We don't mention about the defaultQuery prop in any of the Result components.

We should add a description for this prop.

• CategorySearch should look and feel similar to DataSearch
• Add the new props in all the components
• Update the Extending section to include beforeValueChange
• Proof read for any minor changes needed in intro section or prop definition section.
• Ensure a Basic Usage section is present within the Usage section

NestedList component has some changes related to styling. The image needs an update in accordance.

• Besides, it also has a search container just like the SingleList. We should use that in the image.

Issue Type:
Docs

Description:
Missing storybook and codesandbox examples from:

• ReactiveComponent
• DataController
• RatingsFilter
• SelectedFilters

reactivebase has onQueryChange prop in all sensors but its missing in docs.

Figure out a way to open playground links in new tab. Probably a solution would be while generating the html use a regex to add a target="_blank" rel="noopener noreferrer"

Showing/hiding checkboxes and radio buttons can now be configured using showCheckbox and showRadio props, both default to true.

Reference: appbaseio/reactivebase#89

• How to create an appbase.io app,
• How to set it up on a generic Elasticsearch cluster.

Current example plots a path b/w origin and destination which isn't related to the PlacesSearch component per se. Link - https://codepen.io/sids-aquarius/pen/prYzpy.

It should rather be based around the props specified in the example usage. The linked playground story will also require a change.

Consider replacing Reactive Manual as the official docs for the Reactive Maps website.

• Figure how to dynamically generate the github link and CTA based on URL params.

• Streaming support

  • Update onAllData signature
  • Description about meta properties like _updated, _deleted

• ReactiveBase

  • headers prop support with example

The docs on streaming are not very clear about how streaming works in ReactiveSearch's context. For example, when would results update and when would streamResults update. Some examples would be helpful in understanding this concept with some recipes on handling CUD in the results components.

As a starting point, explaining a TODO app with CUD should suffice.

• Image
• Annotated Image

Add it directly to the doc - https://opensource.appbase.io/reactive-manual/v1.0.0/search-components/NestedMultiList.html.

• NestedMultiList (playground links too)
• SelectedFilters (playground links too)

The links at the bottom of every Map Components component page are broken.

1. https://opensource.appbase.io/reactive-manual/map-components/geodistanceslider.html
2. https://opensource.appbase.io/reactive-manual/map-components/geodistancedropdown.html
3. https://opensource.appbase.io/reactive-manual/map-components/placessearch.html
4. https://opensource.appbase.io/reactive-manual/map-components/reactivemap.html

customQuery currently has a format like:

customQuery={
    function(value) {
      return {
        query: {
          match: {
            data_field: "this is a test"
          }
        }
      }
    }
  }

It should be updated to the following format (removing the surrounding query in the returned object):

customQuery={
    function(value) {
      return {
        match: {
            data_field: "this is a test"
        }
      }
    }
  }

Listing when and where to use each set of components.

Need to update codepen in NestedList
Also in CategorySearch
Probably needs update in all codepens

ReactiveSearch umd link has to be updated

Missing RangeInput docs.

Add queryFormat prop which can take and, or as values

How to apply mappings, use dejavu, etc.

• DatePicker
  • Why do we have showFilter and filterLabel props? Code Ref - these are missing from the doc.

• ReactiveList: new prop scrollOnTarget it should be the reference of element or window object if user wants to set scroll on window ( appbaseio/reactivebase#104 )

• Support weights prop in datasearch and in categorysearch (appbaseio/reactivebase#107)
  weights can be used to set the weights of fileds.
  It should be an array and should be in same order of appbaseField.

• Pagination new prop: pages (appbaseio/reactivebase#111)
  Implement pages prop to change size of shown pages.

The codepen link points to a RatingsFilter component, it should point to a DynamicRangeSlider component.

SelectedFilter:

• A component which can display selected values of other component and with each value there should be close button to clear selection of respective component.

Props:
componentId is required prop.

Restrict component:

By default all the components will be in selectedFilter but user should be able to prevent listing component in selectedFilter by using allowFilter prop.
allowFIlter by default it is true, set it to false to prevent listing in SelectedFilter

Break down into sections:

• Talk about how to set up the backend,
• Talk about the dataset and mappings,
• Talk about how to build the UIs,
• Talk about how to deploy.

Link to an example with:

• CRA,
• Reactivesearch-starter-app.

Other:

• Update the GIF being used.