magic-grid/src/utils.js

Super lightweight javascript library for dynamic grid layouts.

/**
 * @author emmanuelolaojo
 * @since 11/11/18
 */

/**
 * Validates the configuration object.
 *
 * @param config - configuration object
 */
const checkParams = config => {
  const DEFAULT_GUTTER = 25;
  const booleanProps = ["useTransform", "center"];


  if (!config) {
    throw new Error("No config object has been provided.");
  }

  for(let prop of booleanProps){
    if(typeof config[prop] !== "boolean"){
      config[prop] = true;
    }
  }


  if(typeof config.gutter !== "number"){
    config.gutter = DEFAULT_GUTTER;
  }

  if (!config.container) error("container");
  if (!config.items && !config.static) error("items or static");
};


/**
 * Handles invalid configuration object
 * errors.
 *
 * @param prop - a property with a missing value
 */
const error = prop => {
  throw new Error(`Missing property '${prop}' in MagicGrid config`);
};

/**
 * Finds the shortest column in
 * a column list.
 *
 * @param cols - list of columns
 *
 * @return shortest column
 */
const getMin = cols => {
  let min = cols[0];

  for (let col of cols) {
    if (col.height < min.height) min = col;
  }

  return min;
};

module.exports = {
  checkParams,
  getMin
};