@instructure/ui-truncate-text 10.11.0 → 10.11.1-snapshot-2

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [10.11.1-snapshot-2](https://github.com/instructure/instructure-ui/compare/v10.11.0...v10.11.1-snapshot-2) (2025-02-05)
+
+**Note:** Version bump only for package @instructure/ui-truncate-text
+
+
+
+
+
 # [10.11.0](https://github.com/instructure/instructure-ui/compare/v10.10.0...v10.11.0) (2025-02-03)
 
 **Note:** Version bump only for package @instructure/ui-truncate-text

package/es/TruncateText/__new-tests__/TruncateText.test.js

@@ -0,0 +1,75 @@
+var _TruncateText, _TruncateText2, _TruncateText3, _TruncateText4, _TruncateText5;
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2015 - present Instructure, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+import React from 'react';
+import { render, waitFor } from '@testing-library/react';
+import { vi, expect } from 'vitest';
+import '@testing-library/jest-dom';
+import { runAxeCheck } from '@instructure/ui-axe-check';
+import { TruncateText } from '../index';
+const defaultText = 'Hello world! This is a long string that should truncate';
+describe('<TruncateText />', () => {
+  let consoleErrorMock;
+  beforeEach(() => {
+    // Mocking console to prevent test output pollution and expect for messages
+    consoleErrorMock = vi.spyOn(console, 'error').mockImplementation(() => {});
+  });
+  afterEach(() => {
+    consoleErrorMock.mockRestore();
+  });
+  it('should warn if children prop receives too deep of a node tree', async () => {
+    render(/*#__PURE__*/React.createElement("div", {
+      style: {
+        width: '200px'
+      }
+    }, _TruncateText || (_TruncateText = /*#__PURE__*/React.createElement(TruncateText, null, "Hello world!", ' ', /*#__PURE__*/React.createElement("strong", null, /*#__PURE__*/React.createElement("span", null, "This is a")), ' ', "long string that should truncate"))));
+    const expectedErrorMessage = 'Some children are too deep in the node tree and will not render.';
+    await waitFor(() => {
+      expect(consoleErrorMock).toHaveBeenCalledWith(expect.stringContaining(expectedErrorMessage), expect.any(String));
+    });
+  });
+  it('should handle the empty string as a child', async () => {
+    let error = false;
+    try {
+      const _render = render(_TruncateText2 || (_TruncateText2 = /*#__PURE__*/React.createElement(TruncateText, null, ''))),
+        rerender = _render.rerender;
+      rerender(_TruncateText3 || (_TruncateText3 = /*#__PURE__*/React.createElement(TruncateText, null, 'hello world')));
+      rerender(_TruncateText4 || (_TruncateText4 = /*#__PURE__*/React.createElement(TruncateText, null, '')));
+    } catch (_e) {
+      error = true;
+    }
+    expect(error).toBe(false);
+  });
+  it('should meet a11y standards', async () => {
+    const _render2 = render(/*#__PURE__*/React.createElement("div", {
+        style: {
+          width: '200px'
+        }
+      }, _TruncateText5 || (_TruncateText5 = /*#__PURE__*/React.createElement(TruncateText, null, defaultText)))),
+      container = _render2.container;
+    const axeCheck = await runAxeCheck(container);
+    expect(axeCheck).toBe(true);
+  });
+});

package/es/TruncateText/utils/__new-tests__/cleanData.test.js

@@ -0,0 +1,108 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2015 - present Instructure, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+import { expect } from 'chai';
+import '@testing-library/jest-dom';
+import cleanData from '../cleanData';
+describe('cleanData', () => {
+  it('should remove spaces from the end of character data', async () => {
+    const data = [['T', 'e', 's', 't', ' ', '...']];
+    const options = {
+      truncate: 'character',
+      ellipsis: '...',
+      ignore: [' ']
+    };
+    const newData = cleanData(data, options);
+    expect(newData[0].join('')).to.equal('Test...');
+  });
+  it('should remove spaces from the end of word data', async () => {
+    const data = [['Test ', '...']];
+    const options = {
+      truncate: 'word',
+      ellipsis: '...',
+      ignore: [' ']
+    };
+    const newData = cleanData(data, options);
+    expect(newData[0].join('')).to.equal('Test...');
+  });
+  it('should remove spaces from the middle of character data', async () => {
+    const data = [['H', 'e', 'l', 'l', 'o', ' ', '...', ' ', 'w', 'o', 'r', 'l', 'd']];
+    const options = {
+      truncate: 'character',
+      ellipsis: '...',
+      ignore: [' ']
+    };
+    const newData = cleanData(data, options);
+    expect(newData[0].join('')).to.equal('Hello...world');
+  });
+  it('should remove spaces from the middle of word data', async () => {
+    const data = [['Hello ', '...', 'world']];
+    const options = {
+      truncate: 'word',
+      ellipsis: '...',
+      ignore: [' ']
+    };
+    const newData = cleanData(data, options);
+    expect(newData[0].join('')).to.equal('Hello...world');
+  });
+  it('should do a thorough cleaning', async () => {
+    const data = [['T', 'e', 's', 't', '.', ' ', '...']];
+    const options = {
+      truncate: 'character',
+      ellipsis: '...',
+      ignore: [' ', '.']
+    };
+    const newData = cleanData(data, options, true);
+    expect(newData[0].join('')).to.equal('Test...');
+  });
+  it('should remove spaces from the end of complex character data', async () => {
+    let data = [['H', 'e', 'l', 'l', 'o', ' '], ['...']];
+    const options = {
+      truncate: 'character',
+      ellipsis: '...',
+      ignore: [' ']
+    };
+    let newData = cleanData(data, options);
+    const text = newData[0].join('') + newData[1].join('');
+    data = [['H', 'e', 'l', 'l', 'o', ' '], ['w', 'o', 'r', 'l', 'd', ' ', '...']];
+    newData = cleanData(data, options);
+    const text2 = newData[0].join('') + newData[1].join('');
+    expect(text).to.equal('Hello...');
+    expect(text2).to.equal('Hello world...');
+  });
+  it('should remove spaces from the middle of complex word data', async () => {
+    let data = [['Hello ', '...'], ['world']];
+    const options = {
+      truncate: 'word',
+      ellipsis: '...',
+      ignore: [' ']
+    };
+    let newData = cleanData(data, options);
+    const text = newData[0].join('') + newData[1].join('');
+    data = [['Hello '], ['...', 'world']];
+    newData = cleanData(data, options);
+    const text2 = newData[0].join('') + newData[1].join('');
+    expect(text).to.equal('Hello...world');
+    expect(text2).to.equal('Hello...world');
+  });
+});

package/es/TruncateText/utils/__new-tests__/cleanString.test.js

@@ -0,0 +1,49 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2015 - present Instructure, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+import { expect } from 'chai';
+import '@testing-library/jest-dom';
+import cleanString from '../cleanString';
+describe('cleanSring', () => {
+  it('should remove spaces from start and end of string', async () => {
+    const string = ' Hello world ';
+    const newString = cleanString(string, [' ']);
+    expect(newString).to.equal('Hello world');
+  });
+  it('should remove spaces from only the end of string', async () => {
+    const string = ' Hello world ';
+    const newString = cleanString(string, [' '], false);
+    expect(newString).to.equal(' Hello world');
+  });
+  it('should remove spaces and commas', async () => {
+    const string = ' Hello world,';
+    const newString = cleanString(string, [' ', ',']);
+    expect(newString).to.equal('Hello world');
+  });
+  it('should do a thorough cleaning', async () => {
+    const string = 'Hello world. ';
+    const newString = cleanString(string, [' ', '.'], false, true, true);
+    expect(newString).to.equal('Hello world');
+  });
+});

package/es/TruncateText/utils/__new-tests__/measureText.test.js

@@ -0,0 +1,148 @@
+var _div, _div2, _div3, _div4;
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2015 - present Instructure, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+import React from 'react';
+import { render, screen } from '@testing-library/react';
+import { vi, expect } from 'vitest';
+import '@testing-library/jest-dom';
+import measureText from '../measureText';
+const baseStyle = {
+  fontSize: '16px',
+  fontFamily: 'Arial',
+  fontWeight: 'normal',
+  fontStyle: 'normal',
+  letterSpacing: 'normal'
+};
+const getNodes = root => Array.from(root.childNodes).filter(node => node.nodeType === Node.ELEMENT_NODE || node.nodeType === Node.TEXT_NODE);
+describe('measureText', () => {
+  beforeEach(() => {
+    vi.spyOn(HTMLCanvasElement.prototype, 'getContext').mockImplementation(() => {
+      return {
+        font: '',
+        measureText: vi.fn(text => {
+          return {
+            width: text.length * 10
+          };
+        })
+      };
+    });
+  });
+  afterEach(() => {
+    vi.restoreAllMocks();
+  });
+  it('should calculate the width of a single text node correctly', () => {
+    const node = document.createElement('div');
+    Object.assign(node.style, baseStyle);
+    node.textContent = 'Hello';
+    const width = measureText([node]);
+    expect(width).toBe(50); // 5 characters * 10 (mocked width per character)
+  });
+  it('should return zero for empty nodes', () => {
+    const node = document.createElement('div');
+    Object.assign(node.style, baseStyle);
+    node.textContent = '';
+    const width = measureText([node]);
+    expect(width).toBe(0);
+  });
+  it('should calculate text width correctly', () => {
+    render(_div || (_div = /*#__PURE__*/React.createElement("div", {
+      "data-testid": "stage",
+      style: baseStyle
+    }, "Lorem ipsum ", /*#__PURE__*/React.createElement("span", {
+      style: baseStyle
+    }, "DOLOR SIT AMET."))));
+    const stage = screen.getByTestId('stage');
+    const nodes = getNodes(stage);
+    const width = measureText(nodes, stage);
+    expect(width).toBe(270);
+  });
+  it('should account for different nodes', async () => {
+    const _render = render(_div2 || (_div2 = /*#__PURE__*/React.createElement("div", {
+        "data-testid": "stage",
+        style: baseStyle
+      }, "Lorem ipsum ", /*#__PURE__*/React.createElement("span", {
+        style: baseStyle
+      }, "DOLOR SIT AMET.")))),
+      rerender = _render.rerender;
+    const stage = screen.getByTestId('stage');
+    const nodes = getNodes(stage);
+    const width = measureText(nodes, stage);
+
+    // Set child
+    rerender(_div3 || (_div3 = /*#__PURE__*/React.createElement("div", {
+      "data-testid": "stage",
+      style: baseStyle
+    }, "Lorem ipsum DOLOR SIT AMET.")));
+    const stage2 = screen.getByTestId('stage');
+    const nodes2 = getNodes(stage2);
+    const width2 = measureText(nodes2, stage2);
+    expect(width).toEqual(width2);
+  });
+  it('should call measureText on a properly configured canvas 2d context', () => {
+    const mockedStyle = {
+      fontSize: '20px',
+      fontWeight: 'bold',
+      fontStyle: 'italic',
+      fontFamily: 'Arial'
+    };
+    render(/*#__PURE__*/React.createElement("div", {
+      "data-testid": "stage",
+      style: mockedStyle
+    }, "Lorem ipsum"));
+    const stage = screen.getByTestId('stage');
+    const nodes = getNodes(stage);
+    measureText(nodes, stage);
+
+    // The width calculation depends on the modified canvas context
+    const getContextSpy = HTMLCanvasElement.prototype.getContext;
+    const context = getContextSpy.mock.results[0].value;
+    expect(context.measureText).toHaveBeenCalledTimes(1);
+    expect(context.font).toBe('bold italic 20px Arial');
+  });
+  it('should account for letter spacing styles', async () => {
+    const _render2 = render(_div4 || (_div4 = /*#__PURE__*/React.createElement("div", {
+        "data-testid": "stage",
+        style: baseStyle
+      }, "Lorem ipsum"))),
+      rerender = _render2.rerender;
+    const stage = screen.getByTestId('stage');
+    const nodes = getNodes(stage);
+    const width = measureText(nodes, stage);
+    expect(width).toBe(110); // default mocked width (text.length * 10)
+
+    // Set letterSpacing
+    rerender(/*#__PURE__*/React.createElement("div", {
+      "data-testid": "stage2",
+      style: {
+        ...baseStyle,
+        letterSpacing: '5px'
+      }
+    }, "Lorem ipsum"));
+    const stage2 = screen.getByTestId('stage2');
+    const nodes2 = getNodes(stage2);
+    const width2 = measureText(nodes2, stage2);
+    expect(width2).toBe(165); // default mocked width + letterOffset (text.length * letterSpacing)
+  });
+});

package/lib/TruncateText/__new-tests__/TruncateText.test.js

@@ -0,0 +1,77 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+var _react = _interopRequireDefault(require("react"));
+var _react2 = require("@testing-library/react");
+var _vitest = require("vitest");
+require("@testing-library/jest-dom");
+var _runAxeCheck = require("@instructure/ui-axe-check/lib/runAxeCheck.js");
+var _index = require("../index");
+var _TruncateText, _TruncateText2, _TruncateText3, _TruncateText4, _TruncateText5;
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2015 - present Instructure, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+const defaultText = 'Hello world! This is a long string that should truncate';
+describe('<TruncateText />', () => {
+  let consoleErrorMock;
+  beforeEach(() => {
+    // Mocking console to prevent test output pollution and expect for messages
+    consoleErrorMock = _vitest.vi.spyOn(console, 'error').mockImplementation(() => {});
+  });
+  afterEach(() => {
+    consoleErrorMock.mockRestore();
+  });
+  it('should warn if children prop receives too deep of a node tree', async () => {
+    (0, _react2.render)(/*#__PURE__*/_react.default.createElement("div", {
+      style: {
+        width: '200px'
+      }
+    }, _TruncateText || (_TruncateText = /*#__PURE__*/_react.default.createElement(_index.TruncateText, null, "Hello world!", ' ', /*#__PURE__*/_react.default.createElement("strong", null, /*#__PURE__*/_react.default.createElement("span", null, "This is a")), ' ', "long string that should truncate"))));
+    const expectedErrorMessage = 'Some children are too deep in the node tree and will not render.';
+    await (0, _react2.waitFor)(() => {
+      (0, _vitest.expect)(consoleErrorMock).toHaveBeenCalledWith(_vitest.expect.stringContaining(expectedErrorMessage), _vitest.expect.any(String));
+    });
+  });
+  it('should handle the empty string as a child', async () => {
+    let error = false;
+    try {
+      const _render = (0, _react2.render)(_TruncateText2 || (_TruncateText2 = /*#__PURE__*/_react.default.createElement(_index.TruncateText, null, ''))),
+        rerender = _render.rerender;
+      rerender(_TruncateText3 || (_TruncateText3 = /*#__PURE__*/_react.default.createElement(_index.TruncateText, null, 'hello world')));
+      rerender(_TruncateText4 || (_TruncateText4 = /*#__PURE__*/_react.default.createElement(_index.TruncateText, null, '')));
+    } catch (_e) {
+      error = true;
+    }
+    (0, _vitest.expect)(error).toBe(false);
+  });
+  it('should meet a11y standards', async () => {
+    const _render2 = (0, _react2.render)(/*#__PURE__*/_react.default.createElement("div", {
+        style: {
+          width: '200px'
+        }
+      }, _TruncateText5 || (_TruncateText5 = /*#__PURE__*/_react.default.createElement(_index.TruncateText, null, defaultText)))),
+      container = _render2.container;
+    const axeCheck = await (0, _runAxeCheck.runAxeCheck)(container);
+    (0, _vitest.expect)(axeCheck).toBe(true);
+  });
+});

package/lib/TruncateText/utils/__new-tests__/cleanData.test.js

@@ -0,0 +1,112 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+var _chai = require("chai");
+require("@testing-library/jest-dom");
+var _cleanData = _interopRequireDefault(require("../cleanData"));
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2015 - present Instructure, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+describe('cleanData', () => {
+  it('should remove spaces from the end of character data', async () => {
+    const data = [['T', 'e', 's', 't', ' ', '...']];
+    const options = {
+      truncate: 'character',
+      ellipsis: '...',
+      ignore: [' ']
+    };
+    const newData = (0, _cleanData.default)(data, options);
+    (0, _chai.expect)(newData[0].join('')).to.equal('Test...');
+  });
+  it('should remove spaces from the end of word data', async () => {
+    const data = [['Test ', '...']];
+    const options = {
+      truncate: 'word',
+      ellipsis: '...',
+      ignore: [' ']
+    };
+    const newData = (0, _cleanData.default)(data, options);
+    (0, _chai.expect)(newData[0].join('')).to.equal('Test...');
+  });
+  it('should remove spaces from the middle of character data', async () => {
+    const data = [['H', 'e', 'l', 'l', 'o', ' ', '...', ' ', 'w', 'o', 'r', 'l', 'd']];
+    const options = {
+      truncate: 'character',
+      ellipsis: '...',
+      ignore: [' ']
+    };
+    const newData = (0, _cleanData.default)(data, options);
+    (0, _chai.expect)(newData[0].join('')).to.equal('Hello...world');
+  });
+  it('should remove spaces from the middle of word data', async () => {
+    const data = [['Hello ', '...', 'world']];
+    const options = {
+      truncate: 'word',
+      ellipsis: '...',
+      ignore: [' ']
+    };
+    const newData = (0, _cleanData.default)(data, options);
+    (0, _chai.expect)(newData[0].join('')).to.equal('Hello...world');
+  });
+  it('should do a thorough cleaning', async () => {
+    const data = [['T', 'e', 's', 't', '.', ' ', '...']];
+    const options = {
+      truncate: 'character',
+      ellipsis: '...',
+      ignore: [' ', '.']
+    };
+    const newData = (0, _cleanData.default)(data, options, true);
+    (0, _chai.expect)(newData[0].join('')).to.equal('Test...');
+  });
+  it('should remove spaces from the end of complex character data', async () => {
+    let data = [['H', 'e', 'l', 'l', 'o', ' '], ['...']];
+    const options = {
+      truncate: 'character',
+      ellipsis: '...',
+      ignore: [' ']
+    };
+    let newData = (0, _cleanData.default)(data, options);
+    const text = newData[0].join('') + newData[1].join('');
+    data = [['H', 'e', 'l', 'l', 'o', ' '], ['w', 'o', 'r', 'l', 'd', ' ', '...']];
+    newData = (0, _cleanData.default)(data, options);
+    const text2 = newData[0].join('') + newData[1].join('');
+    (0, _chai.expect)(text).to.equal('Hello...');
+    (0, _chai.expect)(text2).to.equal('Hello world...');
+  });
+  it('should remove spaces from the middle of complex word data', async () => {
+    let data = [['Hello ', '...'], ['world']];
+    const options = {
+      truncate: 'word',
+      ellipsis: '...',
+      ignore: [' ']
+    };
+    let newData = (0, _cleanData.default)(data, options);
+    const text = newData[0].join('') + newData[1].join('');
+    data = [['Hello '], ['...', 'world']];
+    newData = (0, _cleanData.default)(data, options);
+    const text2 = newData[0].join('') + newData[1].join('');
+    (0, _chai.expect)(text).to.equal('Hello...world');
+    (0, _chai.expect)(text2).to.equal('Hello...world');
+  });
+});

package/lib/TruncateText/utils/__new-tests__/cleanString.test.js

@@ -0,0 +1,52 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+var _chai = require("chai");
+require("@testing-library/jest-dom");
+var _cleanString = _interopRequireDefault(require("../cleanString"));
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2015 - present Instructure, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+describe('cleanSring', () => {
+  it('should remove spaces from start and end of string', async () => {
+    const string = ' Hello world ';
+    const newString = (0, _cleanString.default)(string, [' ']);
+    (0, _chai.expect)(newString).to.equal('Hello world');
+  });
+  it('should remove spaces from only the end of string', async () => {
+    const string = ' Hello world ';
+    const newString = (0, _cleanString.default)(string, [' '], false);
+    (0, _chai.expect)(newString).to.equal(' Hello world');
+  });
+  it('should remove spaces and commas', async () => {
+    const string = ' Hello world,';
+    const newString = (0, _cleanString.default)(string, [' ', ',']);
+    (0, _chai.expect)(newString).to.equal('Hello world');
+  });
+  it('should do a thorough cleaning', async () => {
+    const string = 'Hello world. ';
+    const newString = (0, _cleanString.default)(string, [' ', '.'], false, true, true);
+    (0, _chai.expect)(newString).to.equal('Hello world');
+  });
+});