ckeditor/ckeditor5-utils

View on GitHub
src/dom/tounit.js

Summary

Maintainability
A
0 mins
Test Coverage
/**
 * @license Copyright (c) 2003-2020, CKSource - Frederico Knabben. All rights reserved.
 * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
 */

/**
 * @module utils/dom/tounit
 */

/**
 * Returns a helper function, which adds a desired trailing
 * `unit` to the passed value.
 *
 * @param {String} unit An unit like "px" or "em".
 * @returns {module:utils/dom/tounit~helper}
 */
export default function toUnit( unit ) {
    /**
     * A function, which adds a pre–defined trailing `unit`
     * to the passed `value`.
     *
     * @function helper
      * @param {*} value A value to be given the unit.
      * @returns {String} A value with the trailing unit.
     */
    return value => value + unit;
}