rng -> randomNumberGenerator

madox2 · Mar 14, 2019 · 2ec4ffe · 2ec4ffe
1 parent 23e83ce
commit 2ec4ffe
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 18 deletions.
diff --git a/README.md b/README.md
@@ -43,14 +43,14 @@ const SimpleCloud = () => (
 
 | Option | Type | Required | Note |
 |-----------|----------|--------|---|
-|`tags`              |`Array`   |`true`|Array of objects representing tags (see [Tag object](#tag-object))|
-|`maxSize`           |`Number`  |`true` |Maximal font size (px) used in cloud|
-|`minSize`           |`Number`  |`true` |Minimal font size (px) used in cloud|
-|`shuffle`           |`Boolean` |`false`|If true, tags are shuffled. When `tags` are modified, cloud is re-shuffled. Default: `true`|
-|`rng`               |`Function`|`false`|Specifies a custom random number generator. Default: `Math.random`
-|`colorOptions`      |`Object`  |`false`|Random color options (see [randomColor#options](https://github.com/davidmerfield/randomColor#options))|
-|`disableRandomColor`|`Boolean` |`false`|If `true`, random color is not used|
-|`renderer`          |`Function`|`false`|Function used to render each tag|
+|`tags`                 |`Array`   |`true`|Array of objects representing tags (see [Tag object](#tag-object))|
+|`maxSize`              |`Number`  |`true` |Maximal font size (px) used in cloud|
+|`minSize`              |`Number`  |`true` |Minimal font size (px) used in cloud|
+|`shuffle`              |`Boolean` |`false`|If true, tags are shuffled. When `tags` are modified, cloud is re-shuffled. Default: `true`|
+|`randomNumberGenerator`|`Function`|`false`|Specifies a custom random number generator that is being used by shuffle algorithm. Default: `Math.random`
+|`colorOptions`         |`Object`  |`false`|Random color options (see [randomColor#options](https://github.com/davidmerfield/randomColor#options))|
+|`disableRandomColor`   |`Boolean` |`false`|If `true`, random color is not used|
+|`renderer`             |`Function`|`false`|Function used to render each tag|
 
 *Note:* Furthermore you can pass any other option and it will be passed forward to the wrapping `<div />` component (e.g. `style`, `className`).
 

diff --git a/__tests__/TagCloud-test.js b/__tests__/TagCloud-test.js
@@ -126,7 +126,7 @@ describe('TagCloud', () => {
   it('should use custom rng', () => {
     const rng = jest.fn();
     TestUtils.renderIntoDocument(
-      <TagCloud minSize={12} maxSize={30} tags={data} shuffle={true} rng={rng} />
+      <TagCloud minSize={12} maxSize={30} tags={data} shuffle={true} randomNumberGenerator={rng} />
     );
 
     expect(rng).toHaveBeenCalled();

diff --git a/examples/src/shuffle-with-seed.js b/examples/src/shuffle-with-seed.js
@@ -24,6 +24,6 @@ export default () => (
   <TagCloud minSize={12}
             maxSize={35}
             tags={data}
-            rng={random} />
+            randomNumberGenerator={random} />
 );
 
diff --git a/lib/TagCloud.js b/lib/TagCloud.js
@@ -38,7 +38,7 @@ function _possibleConstructorReturn(self, call) { if (!self) { throw new Referen
 function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function, not " + typeof superClass); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, enumerable: false, writable: true, configurable: true } }); if (superClass) Object.setPrototypeOf ? Object.setPrototypeOf(subClass, superClass) : subClass.__proto__ = superClass; }
 
 var eventHandlers = ['onClick', 'onDoubleClick', 'onMouseMove'];
-var cloudProps = ['tags', 'shuffle', 'renderer', 'maxSize', 'minSize', 'colorOptions', 'disableRandomColor', 'rng'];
+var cloudProps = ['tags', 'shuffle', 'renderer', 'maxSize', 'minSize', 'colorOptions', 'disableRandomColor', 'randomNumberGenerator'];
 
 var generateColor = function generateColor(tag, _ref) {
   var disableRandomColor = _ref.disableRandomColor,
@@ -117,7 +117,7 @@ var TagCloud = exports.TagCloud = function (_React$Component) {
           shuffle = props.shuffle,
           minSize = props.minSize,
           maxSize = props.maxSize,
-          rng = props.rng;
+          randomNumberGenerator = props.randomNumberGenerator;
 
       var counts = tags.map(function (tag) {
         return tag.count;
@@ -131,7 +131,7 @@ var TagCloud = exports.TagCloud = function (_React$Component) {
           fontSize: (0, _helpers.fontSizeConverter)(tag.count, min, max, minSize, maxSize)
         };
       });
-      this._data = shuffle ? (0, _shuffleArray2.default)(data, { copy: true, rng: rng }) : data;
+      this._data = shuffle ? (0, _shuffleArray2.default)(data, { copy: true, rng: randomNumberGenerator }) : data;
     }
   }]);
 
@@ -147,7 +147,7 @@ TagCloud.propTypes = {
   disableRandomColor: _propTypes2.default.bool,
   renderer: _propTypes2.default.func,
   className: _propTypes2.default.string,
-  rng: _propTypes2.default.func
+  randomNumberGenerator: _propTypes2.default.func
 };
 
 TagCloud.defaultProps = {

diff --git a/src/TagCloud.js b/src/TagCloud.js
@@ -6,7 +6,7 @@ import randomColor from 'randomcolor';
 import { omitProps, includeProps, fontSizeConverter, arraysEqual, propertiesEqual } from './helpers';
 
 const eventHandlers = ['onClick', 'onDoubleClick', 'onMouseMove'];
-const cloudProps = ['tags', 'shuffle', 'renderer', 'maxSize', 'minSize', 'colorOptions', 'disableRandomColor', 'rng'];
+const cloudProps = ['tags', 'shuffle', 'renderer', 'maxSize', 'minSize', 'colorOptions', 'disableRandomColor', 'randomNumberGenerator'];
 
 const generateColor = (tag, {disableRandomColor, colorOptions}) => {
   if (tag.color) {
@@ -59,7 +59,7 @@ export class TagCloud extends React.Component {
   }
 
   _populate(props) {
-    const { tags, shuffle, minSize, maxSize, rng } = props;
+    const { tags, shuffle, minSize, maxSize, randomNumberGenerator } = props;
     const counts = tags.map(tag => tag.count),
           min = Math.min(...counts),
           max = Math.max(...counts);
@@ -68,7 +68,7 @@ export class TagCloud extends React.Component {
       color: generateColor(tag, props),
       fontSize: fontSizeConverter(tag.count, min, max, minSize, maxSize)
     }));
-    this._data = shuffle ? arrayShuffle(data, { copy: true, rng: rng }) : data;
+    this._data = shuffle ? arrayShuffle(data, { copy: true, rng: randomNumberGenerator }) : data;
   }
 
 }
@@ -82,7 +82,7 @@ TagCloud.propTypes = {
   disableRandomColor: PropTypes.bool,
   renderer: PropTypes.func,
   className: PropTypes.string,
-  rng: PropTypes.func,
+  randomNumberGenerator: PropTypes.func,
 };
 
 TagCloud.defaultProps = {