All files / IconSelect IconSelect.tsx

85.71% Statements 30/35
73.52% Branches 25/34
100% Functions 6/6
85.71% Lines 30/35

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243                    1x   1x   1x 1x 1x                                                                                                               1x           1x                 16x   16x 1x 1x 1x 1x   1x 1x 1x           16x 10x                   16x 24x 24x 24x   24x                                               16x                               24x 24x                                                   1x   1x   1x         1x                                                                                              
import _, { omit } from 'lodash';
import React from 'react';
import PropTypes from 'prop-types';
 
import Icon from '../Icon/Icon';
import RadioButtonLabeled from '../RadioButtonLabeled/RadioButtonLabeled';
import CheckboxLabeled from '../CheckboxLabeled/CheckboxLabeled';
import { lucidClassNames } from '../../util/style-helpers';
import { StandardProps, Overwrite } from '../../util/component-types';
 
const cx = lucidClassNames.bind('&-IconSelect');
 
const { arrayOf, bool, func, node, number, oneOf, string, shape } = PropTypes;
 
const getFigureParent = (domNode: HTMLElement): HTMLElement | undefined => {
	if (domNode.classList.contains(cx('&-Item'))) {
		return domNode;
	}
	if (domNode === document.body) {
		throw new Error(`domNode is not a child of .${cx('&-Item')}`);
	}
	if (domNode.parentElement) {
		return getFigureParent(domNode.parentElement);
	}
 
	return;
};
 
interface Item {
	id: string;
	icon?: React.ReactElement;
	label?: React.ReactElement | string;
	isSelected?: boolean;
	isPartial?: boolean;
	tabIndex?: number;
	isDisabled?: boolean;
	className?: string;
}
 
interface IIconSelectPropsRaw extends StandardProps {
	/** Items in the IconSelect group. Each item should have an id. */
	items: Item[];
 
	/** Defines the type of IconSelect box. A 'single' select will create a radio
		input type Item. A 'multiple' select will create a checkbox input type. */
	kind: 'single' | 'multiple';
 
	/** A function that is called with the id of the Item in the IconSelect group
		is clicked. */
	onSelect: (
		id: string,
		{
			event,
			props,
		}: {
			event: React.MouseEvent;
			props: IIconSelectProps;
		}
	) => void;
 
	/** Disabled all IconSelect Items. */
	isDisabled: boolean;
}
 
export type IIconSelectProps = Overwrite<
	React.DetailedHTMLProps<
		React.HTMLAttributes<HTMLSpanElement>,
		HTMLSpanElement
	>,
	IIconSelectPropsRaw
>;
 
const defaultProps = {
	kind: 'multiple' as const,
	isDisabled: false,
	onSelect: _.noop,
};
 
export const IconSelect = (props: IIconSelectProps): React.ReactElement => {
	const {
		className,
		children,
		kind,
		items,
		isDisabled,
		onSelect,
		...passThroughs
	} = props;
 
	const handleClick = (event: React.MouseEvent): void => {
		if (!props.isDisabled) {
			const domNode = getFigureParent(event.target as HTMLElement);
			if (domNode) {
				const id = domNode.dataset.id;
 
				domNode.focus();
				if (!domNode.hasAttribute('disabled') && id) {
					onSelect(id, { event, props: props });
				}
			}
		}
	};
 
	const getChildIcon = (icon: React.ReactElement): React.ReactElement => {
		return icon ? (
			icon
		) : (
			<Icon>
				<rect x='0' y='0' width='16' height='16' />
				<rect x='1' y='1' width='14' height='14' fill='white' />
			</Icon>
		);
	};
 
	const getInputComponent = (item: Item) => {
		const { kind, className, isDisabled } = props;
		const Label = item.label;
		const singleSelect = _.isEqual(kind, 'single');
 
		return singleSelect ? (
			<RadioButtonLabeled
				Label={Label}
				className={cx('&-Item-radio', {
					[`${className}-radio`]: className,
				})}
				isDisabled={isDisabled || item.isDisabled}
				isSelected={item.isSelected}
				// tabIndex={item.tabIndex}
			/>
		) : (
			<CheckboxLabeled
				Label={Label}
				className={cx('&-Item-checkbox', {
					[`${className}-checkbox`]: className,
				})}
				isDisabled={isDisabled || item.isDisabled ? true : false}
				isIndeterminate={item.isPartial ? true : false}
				isSelected={item.isSelected ? true : false}
				// tabIndex={item.tabIndex}
			/>
		);
	};
 
	return (
		<span
			{...omit(
				passThroughs,
				[
					'className',
					'children',
					'items',
					'kind',
					'onSelect',
					'isDisabled',
				].concat(['initialState', 'callbackId'])
			)}
			className={cx('&', className)}
		>
			{_.map(items, (childItem, index): React.ReactElement => {
				const itemDisabled = isDisabled || childItem.isDisabled;
				return (
					<figure
						key={`iconselectitem_${index}`}
						className={cx('&-Item', childItem.className, {
							[`${className}-Item`]: className,
							'&-Item-is-disabled': itemDisabled,
							'&-Item-is-partial': childItem.isPartial,
							'&-Item-is-selected': childItem.isSelected,
							'&-Item-multi': kind === 'multiple',
							'&-Item-single': kind === 'single',
						})}
						data-id={childItem.id}
						onClick={itemDisabled ? undefined : handleClick}
					>
						{childItem.icon && getChildIcon(childItem.icon)}
						<figcaption className={cx('&-Item-figcaption')}>
							{getInputComponent(childItem)}
						</figcaption>
					</figure>
				);
			})}
			{children}
		</span>
	);
};
 
IconSelect.displayName = 'IconSelect';
 
IconSelect.defaultProps = defaultProps;
 
IconSelect.peek = {
	description: `\`IconSelect\` allows you to pair icons together to form a related cluster. Any props not explicitly called out are spread on to the root component.`,
	categories: ['controls', 'selectors'],
};
 
IconSelect.propTypes = {
	/**
		Appended to the component-specific class names set on the root element.
		Value is run through the \`classnames\` library.
	*/
	className: string,
 
	/**
		Added to the end of the IconSelect group.
	*/
	children: node,
 
	/**
		Items in the IconSelect group. Each item should have an id.
	*/
	items: arrayOf(
		shape({
			id: string.isRequired,
			icon: node,
			label: node,
			isSelected: bool,
			isPartial: bool,
			tabIndex: number,
			isDisabled: bool,
			className: string,
		})
	).isRequired,
 
	/**
		Defines the type of IconSelect box. A 'single' select will create a radio
		input type Item. A 'multiple' select will create a checkbox input type.
	*/
	kind: oneOf(['single', 'multiple']),
 
	/**
		A function that is called with the id of the Item in the IconSelect group
		is clicked.  Signature: \`(id, { event }) => {}\`
	*/
	onSelect: func,
 
	/**
		Disabled all IconSelect Items.
	*/
	isDisabled: bool,
};
 
export default IconSelect;