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 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 | 2x 2x 276x 276x 2299x 2299x 276x 14x 14x 217x 14x 45x 45x 774x 45x 729x 45x 45x 45x 45x 45x 45x 3630x 69x 1147x 1147x 1147x 1147x 2x 1670x 85528x 85405x 47973x 13401x 3566x 3348x 141x 141x 141x 141x 141x 2183x 2183x 2159x 2159x 2159x 2183x 2183x 141x 2x 1761x 1761x 1761x 35785x 1761x 8419x 8419x 8289x 6893x 267x 1761x 2159x 2159x 2159x 2107x 2107x 2428x 52x 18x 9x 2159x 1494x 8x 1486x 1494x 2x 2x 2x 4x 2159x 2159x 2159x 72x 72x 1165x 1165x 1165x 1165x 20x 40x 72x 3513x 36993x 7632x 77913x 720x 3348x 72x 72x 56x 56x 56x 56x 56x 56x 56x 56x 56x 56x 56x 56x 2x 54x 2x 2x 2x 2x 2x 52x 59x 59x 59x 32x 32x 52x 32x 32x 32x 32x 19x 19x 19x 19x 19x 19x 3x 3x 16x 14x 2x 2x 15x 15x 15x 15x 1152x 2x 58x 2x 51x 61x 72x 2x 26x 26x 2x 40x 2x 21x 21x 2x 25x 2x 12x 2x 6x 2x 10x 2x 9x 2x 75x 75x 75x 768x 768x 591x 197x 189x 20x 170x 6646x 5206x 1440x 116x 1324x 8x 22x 16x 6x 71x 71x 71x 1166x 1162x 1162x 1162x 1138x 24x 23x 23x 23x 1x 71x 71x 81x 81x 81x 913x 913x 3652x 3652x 3652x 1x 912x 158x 158x 120x 2x | // @flow
import { deepEqual } from "fast-equals";
import React from "react";
import type {
ChildrenArray as ReactChildrenArray,
Element as ReactElement
} from "react";
export type ResizeHandleAxis =
| "s"
| "w"
| "e"
| "n"
| "sw"
| "nw"
| "se"
| "ne";
export type LayoutItem = {
w: number,
h: number,
x: number,
y: number,
i: string,
minW?: number,
minH?: number,
maxW?: number,
maxH?: number,
moved?: boolean,
static?: boolean,
isDraggable?: ?boolean,
isResizable?: ?boolean,
resizeHandles?: Array<ResizeHandleAxis>,
isBounded?: ?boolean
};
export type Layout = $ReadOnlyArray<LayoutItem>;
export type Position = {
left: number,
top: number,
width: number,
height: number
};
export type ReactDraggableCallbackData = {
node: HTMLElement,
x?: number,
y?: number,
deltaX: number,
deltaY: number,
lastX?: number,
lastY?: number
};
export type PartialPosition = { left: number, top: number };
export type DroppingPosition = { left: number, top: number, e: Event };
export type Size = { width: number, height: number };
export type GridDragEvent = {
e: Event,
node: HTMLElement,
newPosition: PartialPosition
};
export type GridResizeEvent = {
e: Event,
node: HTMLElement,
size: Size,
handle: string
};
export type DragOverEvent = MouseEvent & {
nativeEvent: {
layerX: number,
layerY: number,
...Event
}
};
// Helpful port from TS
export type Pick<FromType, Properties: { [string]: 0 }> = $Exact<
$ObjMapi<Properties, <K, V>(k: K, v: V) => $ElementType<FromType, K>>
>;
type REl = ReactElement<any>;
export type ReactChildren = ReactChildrenArray<REl>;
// All callbacks are of the signature (layout, oldItem, newItem, placeholder, e).
export type EventCallback = (
Layout,
oldItem: ?LayoutItem,
newItem: ?LayoutItem,
placeholder: ?LayoutItem,
Event,
?HTMLElement
) => void;
export type CompactType = ?("horizontal" | "vertical");
const isProduction = process.env.NODE_ENV === "production";
const DEBUG = false;
/**
* Return the bottom coordinate of the layout.
*
* @param {Array} layout Layout array.
* @return {Number} Bottom coordinate.
*/
export function bottom(layout: Layout): number {
let max = 0,
bottomY;
for (let i = 0, len = layout.length; i < len; i++) {
bottomY = layout[i].y + layout[i].h;
if (bottomY > max) max = bottomY;
}
return max;
}
export function cloneLayout(layout: Layout): Layout {
const newLayout = Array(layout.length);
for (let i = 0, len = layout.length; i < len; i++) {
newLayout[i] = cloneLayoutItem(layout[i]);
}
return newLayout;
}
// Modify a layoutItem inside a layout. Returns a new Layout,
// does not mutate. Carries over all other LayoutItems unmodified.
export function modifyLayout(layout: Layout, layoutItem: LayoutItem): Layout {
const newLayout = Array(layout.length);
for (let i = 0, len = layout.length; i < len; i++) {
if (layoutItem.i === layout[i].i) {
newLayout[i] = layoutItem;
} else {
newLayout[i] = layout[i];
}
}
return newLayout;
}
// Function to be called to modify a layout item.
// Does defensive clones to ensure the layout is not modified.
export function withLayoutItem(
layout: Layout,
itemKey: string,
cb: LayoutItem => LayoutItem
): [Layout, ?LayoutItem] {
let item = getLayoutItem(layout, itemKey);
Iif (!item) return [layout, null];
item = cb(cloneLayoutItem(item)); // defensive clone then modify
// FIXME could do this faster if we already knew the index
layout = modifyLayout(layout, item);
return [layout, item];
}
// Fast path to cloning, since this is monomorphic
export function cloneLayoutItem(layoutItem: LayoutItem): LayoutItem {
return {
w: layoutItem.w,
h: layoutItem.h,
x: layoutItem.x,
y: layoutItem.y,
i: layoutItem.i,
minW: layoutItem.minW,
maxW: layoutItem.maxW,
minH: layoutItem.minH,
maxH: layoutItem.maxH,
moved: Boolean(layoutItem.moved),
static: Boolean(layoutItem.static),
// These can be null/undefined
isDraggable: layoutItem.isDraggable,
isResizable: layoutItem.isResizable,
resizeHandles: layoutItem.resizeHandles,
isBounded: layoutItem.isBounded
};
}
/**
* Comparing React `children` is a bit difficult. This is a good way to compare them.
* This will catch differences in keys, order, and length.
*/
export function childrenEqual(a: ReactChildren, b: ReactChildren): boolean {
return (
deepEqual(
React.Children.map(a, c => c?.key),
React.Children.map(b, c => c?.key)
) &&
deepEqual(
React.Children.map(a, c => c?.props["data-grid"]),
React.Children.map(b, c => c?.props["data-grid"])
)
);
}
/**
* See `fastRGLPropsEqual.js`.
* We want this to run as fast as possible - it is called often - and to be
* resilient to new props that we add. So rather than call lodash.isEqual,
* which isn't suited to comparing props very well, we use this specialized
* function in conjunction with preval to generate the fastest possible comparison
* function, tuned for exactly our props.
*/
type FastRGLPropsEqual = (Object, Object, Function) => boolean;
export const fastRGLPropsEqual: FastRGLPropsEqual = require("./fastRGLPropsEqual");
// Like the above, but a lot simpler.
export function fastPositionEqual(a: Position, b: Position): boolean {
return (
a.left === b.left &&
a.top === b.top &&
a.width === b.width &&
a.height === b.height
);
}
/**
* Given two layoutitems, check if they collide.
*/
export function collides(l1: LayoutItem, l2: LayoutItem): boolean {
if (l1.i === l2.i) return false; // same element
if (l1.x + l1.w <= l2.x) return false; // l1 is left of l2
if (l1.x >= l2.x + l2.w) return false; // l1 is right of l2
if (l1.y + l1.h <= l2.y) return false; // l1 is above l2
if (l1.y >= l2.y + l2.h) return false; // l1 is below l2
return true; // boxes overlap
}
/**
* Given a layout, compact it. This involves going down each y coordinate and removing gaps
* between items.
*
* Does not modify layout items (clones). Creates a new layout array.
*
* @param {Array} layout Layout.
* @param {Boolean} verticalCompact Whether or not to compact the layout
* vertically.
* @param {Boolean} allowOverlap When `true`, allows overlapping grid items.
* @return {Array} Compacted Layout.
*/
export function compact(
layout: Layout,
compactType: CompactType,
cols: number,
allowOverlap: ?boolean
): Layout {
// Statics go in the compareWith array right away so items flow around them.
const compareWith = getStatics(layout);
// We keep track of the bottom position.
let b = bottom(compareWith);
// We go through the items by row and column.
const sorted = sortLayoutItems(layout, compactType);
// Holding for new items.
const out = Array(layout.length);
for (let i = 0, len = sorted.length; i < len; i++) {
let l = cloneLayoutItem(sorted[i]);
// Don't move static elements
if (!l.static) {
l = compactItem(compareWith, l, compactType, cols, sorted, allowOverlap, b);
b = Math.max(b, l.y + l.h);
// Add to comparison array. We only collide with items before this one.
// Statics are already in this array.
compareWith.push(l);
}
// Add to output array to make sure they still come out in the right order.
out[layout.indexOf(sorted[i])] = l;
// Clear moved flag, if it exists.
l.moved = false;
}
return out;
}
const heightWidth = { x: "w", y: "h" };
/**
* Before moving item down, it will check if the movement will cause collisions and move those items down before.
*/
function resolveCompactionCollision(
layout: Layout,
item: LayoutItem,
moveToCoord: number,
axis: "x" | "y"
) {
const sizeProp = heightWidth[axis];
item[axis] += 1;
const itemIndex = layout
.map(layoutItem => {
return layoutItem.i;
})
.indexOf(item.i);
// Go through each item we collide with.
for (let i = itemIndex + 1; i < layout.length; i++) {
const otherItem = layout[i];
// Ignore static items
if (otherItem.static) continue;
// Optimization: we can break early if we know we're past this el
// We can do this b/c it's a sorted layout
if (otherItem.y > item.y + item.h) break;
if (collides(item, otherItem)) {
resolveCompactionCollision(
layout,
otherItem,
moveToCoord + item[sizeProp],
axis
);
}
}
item[axis] = moveToCoord;
}
/**
* Compact an item in the layout.
*
* Modifies item.
*
*/
export function compactItem(
compareWith: Layout,
l: LayoutItem,
compactType: CompactType,
cols: number,
fullLayout: Layout,
allowOverlap: ?boolean,
b: number
): LayoutItem {
const compactV = compactType === "vertical";
const compactH = compactType === "horizontal";
if (compactV) {
// Bottom 'y' possible is the bottom of the layout.
// This allows you to do nice stuff like specify {y: Infinity}
// This is here because the layout must be sorted in order to get the correct bottom `y`.
l.y = Math.min(b, l.y);
// Move the element up as far as it can go without colliding.
while (l.y > 0 && !getFirstCollision(compareWith, l)) {
l.y--;
}
} else if (compactH) {
// Move the element left as far as it can go without colliding.
while (l.x > 0 && !getFirstCollision(compareWith, l)) {
l.x--;
}
}
// Move it down, and keep moving it down if it's colliding.
let collides;
// Checking the compactType null value to avoid breaking the layout when overlapping is allowed.
while (
(collides = getFirstCollision(compareWith, l)) &&
!(compactType === null && allowOverlap)
) {
if (compactH) {
resolveCompactionCollision(fullLayout, l, collides.x + collides.w, "x");
} else {
resolveCompactionCollision(fullLayout, l, collides.y + collides.h, "y");
}
// Since we can't grow without bounds horizontally, if we've overflown, let's move it down and try again.
if (compactH && l.x + l.w > cols) {
l.x = cols - l.w;
l.y++;
// ALso move element as left as we can
while (l.x > 0 && !getFirstCollision(compareWith, l)) {
l.x--;
}
}
}
// Ensure that there are no negative positions
l.y = Math.max(l.y, 0);
l.x = Math.max(l.x, 0);
return l;
}
/**
* Given a layout, make sure all elements fit within its bounds.
*
* Modifies layout items.
*
* @param {Array} layout Layout array.
* @param {Number} bounds Number of columns.
*/
export function correctBounds(
layout: Layout,
bounds: { cols: number }
): Layout {
const collidesWith = getStatics(layout);
for (let i = 0, len = layout.length; i < len; i++) {
const l = layout[i];
// Overflows right
Iif (l.x + l.w > bounds.cols) l.x = bounds.cols - l.w;
// Overflows left
Iif (l.x < 0) {
l.x = 0;
l.w = bounds.cols;
}
if (!l.static) collidesWith.push(l);
else {
// If this is static and collides with other statics, we must move it down.
// We have to do something nicer than just letting them overlap.
while (getFirstCollision(collidesWith, l)) {
l.y++;
}
}
}
return layout;
}
/**
* Get a layout item by ID. Used so we can override later on if necessary.
*
* @param {Array} layout Layout array.
* @param {String} id ID
* @return {LayoutItem} Item at ID.
*/
export function getLayoutItem(layout: Layout, id: string): ?LayoutItem {
for (let i = 0, len = layout.length; i < len; i++) {
if (layout[i].i === id) return layout[i];
}
}
/**
* Returns the first item this layout collides with.
* It doesn't appear to matter which order we approach this from, although
* perhaps that is the wrong thing to do.
*
* @param {Object} layoutItem Layout item.
* @return {Object|undefined} A colliding layout item, or undefined.
*/
export function getFirstCollision(
layout: Layout,
layoutItem: LayoutItem
): ?LayoutItem {
for (let i = 0, len = layout.length; i < len; i++) {
if (collides(layout[i], layoutItem)) return layout[i];
}
}
export function getAllCollisions(
layout: Layout,
layoutItem: LayoutItem
): Array<LayoutItem> {
return layout.filter(l => collides(l, layoutItem));
}
/**
* Get all static elements.
* @param {Array} layout Array of layout objects.
* @return {Array} Array of static layout items..
*/
export function getStatics(layout: Layout): Array<LayoutItem> {
return layout.filter(l => l.static);
}
/**
* Recursively move items up to fill gaps when collision handling detects
* elements that can be moved closer together.
*
* @param {LayoutItem} l The layout item that was moved
* @param {Layout} layout The full layout array
* @param {number} iteration Iteration counter to prevent infinite loops
*/
export function recursivelyMoveItemsUp(l: LayoutItem, layout: Layout, iteration: number = 0) {
if (iteration > 6) {
return; // prevent infinite loops
}
// Find items below the current item that are within the collision area
const itemsBelow = layout.filter(el =>
el.y < l.y + l.h + 5 &&
el.y >= l.y + l.h &&
((l.x >= el.x && l.x <= el.x + el.w) || (el.x >= l.x && el.x <= l.x + l.w))
);
itemsBelow.forEach(el => {
let prevY = el.y;
for (let i = 0; i < l.h; i++) {
el.y = el.y - 1;
let collidingEl = getFirstCollision(layout, el);
if (collidingEl) {
// Collision happened, revert to previous position
el.y = prevY;
break;
}
prevY = el.y;
}
// Recursively apply this logic to items that were moved
recursivelyMoveItemsUp(el, layout, iteration + 1);
});
}
/**
* Move an element. Responsible for doing cascading movements of other elements.
*
* Modifies layout items.
*
* @param {Array} layout Full layout to modify.
* @param {LayoutItem} l element to move.
* @param {Number} [x] X position in grid units.
* @param {Number} [y] Y position in grid units.
*/
export function moveElement(
layout: Layout,
l: LayoutItem,
x: ?number,
y: ?number,
isUserAction: ?boolean,
preventCollision: ?boolean,
compactType: CompactType,
cols: number,
allowOverlap: ?boolean
): Layout {
// If this is static and not explicitly enabled as draggable,
// no move is possible, so we can short-circuit this immediately.
Iif (l.static && l.isDraggable !== true) return layout;
// Short-circuit if nothing to do.
if (l.y === y && l.x === x) return layout;
log(
`Moving element ${l.i} to [${String(x)},${String(y)}] from [${l.x},${l.y}]`
);
const oldX = l.x;
const oldY = l.y;
// This is quite a bit faster than extending the object
if (typeof x === "number") l.x = x;
if (typeof y === "number") l.y = y;
l.moved = true;
// If this collides with anything, move it.
// When doing this comparison, we have to sort the items we compare with
// to ensure, in the case of multiple collisions, that we're getting the
// nearest collision.
let sorted = sortLayoutItems(layout, compactType);
const movingUp =
compactType === "vertical" && typeof y === "number"
? oldY >= y
: compactType === "horizontal" && typeof x === "number"
? oldX >= x
: false;
// $FlowIgnore acceptable modification of read-only array as it was recently cloned
if (movingUp) sorted = sorted.reverse();
const collisions = getAllCollisions(sorted, l);
const hasCollisions = collisions.length > 0;
// We may have collisions. We can short-circuit if we've turned off collisions or
// allowed overlap.
if (hasCollisions && allowOverlap) {
// Easy, we don't need to resolve collisions. But we *did* change the layout,
// so clone it on the way out.
return cloneLayout(layout);
} else if (hasCollisions && preventCollision) {
// If we are preventing collision but not allowing overlap, we need to
// revert the position of this element so it goes to where it came from, rather
// than the user's desired location.
log(`Collision prevented on ${l.i}, reverting.`);
l.x = oldX;
l.y = oldY;
l.moved = false;
return layout; // did not change so don't clone
}
// Move each item that collides away from this element.
for (let i = 0, len = collisions.length; i < len; i++) {
const collision = collisions[i];
log(
`Resolving collision between ${l.i} at [${l.x},${l.y}] and ${collision.i} at [${collision.x},${collision.y}]`
);
// Short circuit so we can't infinite loop
if (collision.moved) continue;
// Don't move static items - we have to move *this* element away
Iif (collision.static) {
layout = moveElementAwayFromCollision(
layout,
collision,
l,
isUserAction,
compactType,
cols
);
} else {
layout = moveElementAwayFromCollision(
layout,
l,
collision,
isUserAction,
compactType,
cols
);
}
}
return layout;
}
/**
* This is where the magic needs to happen - given a collision, move an element away from the collision.
* We attempt to move it up if there's room, otherwise it goes below.
*
* @param {Array} layout Full layout to modify.
* @param {LayoutItem} collidesWith Layout item we're colliding with.
* @param {LayoutItem} itemToMove Layout item we're moving.
*/
export function moveElementAwayFromCollision(
layout: Layout,
collidesWith: LayoutItem,
itemToMove: LayoutItem,
isUserAction: ?boolean,
compactType: CompactType,
cols: number
): Layout {
const compactH = compactType === "horizontal";
// Compact vertically if not set to horizontal
const compactV = compactType === "vertical";
const preventCollision = collidesWith.static; // we're already colliding (not for static items)
// If there is enough space above the collision to put this element, move it there.
// We only do this on the main collision as this can get funky in cascades and cause
// unwanted swapping behavior.
if (isUserAction) {
// Reset isUserAction flag because we're not in the main collision anymore.
isUserAction = false;
// Make a mock item so we don't modify the item here, only modify in moveElement.
const fakeItem: LayoutItem = {
x: compactH ? Math.max(collidesWith.x - itemToMove.w, 0) : itemToMove.x,
y: compactV ? Math.max(collidesWith.y - itemToMove.h, 0) : itemToMove.y,
w: itemToMove.w,
h: itemToMove.h,
i: "-1"
};
const firstCollision = getFirstCollision(layout, fakeItem);
const collisionNorth =
firstCollision && firstCollision.y + firstCollision.h > collidesWith.y;
const collisionWest =
firstCollision && collidesWith.x + collidesWith.w > firstCollision.x;
// No collision? If so, we can go up there; otherwise, we'll end up moving down as normal
if (!firstCollision) {
log(
`Doing reverse collision on ${itemToMove.i} up to [${fakeItem.x},${fakeItem.y}].`
);
return moveElement(
layout,
itemToMove,
compactH ? fakeItem.x : undefined,
compactV ? fakeItem.y : undefined,
isUserAction,
preventCollision,
compactType,
cols
);
} else if (collisionNorth && compactV) {
return moveElement(
layout,
itemToMove,
undefined,
collidesWith.y + 1,
isUserAction,
preventCollision,
compactType,
cols
);
} else Iif (collisionNorth && compactType == null) {
collidesWith.y = itemToMove.y;
itemToMove.y = itemToMove.y + itemToMove.h;
return layout;
} else Iif (collisionWest && compactH) {
return moveElement(
layout,
collidesWith,
itemToMove.x,
undefined,
isUserAction,
preventCollision,
compactType,
cols
);
}
}
const newX = compactH ? itemToMove.x + 1 : undefined;
const newY = compactV ? itemToMove.y + 1 : undefined;
Iif (newX == null && newY == null) {
return layout;
}
return moveElement(
layout,
itemToMove,
compactH ? itemToMove.x + 1 : undefined,
compactV ? itemToMove.y + 1 : undefined,
isUserAction,
preventCollision,
compactType,
cols
);
}
/**
* Helper to convert a number to a percentage string.
*
* @param {Number} num Any number
* @return {String} That number as a percentage.
*/
export function perc(num: number): string {
return num * 100 + "%";
}
/**
* Helper functions to constrain dimensions of a GridItem
*/
const constrainWidth = (
left: number,
currentWidth: number,
newWidth: number,
containerWidth: number
) => {
return left + newWidth > containerWidth ? currentWidth : newWidth;
};
const constrainHeight = (
top: number,
currentHeight: number,
newHeight: number
) => {
return top < 0 ? currentHeight : newHeight;
};
const constrainLeft = (left: number) => Math.max(0, left);
const constrainTop = (top: number) => Math.max(0, top);
const resizeNorth = (currentSize, { left, height, width }, _containerWidth) => {
const top = currentSize.top - (height - currentSize.height);
return {
left,
width,
height: constrainHeight(top, currentSize.height, height),
top: constrainTop(top)
};
};
const resizeEast = (
currentSize,
{ top, left, height, width },
containerWidth
) => ({
top,
height,
width: constrainWidth(
currentSize.left,
currentSize.width,
width,
containerWidth
),
left: constrainLeft(left)
});
const resizeWest = (currentSize, { top, height, width }, containerWidth) => {
const left = currentSize.left - (width - currentSize.width);
return {
height,
width:
left < 0
? currentSize.width
: constrainWidth(
currentSize.left,
currentSize.width,
width,
containerWidth
),
top: constrainTop(top),
left: constrainLeft(left)
};
};
const resizeSouth = (
currentSize,
{ top, left, height, width },
containerWidth
) => ({
width,
left,
height: constrainHeight(top, currentSize.height, height),
top: constrainTop(top)
});
const resizeNorthEast = (...args) =>
resizeNorth(args[0], resizeEast(...args), args[2]);
const resizeNorthWest = (...args) =>
resizeNorth(args[0], resizeWest(...args), args[2]);
const resizeSouthEast = (...args) =>
resizeSouth(args[0], resizeEast(...args), args[2]);
const resizeSouthWest = (...args) =>
resizeSouth(args[0], resizeWest(...args), args[2]);
const ordinalResizeHandlerMap = {
n: resizeNorth,
ne: resizeNorthEast,
e: resizeEast,
se: resizeSouthEast,
s: resizeSouth,
sw: resizeSouthWest,
w: resizeWest,
nw: resizeNorthWest
};
/**
* Helper for clamping width and position when resizing an item.
*/
export function resizeItemInDirection(
direction: ResizeHandleAxis,
currentSize: Position,
newSize: Position,
containerWidth: number
): Position {
const ordinalHandler = ordinalResizeHandlerMap[direction];
// Shouldn't be possible given types; that said, don't fail hard
Iif (!ordinalHandler) return newSize;
return ordinalHandler(
currentSize,
{ ...currentSize, ...newSize },
containerWidth
);
}
export function setTransform({ top, left, width, height }: Position): Object {
// Replace unitless items with px
const translate = `translate(${left}px,${top}px)`;
return {
transform: translate,
WebkitTransform: translate,
MozTransform: translate,
msTransform: translate,
OTransform: translate,
width: `${width}px`,
height: `${height}px`,
position: "absolute"
};
}
export function setTopLeft({ top, left, width, height }: Position): Object {
return {
top: `${top}px`,
left: `${left}px`,
width: `${width}px`,
height: `${height}px`,
position: "absolute"
};
}
/**
* Get layout items sorted from top left to right and down.
*
* @return {Array} Array of layout objects.
* @return {Array} Layout, sorted static items first.
*/
export function sortLayoutItems(
layout: Layout,
compactType: CompactType
): Layout {
if (compactType === "horizontal") return sortLayoutItemsByColRow(layout);
if (compactType === "vertical") return sortLayoutItemsByRowCol(layout);
else return layout;
}
/**
* Sort layout items by row ascending and column ascending.
*
* Does not modify Layout.
*/
export function sortLayoutItemsByRowCol(layout: Layout): Layout {
// Slice to clone array as sort modifies
return layout.slice(0).sort(function (a, b) {
if (a.y > b.y || (a.y === b.y && a.x > b.x)) {
return 1;
} else if (a.y === b.y && a.x === b.x) {
// Without this, we can get different sort results in IE vs. Chrome/FF
return 0;
}
return -1;
});
}
/**
* Sort layout items by column ascending then row ascending.
*
* Does not modify Layout.
*/
export function sortLayoutItemsByColRow(layout: Layout): Layout {
return layout.slice(0).sort(function (a, b) {
if (a.x > b.x || (a.x === b.x && a.y > b.y)) {
return 1;
}
return -1;
});
}
/**
* Generate a layout using the initialLayout and children as a template.
* Missing entries will be added, extraneous ones will be truncated.
*
* Does not modify initialLayout.
*
* @param {Array} initialLayout Layout passed in through props.
* @param {String} breakpoint Current responsive breakpoint.
* @param {?String} compact Compaction option.
* @return {Array} Working layout.
*/
export function synchronizeLayoutWithChildren(
initialLayout: Layout,
children: ReactChildren,
cols: number,
compactType: CompactType,
allowOverlap: ?boolean
): Layout {
initialLayout = initialLayout || [];
// Generate one layout item per child.
const layout: LayoutItem[] = [];
React.Children.forEach(children, (child: ReactElement<any>) => {
// Child may not exist
if (child?.key == null) return;
const exists = getLayoutItem(initialLayout, String(child.key));
const g = child.props["data-grid"];
// Don't overwrite the layout item if it's already in the initial layout.
// If it has a `data-grid` property, prefer that over what's in the layout.
if (exists && g == null) {
layout.push(cloneLayoutItem(exists));
} else {
// Hey, this item has a data-grid property, use it.
if (g) {
Eif (!isProduction) {
validateLayout([g], "ReactGridLayout.children");
}
// FIXME clone not really necessary here
layout.push(cloneLayoutItem({ ...g, i: child.key }));
} else {
// Nothing provided: ensure this is added to the bottom
// FIXME clone not really necessary here
layout.push(
cloneLayoutItem({
w: 1,
h: 1,
x: 0,
y: bottom(layout),
i: String(child.key)
})
);
}
}
});
// Correct the layout.
const correctedLayout = correctBounds(layout, { cols: cols });
return allowOverlap
? correctedLayout
: compact(correctedLayout, compactType, cols);
}
/**
* Validate a layout. Throws errors.
*
* @param {Array} layout Array of layout items.
* @param {String} [contextName] Context name for errors.
* @throw {Error} Validation error.
*/
export function validateLayout(
layout: Layout,
contextName: string = "Layout"
): void {
const subProps = ["x", "y", "w", "h"];
Iif (!Array.isArray(layout))
throw new Error(contextName + " must be an array!");
for (let i = 0, len = layout.length; i < len; i++) {
const item = layout[i];
for (let j = 0; j < subProps.length; j++) {
const key = subProps[j];
const value = item[key];
if (typeof value !== "number" || Number.isNaN(value)) {
throw new Error(
`ReactGridLayout: ${contextName}[${i}].${key} must be a number! Received: ${value} (${typeof value})`
);
}
}
Iif (typeof item.i !== "undefined" && typeof item.i !== "string") {
throw new Error(
`ReactGridLayout: ${contextName}[${i}].i must be a string! Received: ${
item.i
} (${typeof item.i})`
);
}
}
}
// Legacy support for verticalCompact: false
export function compactType(
props: ?{ verticalCompact: boolean, compactType: CompactType }
): CompactType {
const { verticalCompact, compactType } = props || {};
return verticalCompact === false ? null : compactType;
}
function log(...args) {
Eif (!DEBUG) return;
// eslint-disable-next-line no-console
console.log(...args);
}
export const noop = () => {};
|