All files / packages/design-system/ui/components/rich-text-editor index.jsx

97.36% Statements 37/38
65.9% Branches 29/44
90.9% Functions 10/11
97.36% Lines 37/38

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                                          3x           3x 8x                                         3x                 3x 8x                           2x 2x 2x 2x 2x   2x                                                                                                                                                                                                                             3x 2x                   3x           2x                       3x           3x 2x 2x 2x   2x                                                                                                                                     3x 5x                                                                                       3x 2x                                                                                         3x 5x                                                                               3x 2x                                                             3x 2x                                                                         3x                           3x 4x                                 3x 9x                                                                  
import React, { useState } from 'react';
import { ButtonGroupList } from '../button-groups/list/example';
import PropTypes from 'prop-types';
import ButtonIcon from '../button-icons/';
import SvgIcon from '../../shared/svg-icon';
import Combobox from '../combobox';
import {
  PlainFontOptions,
  PlainFontSizeOptions
} from '../combobox/snapshots.data';
import Listbox from '../combobox/listbox/';
import { Listbox as NewListbox } from '../combobox/listbox';
import { ComboboxGroup } from '../combobox/';
import { IconObjectSwitcher } from '../combobox/object-switcher/';
import { UtilityIcon } from '../icons/base/example';
import * as Snapshot from '../combobox/snapshots.data';
import { FormElement } from '../form-element';
import Input from '../input/';
import classNames from 'classnames';
import _ from '../../shared/helpers';
 
export const richTextEditorLabelId01 = 'rich-text-editor-unique-id-01';
 
/// ////////////////////////////////////////
// Partial(s)
/// ////////////////////////////////////////
 
export let RichTextEditor = props => (
  <FormElement
    labelId={props.labelId}
    labelContent={props.label}
    inlineMessage={props.inlineMessage}
    hasError={props.hasError}
    errorId={props.errorId}
    hasFauxLabel
  >
    <div
      className={classNames(
        'slds-rich-text-editor slds-grid slds-grid_vertical slds-nowrap',
        props.isToolbarOnly && 'slds-rich-text-editor_toolbar-only',
        props.className
        )}
      aria-label={props.disabledLabel}
    >
      {props.children}
    </div>
  </FormElement>
);
 
RichTextEditor.propTypes = {
  children: PropTypes.node.isRequired,
  errorId: PropTypes.string,
  hasError: PropTypes.bool,
  inlineMessage: PropTypes.string,
  labelContent: PropTypes.string,
  labelId: PropTypes.string
};
 
export let RteToolbar = props => (
  <div
    role="toolbar"
    aria-label={props.disabledLabel}
    className={classNames(
      'slds-rich-text-editor__toolbar slds-shrink-none',
      props.isToolbarOnly && 'slds-rich-text-editor__toolbar_detached',
      props.className
    )}
  >
    {props.children}
  </div>
);
 
export const RteFormula = props => {
  const [listboxId1] = useState(_.uniqueId('example-unique-id-'));
  const [listboxId2] = useState(_.uniqueId('example-unique-id-'));
  const [primaryComboboxId1] = useState(_.uniqueId('example-unique-id-'));
  const [primaryComboboxId2] = useState(_.uniqueId('example-unique-id-'));
  const [inputId] = useState(_.uniqueId('example-unique-id-'));
 
  return (
    <React.Fragment>
      <div className="slds-rich-text-editor__col slds-rich-text-editor__col_grow">
        <ComboboxGroup
          id={_.uniqueId('combobox-id-')}
          aria-controls={listboxId1}
          comboboxID={primaryComboboxId1}
          autocomplete
          results={
            <NewListbox
              id={listboxId1}
              snapshot={Snapshot.EntityOptions}
              type="entity"
              count={2}
              hasUniqueId
            />
          }
          resultsType="listbox"
          addon={
            <IconObjectSwitcher
              id={_.uniqueId('combobox-id-')}
              listboxId={_.uniqueId('objectswitcher-listbox-id-')}
              value="Apex"
              label="Filter resources by:"
              filteredSymbol="apex"
              addonPosition="start"
              comboboxAriaControls={primaryComboboxId1}
            />
          }
          addonPosition="start"
          comboboxPosition="end"
          inputIconPosition="right"
          placeholder="Insert a resource"
          hideLabel
          label="Insert a Resource"
          rightInputIcon={
            <UtilityIcon
              symbol="search"
              className="slds-icon slds-icon_x-small slds-icon-text-default"
              containerClassName="slds-input__icon slds-input__icon_right"
              assistiveText={false}
              title={false}
            />
          }
        />
      </div>
      <div className="slds-rich-text-editor__col slds-rich-text-editor__col_grow">
        <ComboboxGroup
          id={_.uniqueId('combobox-id-')}
          aria-controls={listboxId2}
          comboboxID={primaryComboboxId2}
          autocomplete
          results={
            <NewListbox
              id={listboxId2}
              snapshot={Snapshot.EntityOptions}
              type="entity"
              count={2}
              hasUniqueId
            />
          }
          resultsType="listbox"
          addon={
            <IconObjectSwitcher
              id={_.uniqueId('combobox-id-')}
              listboxId={_.uniqueId('objectswitcher-listbox-id-')}
              value="Apex"
              label="Filter functions by:"
              filteredSymbol="apex"
              addonPosition="start"
              comboboxAriaControls={primaryComboboxId2}
            />
          }
          addonPosition="start"
          comboboxPosition="end"
          inputIconPosition="right"
          placeholder="Insert a function"
          hideLabel
          label="Insert a function"
          rightInputIcon={
            <UtilityIcon
              symbol="search"
              className="slds-icon slds-icon_x-small slds-icon-text-default"
              containerClassName="slds-input__icon slds-input__icon_right"
              assistiveText={false}
              title={false}
            />
          }
        />
      </div>
      <div className="slds-rich-text-editor__col slds-rich-text-editor__col_grow">
        <FormElement
          hasHiddenLabel
          labelContent="Insert operator"
          inputId={inputId}
        >
          <Input id={inputId} placeholder="Insert operator" />
        </FormElement>
      </div>
      <div className="slds-rich-text-editor__col">
        <ButtonIcon
          symbol="help"
          assistiveText="Help"
          title="Help"
          size="medium"
        />
      </div>
    </React.Fragment>
  );
};
 
export const FontFamilyDropdown = ({ listboxData, id }) => (
  <Listbox
    id={id}
    snapshot={listboxData}
    type="plain"
    count={3}
    hideIcons
    className="slds-dropdown_fluid slds-dropdown_left"
  />
);
 
FontFamilyDropdown.propTypes = {
  listboxData: PropTypes.object.isRequired,
  id: PropTypes.string
};
 
const FontSizeDropdown = ({ listboxData, id }) => {
  return (
    <Listbox
      id={id}
      snapshot={listboxData}
      type="plain"
      count={6}
      hideIcons
      className="slds-dropdown_fluid slds-dropdown_left"
    />
  );
};
 
FontSizeDropdown.propTypes = {
  listboxData: PropTypes.object.isRequired,
  id: PropTypes.string
};
 
export let RteFormatFont = props => {
  const [comboboxId] = useState(_.uniqueId('example-unique-id-'));
  const [listboxId] = useState(_.uniqueId('example-unique-id-'));
  const [comboboxId2] = useState(_.uniqueId('example-unique-id-'));
  const [listboxId2] = useState(_.uniqueId('example-unique-id-'));
 
  return (
    <div
      className="slds-grid slds-rich-text-editor__spacing-wrapper"
      role="group"
      aria-label="Format font family &amp; size"
    >
      <div className="slds-rich-text-editor__select">
        <Combobox
          id={comboboxId}
          aria-controls={listboxId}
          label="Choose a Font"
          hideLabel
          inputContainerClassName="slds-rich-text-editor__select_x-small"
          inputIconPosition="right"
          rightInputIcon={
            <UtilityIcon
              symbol="down"
              className="slds-icon slds-icon_x-small slds-icon-text-default"
              containerClassName="slds-input__icon slds-input__icon_right"
              assistiveText={false}
              title={false}
            />
          }
          results={
            <FontFamilyDropdown listboxData={PlainFontOptions} id={listboxId} />
          }
          resultsType="listbox"
          hasInteractions
          selectOnly
          value="Font"
        />
      </div>
 
      <div className="slds-rich-text-editor__select">
        <Combobox
          id={comboboxId2}
          aria-controls={listboxId2}
          label="Choose a Font Size"
          hideLabel
          inputContainerClassName="slds-rich-text-editor__select_xx-small"
          inputIconPosition="right"
          rightInputIcon={
            <UtilityIcon
              symbol="down"
              className="slds-icon slds-icon_x-small slds-icon-text-default"
              containerClassName="slds-input__icon slds-input__icon_right"
              assistiveText={false}
              title={false}
            />
          }
          results={
            <FontSizeDropdown
              listboxData={PlainFontSizeOptions}
              id={listboxId2}
            />
          }
          resultsType="listbox"
          hasInteractions
          selectOnly
          value="Size"
          tabIndex="-1"
        />
      </div>
    </div>
  );
};
 
export let RteFormatText = props => (
  <ButtonGroupList aria-label="Format text">
    <li>
      <ButtonIcon
        className="slds-button_icon-border-filled"
        symbol="bold"
        tabIndex={props.tabIndexSetting}
        aria-describedby={props.hasTooltip ? 'bold' : null}
        disabled={props.disabledButtons}
        assistiveText="Bold"
      />
    </li>
 
    <li>
      <ButtonIcon
        tabIndex="-1"
        className="slds-button_icon-border-filled"
        symbol="italic"
        disabled={props.disabledButtons}
        assistiveText="Italic"
      />
    </li>
 
    <li>
      <ButtonIcon
        tabIndex="-1"
        className="slds-button_icon-border-filled"
        symbol="underline"
        disabled={props.disabledButtons}
        assistiveText="Underline"
      />
    </li>
 
    <li>
      <ButtonIcon
        tabIndex="-1"
        className="slds-button_icon-border-filled"
        symbol="strikethrough"
        disabled={props.disabledButtons}
        assistiveText="Strike Through"
      />
    </li>
  </ButtonGroupList>
);
 
export let RteFormatColor = props => (
  <ButtonGroupList aria-label="Format background & text color">
    <li>
      <button
        tabIndex="-1"
        disabled={props.disabledButtons}
        className="slds-button slds-button_icon slds-button_icon-more slds-button_icon-more-filled"
        aria-haspopup="true"
      >
        <SvgIcon
          className="slds-button__icon"
          sprite="utility"
          symbol="text_background_color"
        />
        <SvgIcon
          className="slds-button__icon slds-button__icon_x-small"
          sprite="utility"
          symbol="down"
        />
        <span className="slds-assistive-text">Background Color</span>
      </button>
    </li>
 
    <li>
      <button
        tabIndex="-1"
        disabled={props.disabledButtons}
        className="slds-button slds-button_icon slds-button_icon-more slds-button_icon-more-filled"
        aria-haspopup="true"
      >
        <SvgIcon
          className="slds-button__icon"
          sprite="utility"
          symbol="text_color"
        />
        <SvgIcon
          className="slds-button__icon slds-button__icon_x-small"
          sprite="utility"
          symbol="down"
        />
        <span className="slds-assistive-text">Text Color</span>
      </button>
    </li>
  </ButtonGroupList>
);
 
export let RteFormatBody = props => (
  <ButtonGroupList aria-label="Format body">
    <li>
      <ButtonIcon
        tabIndex="-1"
        className="slds-button_icon-border-filled"
        symbol="richtextbulletedlist"
        disabled={props.disabledButtons}
        assistiveText="Bulleted List"
      />
    </li>
    <li>
      <ButtonIcon
        tabIndex="-1"
        className="slds-button_icon-border-filled"
        symbol="richtextnumberedlist"
        disabled={props.disabledButtons}
        assistiveText="Numbered List"
      />
    </li>
    <li>
      <ButtonIcon
        tabIndex="-1"
        className="slds-button_icon-border-filled"
        symbol="richtextindent"
        disabled={props.disabledButtons}
        assistiveText="Indent"
      />
    </li>
    <li>
      <ButtonIcon
        tabIndex="-1"
        className="slds-button_icon-border-filled"
        symbol="richtextoutdent"
        disabled={props.disabledButtons}
        assistiveText="Outdent"
      />
    </li>
  </ButtonGroupList>
);
 
export let RteAlignText = props => (
  <ButtonGroupList aria-label="Align text">
    <li>
      <ButtonIcon
        tabIndex="-1"
        className="slds-button_icon-border-filled"
        symbol="left_align_text"
        disabled={props.disabledButtons}
        assistiveText="Left Align Text"
      />
    </li>
    <li>
      <ButtonIcon
        tabIndex="-1"
        className="slds-button_icon-border-filled"
        symbol="center_align_text"
        disabled={props.disabledButtons}
        assistiveText="Center Align Text"
      />
    </li>
    <li>
      <ButtonIcon
        tabIndex="-1"
        className="slds-button_icon-border-filled"
        symbol="right_align_text"
        disabled={props.disabledButtons}
        assistiveText="Right Align Text"
      />
    </li>
  </ButtonGroupList>
);
 
export let RteInsertContent = props => (
  <ButtonGroupList
    role={props.overflow ? 'presentation' : null}
    aria-label={!props.overflow ? 'Insert content' : null}
  >
    <li role={props.overflow ? 'presentation' : null}>
      <ButtonIcon
        role={props.overflow ? 'menuitem' : null}
        tabIndex="-1"
        className="slds-button_icon-border-filled"
        symbol="emoji"
        disabled={props.disabledButtons}
        assistiveText="Add Emoji"
      />
    </li>
    <li role={props.overflow ? 'presentation' : null}>
      <ButtonIcon
        role={props.overflow ? 'menuitem' : null}
        tabIndex="-1"
        className="slds-button_icon-border-filled"
        symbol="image"
        disabled={props.disabledButtons}
        assistiveText="Add Image"
      />
    </li>
    <li role={props.overflow ? 'presentation' : null}>
      <ButtonIcon
        role={props.overflow ? 'menuitem' : null}
        tabIndex="-1"
        className="slds-button_icon-border-filled"
        symbol="link"
        disabled={props.disabledButtons}
        assistiveText="Add Link"
      />
    </li>
  </ButtonGroupList>
);
 
export let RteInsertUser = props => (
  <ButtonGroupList aria-label="Add user">
    <li>
      <ButtonIcon
        tabIndex="-1"
        className="slds-button_icon-border-filled"
        symbol="adduser"
        disabled={props.disabledButtons}
        assistiveText="Add User"
      />
    </li>
  </ButtonGroupList>
);
 
export let RteClearFormatting = props => (
  <ButtonGroupList
    role={props.overflow ? 'presentation' : null}
    aria-label={!props.overflow ? 'Remove Formatting' : null}
  >
    <li role={props.overflow ? 'presentation' : null}>
      <ButtonIcon
        role={props.overflow ? 'menuitem' : null}
        tabIndex="-1"
        className="slds-button_icon-border-filled"
        symbol="remove_formatting"
        disabled={props.disabledButtons}
        assistiveText="Remove Formatting"
      />
    </li>
  </ButtonGroupList>
);
 
export let RteTextarea = props => (
  <div
    className={classNames(
      props.text
        ? 'slds-rich-text-editor__output'
        : 'slds-rich-text-editor__textarea',
      'slds-grid'
    )}
  >
    {props.text ? (
      <div
        aria-describedby={props['aria-describedby']}
        aria-label={!props.labelId ? 'Compose text' : null}
        aria-labelledby={props.labelId}
        contentEditable={!props.disabled ? 'true' : null}
        suppressContentEditableWarning
        className="slds-rich-text-area__content slds-grow"
      >
        {props.text}
      </div>
    ) : (
      <div
        aria-describedby={props['aria-describedby']}
        aria-label={!props.labelId ? props.label || 'Compose text' : null}
        aria-labelledby={props.labelId}
        contentEditable={!props.disabled ? 'true' : null}
        suppressContentEditableWarning
        className="slds-rich-text-area__content slds-text-color_weak slds-grow"
      >
        {props.placeholder}
      </div>
    )}
  </div>
);