Function getCompactor

src/core/compactors.ts:328–353

(
  compactType: CompactType,
  allowOverlap: boolean = false,
  preventCollision: boolean = false
)

 * @returns The appropriate Compactor
 */
export function getCompactor(
  compactType: CompactType,
  allowOverlap: boolean = false,
  preventCollision: boolean = false
): Compactor {
  let baseCompactor: Compactor;

  if (allowOverlap) {
    if (compactType === "vertical") baseCompactor = verticalOverlapCompactor;
    else if (compactType === "horizontal")
      baseCompactor = horizontalOverlapCompactor;
    else baseCompactor = noOverlapCompactor;
  } else {
    if (compactType === "vertical") baseCompactor = verticalCompactor;
    else if (compactType === "horizontal") baseCompactor = horizontalCompactor;
    // For 'wrap' and null, use noCompactor
    // Users wanting wrap mode should import wrapCompactor from extras
    else baseCompactor = noCompactor;
  }

  // Return with preventCollision if specified
  if (preventCollision) {
    return { ...baseCompactor, preventCollision };
  }
  return baseCompactor;
}