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 ..."
/>
Props
-
componentId
String
unique identifier of the component, can be referenced in other components'react
prop. -
dataField
String
data field(s) to be mapped with the component's UI view. -
nestedField
String
[optional] use to set thenested
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 ofnested
type. -
title
String or JSX
[optional] title of the component to be shown in the UI. -
loader
String or JSX
[optional] to display an optional loader while fetching the options. -
size
Number
[optional] number of list items to be displayed.Note:
- Appbase users should use the
aggregationSize
prop instead. Thesize
prop would only set the size forhits
not theaggregations
. - We recommend Appbase users to not use the
size
prop unless they are usinghits
because it can impact the query performance.
- Appbase users should use the
-
aggregationSize To set the number of buckets to be returned by aggregations.
Note: This prop is only applicable when
enableAppbase
is set totrue
. -
showCount
Boolean
[optional] show a count of the number of occurrences besides each list item. Defaults totrue
. -
multiSelect
Boolean
[optional] whether to support multiple tag selections. Defaults tofalse
. -
defaultValue
StringArray
[optional] pre-select tag(s) from the tag cloud. An Array is accepted when multiSelect mode is enabled. -
value
String Array
[optional] 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 withonChange
function. -
queryFormat
String
[optional] 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 aqueryFormat
of "or" you would get results for both the tags. With aqueryFormat
of "and" you would get more specific results for guitars which satisfy both the tags. -
showFilter
Boolean
[optional] show as filter when a value is selected in a global selected filters view. Defaults totrue
. -
filterLabel
String
[optional] An optional label to display for the component in the global selected filters view. This is only applicable ifshowFilter
is enabled. Default value used here iscomponentId
. -
URLParams
Boolean
[optional] 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 tofalse
. -
renderError
String or JSX or Function
[optional] 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
function
[optional] is a callback function which accepts component's current value as a parameter. It is called when you are using thevalue
props and the component's value changes. This prop is used to implement the controlled component behavior. -
onError
Function
[optional] gets triggered in case of an error and provides theerror
object, which can be used for debugging or giving feedback to the user if needed. -
index
String
[optional] 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 theapp
prop defined in the ReactiveBase component.Note: This only works when
enableAppbase
prop is set to true inReactiveBase
.
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
- customize the look and feel with
className
,style
, - update the underlying DB query with
customQuery
, - connect with external interfaces using
beforeValueChange
,onValueChange
andonQueryChange
, - 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
String
CSS class to be injected on the component container. -
style
Object
CSS styles to be applied to the TagCloud component. -
customQuery
Function
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 ofreact
dependency of at least one other component. -
beforeValueChange
Function
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 anError
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
Function
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
Function
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
Object
specify dependent components to reactively update TagCloud's data view.- key
String
one ofand
,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 itscomponentId
.Array
is used for specifying multiple components by theircomponentId
.Object
is used for nesting other key clauses.
- key
Examples
See more stories for TagCloud on playground.