All files / packages/design-system/ui/components/combobox/listbox index.jsx

94.59% Statements 35/37
85.71% Branches 72/84
100% Functions 8/8
94.59% Lines 35/37

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                              11x 150x                               11x 151x                               11x 679x                     11x 1x                                 679x                                                   11x 89x                       11x 93x                                                                                                                                                       11x 3x                                                           11x 583x                                                                                                                                                 146x 146x 146x       93x 93x                                                   577x 577x                                                                   149x 149x                                                                             11x                             2x 2x 2x                                                 6x 6x               2x 2x                           11x          
// Copyright (c) 2015-present, salesforce.com, inc. All rights reserved
// Licensed under BSD 3-Clause - see LICENSE.txt or git.io/sfdc-license
 
import React, { Component } from 'react';
import PropTypes from 'prop-types';
import classNames from 'classnames';
import { StandardIcon } from '../../icons/standard/example';
import { UtilityIcon } from '../../icons/base/example';
import { Spinner } from '../../spinners/base/example';
import _ from '../../../shared/helpers';
import uniqueId from 'lodash.uniqueid';
 
/**
 * Listbox
 */
export const ListboxWrapper = props => (
  <div
    id={props.id || uniqueId('listbox-id')}
    className={props.className}
    role="listbox"
    aria-orientation={props.horizontal || props.inline ? 'horizontal' : null}
    aria-label = {props.ariaLabel}
    tabIndex="0"
    aria-busy={props.ariaBusy ?props.ariaBusy:null}
  >
    {props.children}
  </div>
);
 
/**
 * Listbox List
 */
export const ListboxList = props => (
  <ul
    className={classNames('slds-listbox', {
      'slds-listbox_vertical': props.vertical,
      'slds-listbox_horizontal': props.horizontal,
      'slds-listbox_inline': props.inline
    })}
    role={props['aria-label'] ? 'group' : 'presentation'}
    aria-label={props['aria-label']}
  >
    {props.children}
  </ul>
);
 
/**
 * Listbox Item
 */
export const ListboxItem = props => (
  <li
    role={props.isLoadingSpinner ? "option" : "presentation" }
    className={classNames('slds-listbox__item', props.className)}
  >
    {props.children}
  </li>
);
 
/**
 * Listbox Item Sub-Heading
 */
export const ListboxItemHeading = props => (
  <li role="presentation" className="slds-listbox__item">
    <div
      className="slds-listbox__option slds-listbox__option_plain"
      role="presentation"
      title={props.text}
    >
      <h3 className="slds-listbox__option-header" role="presentation">
        {props.text}
      </h3>
    </div>
  </li>
);
 
/**
 * Listbox Option
 */
export const ListboxOption = props => {
  return (
    <div
      ref={props.focusedRef}
      aria-selected={props.focused ? 'true' : null}
      aria-disabled={props.isDisabled ? 'true' : null}
      aria-checked={props.selected ? 'true' : null}
      id={props.id || uniqueId('listbox-option-id-')}
      className={classNames(
        'slds-media slds-listbox__option',
        {
          'slds-listbox__option_plain': props.type === 'plain',
          'slds-listbox__option_entity': props.type === 'entity'
        },
        props.className
      )}
      role={props.label ? 'presentation' : 'option'}
      tabIndex={props.tabIndex}
    >
      {props.children}
    </div>
  );
};
 
/**
 * Listbox Option Icon
 */
export const ListboxOptionIcon = props => (
  <span
    className={classNames('slds-media__figure slds-listbox__option-icon', {
      'slds-listbox__option-icon-disabled': props.isDisabled
    })}
  >
    {props.children}
  </span>
);
 
/**
 * Entity Option
 */
export const EntityOption = props => (
  <ListboxOption
    type={!props.label ? 'entity' : 'plain'}
    id={props.id}
    tabIndex={props.tabIndex}
    label={props.label}
    focused={props.focused}
    isDisabled={props.isDisabled}
    className={classNames(
      {
        'slds-media_center': !props.entityMeta,
        'slds-listbox__option_has-meta': props.entityMeta,
        'slds-has-focus': props.focused
      },
      props.className
    )}
  >
    {!props.label && (
      <ListboxOptionIcon isDisabled={props.isDisabled}>
        <StandardIcon
          className="slds-icon_small"
          symbol={
            (props.entityType && props.entityType.toLowerCase()) || 'account'
          }
          assistiveText={false}
          title={false}
          isDisabled={props.isDisabled}
        />
      </ListboxOptionIcon>
    )}
    {props.label ? (
      <h3 className="slds-listbox__option-header" role="presentation">
        {props.name}
      </h3>
    ) : (
      <span className="slds-media__body">
        <span className="slds-listbox__option-text slds-listbox__option-text_entity">
          {props.term ? (
            <span>
              {props.beforeTerm}
              <mark>{props.term}</mark>
              {props.afterTerm}
            </span>
          ) : (
            props.name
          )}
        </span>
        {props.entityMeta && (
          <span
            className={classNames(
              'slds-listbox__option-meta slds-listbox__option-meta_entity',
              {
                'slds-listbox__option-meta-disabled': props.isDisabled
              }
            )}
          >
            {props.entityType || 'Account'} &bull;{' '}
            {props.entityField || ' San Francisco'}
          </span>
        )}
      </span>
    )}
    {props.rightIcon && (
      <UtilityIcon
        className="slds-icon_x-small slds-icon-text-default"
        containerClassName="slds-align-middle"
        symbol={props.rightIcon.toLowerCase()}
        title={props.rightIconAssistiveText}
        assistiveText={props.rightIconAssistiveText}
      />
    )}
  </ListboxOption>
);
 
/**
 * Typeahead term option
 */
export const TypeaheadTermOption = props => (
  <ListboxOption
    type="entity"
    id="option0"
    focused={props.focused}
    tabIndex={props.tabIndex}
    isDisabled={props.isDisabled}
    className={classNames(
      'slds-listbox__option_term',
      props.focused && 'slds-has-focus'
    )}
  >
    <span className="slds-media__figure slds-listbox__option-icon">
      <UtilityIcon
        className="slds-icon_x-small slds-icon-text-default"
        symbol="search"
        assistiveText="Search for term: "
        title="Search for term: "
      />
    </span>
    <span className="slds-media__body">
      <span className="slds-listbox__option-text slds-listbox__option-text_entity">
        {props.term}
      </span>
    </span>
  </ListboxOption>
);
 
/**
 * Plain Option
 */
export const Option = props => (
  <ListboxOption
    focusedRef={props.focusedRef}
    type="plain"
    id={props.id}
    label={props.label}
    focused={props.focused}
    isDisabled={props.isDisabled}
    selected={props.selected}
    className={classNames(
      'slds-media_small',
      {
        'slds-is-selected': props.selected,
        'slds-has-focus': props.focused,
        'slds-listbox__option_has-meta': props.meta
      },
      props.className
    )}
  >
    {!props.label && !props.hideIcons && (
      <span className="slds-media__figure slds-listbox__option-icon">
        {(props.selected || props.icon) && (
          <UtilityIcon
            assistiveText={false}
            className="slds-icon_x-small"
            containerClassName="slds-current-color"
            symbol={props.icon || 'check'}
            title={false}
          />
        )}
      </span>
    )}
    {props.label ? (
      <h3 className="slds-listbox__option-header" role="presentation">
        {props.name}
      </h3>
    ) : (
      <span className="slds-media__body">
        <span
          className={classNames({
            'slds-m-bottom_xxx-small': props.plainMeta
          })}
          title={
            props.term
              ? `${props.beforeTerm}${props.term}${props.afterTerm}`
              : props.name
          }
        >
          {props.term ? (
            <span>
              {props.beforeTerm}
              <mark>{props.term}</mark>
              {props.afterTerm}
            </span>
          ) : (
            props.name
          )}
        </span>
        {props.meta && (
          <span
            className={classNames('slds-listbox__option-meta', {
              'slds-listbox__option-meta-disabled': props.isDisabled
            })}
          >
            {props.meta}
          </span>
        )}
      </span>
    )}
  </ListboxOption>
);
 
export class Listbox extends Component {
  constructor() {
    super();
    this.renderEntityOptions = this.renderEntityOptions.bind(this);
    this.renderPlainOptions = this.renderPlainOptions.bind(this);
  }
 
  renderEntityOptions(key) {
    const option = this.props.snapshot[key];
    return (
      <ListboxItem key={key}>
        <EntityOption
          id={_.uniqueId('option') || key}
          tabIndex={option.tabIndex}
          selected={option.selected}
          focused={option.focused}
          // False boolean translate to string "false", so we have to pass in null to prevent ref from erroring
          focusedRef={option.focused ? this.props.focusedRef : null}
          name={option.name}
          label={option.label}
          entityMeta={option.entityMeta}
          entityType={option.entityType}
          entityField={option.entityField}
          term={option.term}
          beforeTerm={option.beforeTerm}
          afterTerm={option.afterTerm}
          rightIcon={option.rightIcon}
          rightIconAssistiveText={option.rightIconAssistiveText}
          isDisabled={option.isDisabled}
        />
      </ListboxItem>
    );
  }
 
  renderPlainOptions(key) {
    const option = this.props.snapshot[key];
    return (
      <ListboxItem key={key}>
        <Option
          id={_.uniqueId('option') || key}
          name={option.name}
          selected={option.selected}
          focused={option.focused}
          // False boolean translate to string "false", so we have to pass in null to prevent ref from erroring
          focusedRef={option.focused ? this.props.focusedRef : null}
          tabIndex={option.tabIndex}
          visualSelection={this.props.visualSelection}
          term={option.term}
          label={option.label}
          beforeTerm={option.beforeTerm}
          afterTerm={option.afterTerm}
          icon={option.icon}
          meta={option.meta}
          isDisabled={option.isDisabled}
          hideIcons={this.props.hideIcons}
        />
      </ListboxItem>
    );
  }
 
  render() {
    const {
      id,
      term,
      type,
      snapshot,
      loading,
      count = 1,
      className = 'slds-dropdown_fluid',
      staticListbox
    } = this.props;
    return (
      <ListboxWrapper
        id={id}
        ariaLabel='{{Placeholder for Dropdown Items}}'
        className={classNames(
          { 'slds-dropdown': !staticListbox },
          type === 'entity'
            ? 'slds-dropdown_length-with-icon-7'
            : 'slds-dropdown_length-5',
          className
        )}
        ariaBusy={loading ? "true":"false"}
      >
        <ListboxList vertical aria-label={this.props['aria-label']}>
          {term && type === 'entity' ? (
            <ListboxItem>
              <TypeaheadTermOption term={term} focused />
            </ListboxItem>
          ) : null}
          {type === 'entity'
            ? Object.keys(snapshot)
                .slice(0, count)
                .map(this.renderEntityOptions)
            : Object.keys(snapshot)
                .slice(0, count)
                .map(this.renderPlainOptions)}
          {loading && (
            <ListboxItem isLoadingSpinner>
              <div className="slds-align_absolute-center slds-p-top_medium">
                <Spinner className="slds-spinner_x-small slds-spinner_inline" />
              </div>
            </ListboxItem>
          )}
        </ListboxList>
      </ListboxWrapper>
    );
  }
}
 
Listbox.propTypes = {
  id: PropTypes.string,
  term: PropTypes.string,
  type: PropTypes.oneOf(['entity', 'plain']).isRequired,
  snapshot: PropTypes.object.isRequired,
  count: PropTypes.number,
  meta: PropTypes.string,
  icon: PropTypes.string,
  staticListbox: PropTypes.bool
};
 
export default Listbox;
 
export class ListboxGroup extends Component {
  constructor() {
    super();
    this.renderEntityOptions = this.renderEntityOptions.bind(this);
    this.renderPlainOptions = this.renderPlainOptions.bind(this);
  }
 
  renderEntityOptions(key) {
    const option = this.props.snapshot[key];
    return (
      <ListboxItem key={key}>
        <EntityOption
          id={_.uniqueId('option')}
          tabIndex={option.tabIndex}
          selected={option.selected}
          focused={option.focused}
          name={option.name}
          entityMeta={option.entityMeta}
          entityType={option.entityType}
          entityLocation={option.entityLocation}
          term={option.term}
          label={option.label}
          rightIcon={option.rightIcon}
        />
      </ListboxItem>
    );
  }
 
  renderPlainOptions(key) {
    const option = this.props.snapshot[key];
    return (
      <ListboxItem key={key}>
        <Option id={key} name={option.name} label={option.label} />
      </ListboxItem>
    );
  }
 
  render() {
    const { snapshot, count = 1, type } = this.props;
    return (
      <ListboxList vertical aria-label={this.props['aria-label']}>
        {type === 'entity'
          ? Object.keys(snapshot)
              .slice(0, count)
              .map(this.renderEntityOptions)
          : Object.keys(snapshot)
              .slice(0, count)
              .map(this.renderPlainOptions)}
      </ListboxList>
    );
  }
}
 
ListboxGroup.propTypes = {
  'aria-label': PropTypes.string.isRequired,
  snapshot: PropTypes.object.isRequired,
  count: PropTypes.number
};