react-tagcloud

Simple and extensible tag/word cloud React component.

See the demo.

Installation

npm install react-tagcloud

# or with yarn
yarn add react-tagcloud

# react < 16.8.0
npm install react-tagcloud@1.4

Basic usage

import { TagCloud } from 'react-tagcloud'

const data = [
  { value: 'JavaScript', count: 38 },
  { value: 'React', count: 30 },
  { value: 'Nodejs', count: 28 },
  { value: 'Express.js', count: 25 },
  { value: 'HTML5', count: 33 },
  { value: 'MongoDB', count: 18 },
  { value: 'CSS3', count: 20 },
]

const SimpleCloud = () => (
   alert(`'${tag.value}' was selected!`)}
  />
)

React Native

In react native projects import tag cloud from the package relative path react-tagcloud/rn.

import React from 'react';

import { Alert } from 'react-native';
import { TagCloud } from 'react-tagcloud/rn'

const data = [
  // ...
]

const SimpleCloud = () => (
   Alert.alert(`'${tag.value}' was selected!`)}
  />
)

API

Options

`` component has props listed below:

Note: Furthermore you can pass any other prop and it will be forwarded to the wrapping <div> component (e.g. style, className).

Tag object

Each tag is represented by object literal having following properties:

Events

Event handlers can be passed to the `` props. Each handler has two arguments: the first is related tag object and the second is DOM event object.

Currently supported events: onClick, onDoubleClick, onMouseMove

Note: Feel free to open issue if any other event is needed.

Styles

Default class names are tag-cloud for the wrapping container, and tag-cloud-tag for a particular tag. Styles passed to `` props will be applied to the wrapping container.

Renderer

Rendering of tags can be fully customized by providing custom render function and passing it to the renderer prop. By default is used defaultRenderer. Render function has three arguments - tag, size and color. For example:

import { TagCloud } from 'react-tagcloud'

const customRenderer = (tag, size, color) => {
  return (
    <span color="" style="{{">
      {tag.value}
    </span>
  )
}

const CustomizedCloud = () =&gt; (
  
)

More examples

• Simple tag cloud
• Custom color options
• Custom styles
• Custom tag props
• Custom renderer

Testing

Install dev modules:

yarn install

Run unit tests

yarn test

Run examples

cd examples
yarn install
yarn start

and open browser at https://localhost:3000

License

MIT License