All files / SearchableSingleSelect SearchableSingleSelect.tsx

87.77% Statements 79/90
70% Branches 35/50
62.5% Functions 10/16
91.86% Lines 79/86

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 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669                                                              1x   1x     1x 1x 1x             1x 1x 1x     1x 1x 1x         1x 1x 1x     1x   1x 1x           1x 1x                   1x   1x 1x         1x 1x 1x                   1x                                                                                                                       1x                                           1x                                 1x 1x           1x 1x 1x 1x 1x 1x 1x 1x   1x                                                                                                                                                                                                                                   22x   22x                                                     22x                                 1x   1x       1x 1x   1x     1x 1x   1x           22x                                                   22x       131x                 22x             130x 130x                       22x 21x             21x 21x         21x     21x     6x                   78x     21x 21x                               22x             1x 1x   1x 1x     22x                             22x   22x           22x         22x   1x   1x                                                                           21x                                                                                                                                                          
/* eslint-disable react/prop-types */
import _ from 'lodash';
import React from 'react';
import PropTypes from 'prop-types';
 
import { lucidClassNames } from '../../util/style-helpers';
import { buildModernHybridComponent } from '../../util/state-management';
import { partitionText, propsSearch } from '../../util/text-manipulation';
import {
	StandardProps,
	getFirst,
	findTypes,
	Overwrite,
} from '../../util/component-types';
import {
	SearchFieldDumb as SearchField,
	ISearchFieldProps,
} from '../SearchField/SearchField';
import {
	IDropMenuProps,
	IDropMenuState,
	IDropMenuOptionProps,
	IOptionsData,
	IDropMenuOptionGroupProps,
	DropMenuDumb as DropMenu,
} from '../DropMenu/DropMenu';
import LoadingIcon from '../Icon/LoadingIcon/LoadingIcon';
import Selection from '../Selection/Selection';
import { Validation } from '../Validation/Validation';
import * as reducers from './SearchableSingleSelect.reducers';
 
const { any, bool, func, number, oneOfType, shape, string, node } = PropTypes;
 
const cx = lucidClassNames.bind('&-SearchableSingleSelect');
 
/** Option Group */
const OptionGroup = (_props: IDropMenuOptionGroupProps): null => null;
OptionGroup.displayName = 'SearchableSingleSelect.OptionGroup';
OptionGroup.peek = {
	description: `
		A special kind of \`Option\` that is always rendered at the top of
		the menu and has an \`optionIndex\` of \`null\`. Useful for
		unselect.
	`,
};
OptionGroup.propName = 'OptionGroup';
OptionGroup.propTypes = DropMenu.OptionGroup.propTypes;
OptionGroup.defaultProps = DropMenu.OptionGroup.defaultProps;
 
/** Search Field */
const SearchFieldComponent = (_props: ISearchFieldProps): null => null;
SearchFieldComponent.displayName = 'SearchableSingleSelect.SearchField';
SearchFieldComponent.peek = {
	description: `
		Passes props through to the \`Search Field\`.
	`,
};
SearchFieldComponent.propName = 'SearchField';
SearchFieldComponent.propTypes = SearchField.propTypes;
SearchFieldComponent.defaultProps = SearchField.defaultProps;
 
/** Selected */
const Selected = (_props: { children?: React.ReactNode }): null => null;
 
Selected.displayName = 'SearchableSingleSelect.Option.Selected';
Selected.peek = {
	description: `
		Customizes the rendering of the Option when it is selected
		and is displayed instead of the Placeholder.
	`,
};
Selected.propName = 'Selected';
Selected.propTypes = {};
 
/** Option */
export interface ISearchableSingleSelectOptionProps
	extends IDropMenuOptionProps {
	description?: string;
	name?: string;
	Selected?: React.ReactNode;
}
 
const Option = (_props: ISearchableSingleSelectOptionProps): null => null;
 
Option.displayName = 'SearchableSingleSelect.Option';
Option.peek = {
	description: `
		A selectable option in the list.
	`,
};
Option.Selected = Selected;
Option.propName = 'Option';
Option.propTypes = {
	/**
		Customizes the rendering of the Option when it is selected and is
		displayed instead of the Placeholder.
	*/
	Selected: any,
	value: string,
	filterText: string,
	...DropMenu.Option.propTypes,
};
Option.defaultProps = DropMenu.Option.defaultProps;
 
/** Searchable Single Select */
export interface ISearchableSingleSelectPropsRaw extends StandardProps {
	hasReset?: boolean;
	hasSelections?: boolean;
	isDisabled: boolean;
	isLoading: boolean;
	maxMenuHeight?: string;
	selectedIndex: number | null;
	searchText: string;
	SearchField: React.ReactNode;
	DropMenu: IDropMenuProps;
	Option?: React.ReactNode;
	OptionGroup?: IDropMenuOptionGroupProps;
	Error: React.ReactNode;
	/** Called when an option is clicked, or when an option has focus and the
		Enter key is pressed. */
	onSelect: (
		optionIndex: number | null,
		{
			props,
			event,
		}: {
			props: IDropMenuOptionProps | undefined;
			event: React.KeyboardEvent | React.MouseEvent;
		}
	) => void;
 
	onSearch: (
		searchText: string,
		firstVisibleIndex: number | null,
		{
			props,
			event,
		}: {
			props: IDropMenuOptionProps;
			event: React.KeyboardEvent | React.MouseEvent;
		}
	) => void;
 
	optionFilter: (searchValue: string, props: any) => boolean;
}
 
export type ISearchableSingleSelectProps = Overwrite<
	React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>,
	ISearchableSingleSelectPropsRaw
>;
 
export interface ISearchableSingleSelectState {
	DropMenu: IDropMenuState;
	selectedIndex: number | null;
	searchText: string | null;
	optionGroups: IDropMenuOptionGroupProps[];
	flattenedOptionsData: IOptionsData[];
	ungroupedOptionData: IOptionsData[];
	optionGroupDataLookup: { [key: number]: IOptionsData[] };
}
 
/** TODO: Remove nonPassThroughs when the component is converted to a functional component */
const nonPassThroughs = [
	'children',
	'className',
	'isDisabled',
	'isLoading',
	'maxMenuHeight',
	'onSearch',
	'onSelect',
	'optionFilter',
	'searchText',
	'selectedIndex',
	'DropMenu',
	'Option',
	'Error',
	'FixedOption',
	'NullOption',
	'OptionGroup',
	'SearchField',
	'initialState',
	'callbackId',
];
 
const defaultProps = {
	isDisabled: false,
	isLoading: false,
	optionFilter: propsSearch,
	searchText: '',
	selectedIndex: null,
	DropMenu: DropMenu.defaultProps,
	Error: null,
	onSearch: _.noop,
	onSelect: _.noop,
	SearchField: SearchField.defaultProps,
};
 
class SearchableSingleSelect extends React.Component<
	ISearchableSingleSelectProps,
	ISearchableSingleSelectState
> {
	static displayName = 'SearchableSingleSelect';
	static peek = {
		description: `A control used to select a single option from a dropdown list using a \`SearchField\`.`,
		categories: ['controls', 'selectors'],
		madeFrom: ['Checkbox', 'SearchField', 'DropMenu', 'LoadingIcon'],
	};
 
	static defaultProps = defaultProps;
	static reducers = reducers;
	static Option = Option;
	static OptionGroup = OptionGroup;
	static SearchField = SearchFieldComponent;
	static NullOption = DropMenu.NullOption;
	static FixedOption = DropMenu.FixedOption;
	static DropMenu = DropMenu;
 
	static propTypes = {
		/**
			Should be instances of {\`SearchableSingleSelect.Option\`}. Other direct
			child elements will not render.
		*/
		children: node,
 
		/**
			Appended to the component-specific class names set on the root element.
		*/
		className: string,
 
		/**
			Disables the control from being clicked or focused.
		*/
		isDisabled: bool,
 
		/**
			Displays a LoadingIcon to allow for asynchronous loading of options.
		*/
		isLoading: bool,
 
		/**
			The max height of the fly-out menu.
		*/
		maxMenuHeight: oneOfType([number, string]),
 
		onSearch: func /**
			Called when the user enters a value to search for; the set of visible
			Options will be filtered using the value.  Signature: \`(searchText,
			firstVisibleIndex, {props, event}) => {}\` \`searchText\` is the value
			from the \`SearchField\` and \`firstVisibleIndex\` is the index of the
			first option that will be visible after filtering.
		*/,
 
		/**
			Called when an option is selected.  Signature: \`(optionIndex, {props,
			event}) => {}\` \`optionIndex\` is the new \`selectedIndex\` or \`null\`.
		*/
		onSelect: func,
 
		/**
			The function that will be run against each Option's props to determine
			whether it should be visible or not. The default behavior of the function
			is to match, ignoring case, against any text node descendant of the
			\`Option\`.  Signature: \`(searchText, optionProps) => {}\` If \`true\`
			is returned, the option will be visible. If \`false\`, the option will
			not be visible.
		*/
		optionFilter: func,
 
		/**
			The current search text to filter the list of options by.
		*/
		searchText: string,
 
		/**
			Currently selected \`SearchableSingleSelect.Option\` index
			or \`null\` if nothing is selected.
		*/
		selectedIndex: number,
 
		/**
			Object of DropMenu props which are passed through to the underlying
			DropMenu component.
		*/
		DropMenu: shape(DropMenu.propTypes),
 
		Option: any /**
			*Child Element* - These are menu options. Each \`Option\` may be passed a
			prop called \`isDisabled\` to disable selection of that \`Option\`. Any
			other props pass to Option will be available from the \`onSelect\`
			handler.  It also support the \`Selection\` prop that can be used to
			forward along props to the underlying \`Selection\` component.
		*/,
 
		/**
			In most cases this will be a string, but it also accepts any valid React
			element. If this is a falsey value, then no error message will be
			displayed.  If this is the literal \`true\`, it will add the
			\`-is-error\` class to the wrapper div, but not render the
			\`-error-content\` \`div\`.
		*/
		Error: any,
 
		FixedOption: any /**
			*Child Element* - A special kind of \`Option\` that is always rendered at the top of
			the menu.
		*/,
 
		NullOption: any /**
			*Child Element* - A special kind of \`Option\` that is always rendered at
			the top of the menu and has an \`optionIndex\` of \`null\`. Useful for
			unselect.
		*/,
 
		OptionGroup: any /**
			*Child Element* - Used to group \`Option\`s within the menu. Any
			non-\`Option\`s passed in will be rendered as a label for the group.
		*/,
 
		/**
		 *Child Element* - Passes props through to the \`SearchField\` component.
		 */
		SearchField: any,
	};
 
	UNSAFE_componentWillMount(): void {
		// preprocess the options data before rendering
		const {
			optionGroups,
			flattenedOptionsData,
			ungroupedOptionData,
			optionGroupDataLookup,
		} = DropMenu.preprocessOptionData(this.props, SearchableSingleSelect);
 
		this.setState({
			optionGroups,
			flattenedOptionsData,
			ungroupedOptionData,
			optionGroupDataLookup,
		});
	}
 
	UNSAFE_componentWillReceiveProps(
		nextProps: ISearchableSingleSelectProps
	): void {
		// only preprocess options data when it changes (via new props) - better performance than doing this each render
		const {
			optionGroups,
			flattenedOptionsData,
			ungroupedOptionData,
			optionGroupDataLookup,
		} = DropMenu.preprocessOptionData(nextProps, SearchableSingleSelect);
 
		this.setState({
			optionGroups,
			flattenedOptionsData,
			ungroupedOptionData,
			optionGroupDataLookup,
		});
	}
 
	handleSearch = (
		searchText: string,
		{
			event,
		}: {
			event:
				| React.KeyboardEvent<Element>
				| React.MouseEvent<Element, MouseEvent>;
		}
	): void => {
		const {
			props,
			props: {
				onSearch,
				optionFilter,
				DropMenu: { onExpand },
			},
		} = this;
 
		const options = _.map(
			findTypes(props, SearchableSingleSelect.Option),
			'props'
		);
		const firstVisibleIndex = _.findIndex(options, (option) => {
			return optionFilter(searchText, option);
		});
		const firstVisibleProps = options[firstVisibleIndex];
		// Just an extra call to make sure the search results show up when a user
		// is typing
		const dropMenuProps = this.props.DropMenu;
		onExpand && onExpand({ event, props: dropMenuProps });
 
		return onSearch(searchText, firstVisibleIndex, {
			event,
			props: firstVisibleProps,
		});
	};
 
	renderUnderlinedChildren = (childText: string, searchText: string): any[] => {
		const [pre, match, post] = partitionText(
			childText,
			new RegExp(_.escapeRegExp(searchText), 'i'),
			searchText.length
		);
 
		return [
			pre && (
				<span key='pre' className={cx('&-Option-underline-pre')}>
					{pre}
				</span>
			),
			match && (
				<span key='match' className={cx('&-Option-underline-match')}>
					{match}
				</span>
			),
			post && (
				<span key='post' className={cx('&-Option-underline-post')}>
					{post}
				</span>
			),
		];
	};
 
	renderOptionContent = (
		optionProps: ISearchableSingleSelectOptionProps,
		searchText: string
	): any => {
		return _.isString(optionProps.children) &&
			_.isString(searchText) &&
			searchText.length > 0
			? this.renderUnderlinedChildren(optionProps.children, searchText)
			: _.isFunction(optionProps.children)
			? React.createElement(optionProps.children, { searchText })
			: optionProps.children;
	};
 
	renderOption = ({
		optionProps,
		optionIndex,
	}: {
		optionProps: ISearchableSingleSelectOptionProps;
		optionIndex: number | null;
	}): any => {
		const { searchText, isLoading, optionFilter } = this.props;
		return (
			<DropMenu.Option
				key={'SearchableSingleSelectOption' + optionIndex}
				{..._.omit(optionProps, ['children', 'Selected', 'filterText'])}
				isHidden={!optionFilter(searchText, optionProps)}
				isDisabled={optionProps.isDisabled || isLoading}
			>
				{this.renderOptionContent(optionProps, searchText)}
			</DropMenu.Option>
		);
	};
 
	renderOptions = (): any => {
		const { searchText, isLoading } = this.props;
 
		const {
			optionGroups,
			optionGroupDataLookup,
			ungroupedOptionData,
			flattenedOptionsData,
		} = this.state;
		const visibleOptions = _.reject(
			flattenedOptionsData,
			'optionProps.isHidden'
		);
 
		const isAllOptionsHidden = _.isEmpty(visibleOptions);
 
		// for each option group passed in, render a DropMenu.OptionGroup, any label will be included in it's children, render each option inside the group
		const dropMenuOptions = _.map(
			optionGroups,
			(optionGroupProps, optionGroupIndex) => (
				<DropMenu.OptionGroup
					key={'SearchableSingleSelectOptionGroup' + optionGroupIndex}
					{..._.omit(optionGroupProps, 'children', 'Selected')}
				>
					{optionGroupProps.children}
					{_.map(optionGroupDataLookup[optionGroupIndex], this.renderOption)}
				</DropMenu.OptionGroup>
			)
		).concat(
			// then render all the ungrouped options at the end
			_.map(ungroupedOptionData, (options) => this.renderOption(options))
		);
 
		if (!isAllOptionsHidden || _.isEmpty(searchText)) {
			return dropMenuOptions;
		}
 
		if (!isLoading) {
			return (
				<DropMenu.Option isDisabled>
					<span className={cx('&-noresults')}>
						No results match "{searchText}"
					</span>
				</DropMenu.Option>
			);
		}
 
		return null;
	};
 
	removeSelection = ({
		event,
		props,
	}: {
		event: React.KeyboardEvent<Element> | React.MouseEvent<Element, MouseEvent>;
		props: ISearchableSingleSelectOptionProps;
	}): void => {
		const dropMenuProps = this.props.DropMenu;
		this.props.DropMenu.onCollapse &&
			this.props.DropMenu.onCollapse({ event, props: dropMenuProps });
		this.props.onSearch('', null, { event, props });
		this.props.onSelect(null, { event, props });
	};
 
	render = () => {
		const {
			props,
			props: {
				className,
				isLoading,
				isDisabled,
				maxMenuHeight,
				DropMenu: dropMenuProps,
				DropMenu: { optionContainerStyle },
				searchText,
				selectedIndex,
				onSelect,
				...passThroughs
			},
		} = this;
 
		const searchFieldProps = _.get(
			getFirst(props, SearchableSingleSelect.SearchField),
			'props',
			{}
		);
 
		const errorChildProps = _.first(
			_.map(findTypes(props, Validation.Error), 'props')
		);
 
		//user made a selection
		if (!_.isNil(selectedIndex)) {
			const selectedOptionProps =
				this.state.flattenedOptionsData[selectedIndex].optionProps;
 
			return (
				<div
					{..._.omit(passThroughs, nonPassThroughs)}
					className={cx('&', className)}
				>
					<Selection
						Label={
							_.isNil(selectedOptionProps.Selected)
								? this.renderOptionContent(selectedOptionProps, '')
								: selectedOptionProps.Selected
						}
						className={cx(
							'&',
							{
								'&-select-error':
									errorChildProps &&
									errorChildProps.children &&
									errorChildProps.children !== true,
							},
							className
						)}
						onRemove={this.removeSelection}
						kind='default'
					/>
					{errorChildProps &&
					errorChildProps.children &&
					errorChildProps.children !== true ? (
						<div
							{..._.omit(errorChildProps, ['initialState', 'callbackId'])}
							className={cx('&-error-select-content')}
						>
							{errorChildProps.children}
						</div>
					) : null}
				</div>
			);
		}
 
		return (
			<div
				{..._.omit(passThroughs, nonPassThroughs)}
				className={cx('&', className)}
			>
				<DropMenu
					{...dropMenuProps}
					selectedIndices={null}
					className={cx(
						'&-DropMenu',
						{
							'&-DropMenu-is-small': true,
						},
						dropMenuProps.className
					)}
					optionContainerStyle={_.assign(
						{},
						optionContainerStyle,
						!_.isNil(maxMenuHeight) ? { maxHeight: maxMenuHeight } : null
					)}
					isDisabled={isDisabled}
					onSelect={onSelect}
					ContextMenu={{
						alignmentOffset: -13,
						directonOffset: -1,
						minWidthOffset: -28,
					}}
				>
					<DropMenu.Control>
						<SearchField
							{...searchFieldProps}
							autoComplete={searchFieldProps.autoComplete || 'off'}
							isDisabled={isDisabled}
							className={cx(
								'&-search',
								{
									'&-search-is-error':
										errorChildProps && errorChildProps.children,
								},
								searchFieldProps.className
							)}
							value={searchText}
							onChange={this.handleSearch}
						/>
					</DropMenu.Control>
					{isLoading ? (
						<DropMenu.Option
							key='SearchableSingleSelectLoading'
							className={cx('&-loading')}
							isDisabled
						>
							<LoadingIcon />
						</DropMenu.Option>
					) : null}
					{this.renderOptions()}
				</DropMenu>
				{errorChildProps &&
				errorChildProps.children &&
				errorChildProps.children !== true ? (
					<div
						{..._.omit(errorChildProps, ['initialState', 'callbackId'])}
						className={cx('&-error-content')}
					>
						{errorChildProps.children}
					</div>
				) : null}
			</div>
		);
	};
}
 
export default buildModernHybridComponent<
	ISearchableSingleSelectProps,
	ISearchableSingleSelectState,
	typeof SearchableSingleSelect
>(SearchableSingleSelect as any, { reducers });
export { SearchableSingleSelect as SearchableSingleSelectDumb };