TagCloud

TagCloud creates a tag cloud UI component, also known as word cloud or weighted list in visual design. It is a visual representation of text data, typically used to depict tags on websites, or to visualize free form text.

Example uses:

• news websites and blogs displaying related tags to a current post.
• show an e-commerce listings filter of user generated tags.

Usage

Basic Usage

<TagCloud componentId="TagCloud01" dataField="cities" />

Usage (with all props)

<TagCloud
	componentId="CitiesSensor"
	dataField="cities"
	title="City Cloud"
	size={32}
	showCount={true}
	multiSelect={true}
	defaultValue={['Auckland', 'Atlanta']}
	queryFormat="or"
	react={{
		and: ['CategoryFilter', 'SearchFilter'],
	}}
	showFilter={true}
	filterLabel="Cities"
	URLParams={false}
	loader="Loading ..."
    endpoint={{
      url:"https://appbase-demo-ansible-abxiydt-arc.searchbase.io/recipes-demo/_reactivesearch.v3", //mandatory
      headers:{
        // relevant headers
      },
      method: 'POST'
    }}        
/>

Props

componentId

unique identifier of the component, can be referenced in other components' react prop.

compoundClause

Configure whether the DSL query is generated with the compound clause of must or filter. If nothing is passed the default is to use must. Setting the compound clause to filter allows search engine to cache and allows for higher throughput in cases where scoring isn’t relevant (e.g. term, geo or range type of queries that act as filters on the data)

This property only has an effect when the search engine is either elasticsearch or opensearch.

Note: compoundClause is supported with v8.16.0 (server) as well as with serverless search.

endpoint

endpoint prop provides the ability to query a user-defined backend service for this component, overriding the data endpoint configured in the ReactiveBase component. Accepts the following properties:

• url String [Required] URL where the data cluster is hosted.
• headers Object [optional]
  set custom headers to be sent with each server request as key/value pairs.
• method String [optional]
  set method of the API request.
• body Object [optional]
  request body of the API request. When body isn't set and method is POST, the request body is set based on the component's configured props.

• Overrides the endpoint property defined in ReactiveBase.
• If required, use transformResponse prop to transform response in component-consumable format.

dataField

data field(s) to be mapped with the component's UI view.

nestedField

use to set the nested mapping field that allows arrays of objects to be indexed in a way that they can be queried independently of each other. Applicable only when dataField is a part of nested type.

title

title of the component to be shown in the UI.

loader

to display an optional loader while fetching the options.

size

number of list items to be displayed.

Note:

1. Appbase users should use the aggregationSize prop instead. The size prop would only set the size for hits not the aggregations.
2. We recommend Appbase users to not use the size prop unless they are using hits because it can impact the query performance.

aggregationSize

To set the number of buckets to be returned by aggregations.

showCount

show a count of the number of occurrences besides each list item. Defaults to true.

multiSelect

whether to support multiple tag selections. Defaults to false.

defaultValue

pre-select tag(s) from the tag cloud. An Array is accepted when multiSelect mode is enabled.

value

controls the current value of the component. It selects the tag from the available tags (on mount and on update). Use this prop in conjunction with onChange function.

queryFormat

sets whether to show results as a union with "or" (default) or an intersection with "and". For example, if two tags are selected, say "Guitars" and "Electric Guitars" then with a queryFormat of "or" you would get results for both the tags. With a queryFormat of "and" you would get more specific results for guitars which satisfy both the tags.

showFilter

show as filter when a value is selected in a global selected filters view. Defaults to true.

filterLabel

An optional label to display for the component in the global selected filters view. This is only applicable if showFilter is enabled. Default value used here is componentId.

URLParams

enable creating a URL query string parameter based on the selected value of the tag(s). This is useful for sharing URLs with the component state. Defaults to false.

renderError

can be used to render an error message in case of any error. js renderError={(error) => <div> Something went wrong!<br/>Error details<br/>{error} </div> }

onChange

is a callback function which accepts component's current value as a parameter. It is called when you are using the value props and the component's value changes. This prop is used to implement the controlled component behavior.

onError

gets triggered in case of an error and provides the error object, which can be used for debugging or giving feedback to the user if needed.

index

The index prop can be used to explicitly specify an index to query against for this component. It is suitable for use-cases where you want to fetch results from more than one index in a single ReactiveSearch API request. The default value for the index is set to the app prop defined in the ReactiveBase component.

Demo

Styles

TagCloud component supports innerClass prop with the following keys:

• title
• list
• input

Read more about it here.

Extending

TagCloud component can be extended to

1. customize the look and feel with className, style,
2. update the underlying DB query with customQuery,
3. connect with external interfaces using beforeValueChange, onValueChange and onQueryChange,
4. filter data using a combined query context via the react prop.

<TagCloud
  ...
  className="custom-class"
  style={{"paddingBottom": "10px"}}
  customQuery={
    function(value, props) {
      return {
        query: {
          match: {
            data_field: "this is a test"
          }
        }
      }
    }
  }
  beforeValueChange={
    function(value) {
      // called before the value is set
      // returns a promise
      return new Promise((resolve, reject) => {
        // update state or component props
        resolve()
        // or reject()
      })
    }
  }
  onValueChange={
    function(value) {
      console.log("current value: ", value)
      // set the state
      // use the value with other js code
    }
  }
  onQueryChange={
    function(prevQuery, nextQuery) {
      // use the query with other js code
      console.log('prevQuery', prevQuery);
      console.log('nextQuery', nextQuery);
    }
  }
  react={{
    "and": ["PriceFilter"]
  }}
/>

className

CSS class to be injected on the component container.

style

CSS styles to be applied to the TagCloud component.

customQuery

takes value and props as parameters and returns the data query to be applied to the component, as defined in Elasticsearch Query DSL. Note: customQuery is called on value changes in the TagCloud component as long as the component is a part of react dependency of at least one other component.

beforeValueChange

is a callback function which accepts component's future value as a parameter and returns a promise. It is called everytime before a component's value changes. The promise, if and when resolved, triggers the execution of the component's query and if rejected, kills the query execution. This method can act as a gatekeeper for query execution, since it only executes the query after the provided promise has been resolved.

Note:

If you're using Reactivesearch version >= 3.3.7, beforeValueChange can also be defined as a synchronous function. value is updated by default, unless you throw an Error to reject the update. For example:

beforeValueChange = values => {
   // The update is accepted by default
   if (values.includes('Amsterdam')) {
   	// To reject the update, throw an error
   	throw Error('Selected value should not include Amsterdam.');
   }
};

onValueChange

is a callback function which accepts component's current value as a parameter. It is called everytime the component's value changes. This prop is handy in cases where you want to generate a side-effect on value selection. For example: You want to show a pop-up modal with the valid discount coupon code when a user picks a category in a TagCloud.

onQueryChange

is a callback function which accepts component's prevQuery and nextQuery as parameters. It is called everytime the component's query changes. This prop is handy in cases where you want to generate a side-effect whenever the component's query would change.

react

specify dependent components to reactively update TagCloud's data view.

• key String one of and, or, not defines the combining clause.
  • and clause implies that the results will be filtered by matches from all of the associated component states.
  • or clause implies that the results will be filtered by matches from at least one of the associated component states.
  • not clause implies that the results will be filtered by an inverse match of the associated component states.
• value String or Array or Object
  • String is used for specifying a single component by its componentId.
  • Array is used for specifying multiple components by their componentId.
  • Object is used for nesting other key clauses.

Examples

See more stories for TagCloud on playground.

TagCloud with default props