@salesforce/design-system-react/utilities/warning/one-of-component.js

Salesforce Lightning Design System for React

/* Copyright (c) 2015-present, salesforce.com, inc. All rights reserved */
/* Licensed under BSD 3-Clause - see LICENSE.txt or git.io/sfdc-license */

/* eslint-disable import/no-mutable-exports */

// This function will deliver an error message to the browser console when all of the props passed in are undefined (falsey).
import warning from 'warning';

let oneOfComponent = function() {};

if (process.env.NODE_ENV !== 'production') {
	const hasWarned = {};
	oneOfComponent = function(
		control,
		props,
		propName,
		allowedComponents,
		comment,
		specificTest // if this is set, it will be checked instead of props[propName]
	) {
		const additionalComment = comment ? ` ${comment}` : '';

		let componentType;

		if (specificTest) {
			if (typeof specificTest.type === 'string') {
				componentType = specificTest.type;
			} else {
				componentType = specificTest.type.displayName;
			}
		} else if (typeof props[propName].type === 'string') {
			componentType = props[propName].type;
		} else {
			componentType = props[propName].type.displayName;
		}

		const allowedComponentFound = allowedComponents.indexOf(componentType) > -1;

		if (!allowedComponentFound && !hasWarned[control]) {
			/* eslint-disable max-len */
			warning(
				false,
				`[Design System React] ${control} requires that prop '${propName}' is an instance of one of the following components: ${allowedComponents.join(
					', '
				)}. An instance of '${componentType}' was given.${additionalComment}`
			);
			/* eslint-enable max-len */
			hasWarned[control] = true;
		}
	};
}

export default oneOfComponent;