Skip to content

Commit

Permalink
modifiers/snapEdges: add @module jsdoc comment
Browse files Browse the repository at this point in the history
  • Loading branch information
taye committed Apr 13, 2018
1 parent fc98370 commit 2ab991b
Showing 1 changed file with 27 additions and 2 deletions.
29 changes: 27 additions & 2 deletions packages/modifiers/snapEdges.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,30 @@
// This module allows snapping of the edges of targets during resize
// interactions.
/**
* @module modifiers/snapEdges
*
* @description
* This module allows snapping of the edges of targets during resize
* interactions.
*
* @example
* interact(target).resizable({
* snapEdges: {
* targets: [interact.snappers.grid({ x: 100, y: 50 })],
* },
* });
*
* interact(target).resizable({
* snapEdges: {
* targets: [
* interact.snappers.grid({
* top: 50,
* left: 50,
* bottom: 100,
* right: 100,
* }),
* ],
* },
* });
*/

import clone from '@interactjs/utils/clone';
import extend from '@interactjs/utils/extend';
Expand Down

0 comments on commit 2ab991b

Please sign in to comment.