├── .eslintrc.js ├── .github ├── pull_request_template.md └── workflows │ └── test.yml ├── .gitignore ├── .nvmrc ├── .release-it.json ├── CHANGELOG.md ├── LICENSE ├── README.md ├── cypress.config.js ├── index.d.ts ├── index.html ├── index.js ├── package.json ├── src ├── App.vue ├── examples │ ├── Basic.vue │ ├── Detach.vue │ ├── Force.vue │ ├── Move.vue │ ├── MoveOnMouseUp.vue │ ├── NotDraggable.vue │ └── index.js └── index.js ├── tests ├── specs │ ├── basic.cy.js │ ├── detach.cy.js │ ├── force.cy.js │ ├── move.cy.js │ └── not-draggable.cy.js └── support │ ├── commands.js │ └── index.js ├── webpack.config.js └── yarn.lock /.eslintrc.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | extends: ['@4tw'], 3 | } 4 | -------------------------------------------------------------------------------- /.github/pull_request_template.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | ## Description 4 | 5 | 6 | ## Checklist: 7 | 8 | - [ ] I have added tests to cover my changes. 9 | - [ ] All new and existing tests passed. 10 | - [ ] I have updated the ``README.md`` accordingly. 11 | - [ ] I have added an entry in ``CHANGELOG.md`` in the ``[Unreleased]`` section. 12 | -------------------------------------------------------------------------------- /.github/workflows/test.yml: -------------------------------------------------------------------------------- 1 | name: Build and test cypress-drag-drop 2 | 3 | on: [push, pull_request] 4 | 5 | jobs: 6 | test: 7 | runs-on: ubuntu-latest 8 | 9 | strategy: 10 | matrix: 11 | node-version: [ 18 ] 12 | 13 | steps: 14 | - name: Checkout 15 | uses: actions/checkout@v2 16 | 17 | - name: Use Node.js version ${{ matrix.node-version }} 18 | uses: actions/setup-node@v1 19 | with: 20 | node-version: ${{ matrix.node-version }} 21 | 22 | - name: Install 23 | run: yarn install --frozen-lockfile 24 | 25 | - name: Lint 26 | run: yarn lint 27 | 28 | - name: Test 29 | run: yarn test:ci 30 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | 8 | # Runtime data 9 | pids 10 | *.pid 11 | *.seed 12 | *.pid.lock 13 | 14 | # Directory for instrumented libs generated by jscoverage/JSCover 15 | lib-cov 16 | 17 | # Coverage directory used by tools like istanbul 18 | coverage 19 | 20 | # nyc test coverage 21 | .nyc_output 22 | 23 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 24 | .grunt 25 | 26 | # Bower dependency directory (https://bower.io/) 27 | bower_components 28 | 29 | # node-waf configuration 30 | .lock-wscript 31 | 32 | # Compiled binary addons (https://nodejs.org/api/addons.html) 33 | build/Release 34 | 35 | # Dependency directories 36 | node_modules/ 37 | jspm_packages/ 38 | 39 | # TypeScript v1 declaration files 40 | typings/ 41 | 42 | # Optional npm cache directory 43 | .npm 44 | 45 | # Optional eslint cache 46 | .eslintcache 47 | 48 | # Optional REPL history 49 | .node_repl_history 50 | 51 | # Output of 'npm pack' 52 | *.tgz 53 | 54 | # Yarn Integrity file 55 | .yarn-integrity 56 | 57 | # dotenv environment variables file 58 | .env 59 | 60 | # next.js build output 61 | .next 62 | 63 | # dist files 64 | /dist 65 | -------------------------------------------------------------------------------- /.nvmrc: -------------------------------------------------------------------------------- 1 | lts/gallium 2 | -------------------------------------------------------------------------------- /.release-it.json: -------------------------------------------------------------------------------- 1 | { 2 | "plugins": { 3 | "@release-it/keep-a-changelog": { 4 | "filename": "./CHANGELOG.md", 5 | "addUnreleased": true 6 | } 7 | } 8 | } 9 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Changelog 2 | All notable changes to this project will be documented in this file. 3 | 4 | The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), 5 | and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). 6 | 7 | ## [Unreleased] 8 | 9 | ## [2.3.0] - 2025-01-30 10 | 11 | - Add support for Cypress 14.x. 12 | 13 | ## [2.2.5] - 2023-09-14 14 | 15 | - Add support for Cypress 13.x. 16 | 17 | ## [2.2.4] - 2023-06-01 18 | 19 | - Extend type Options to allow for x/y use 20 | 21 | ## [2.2.3] - 2022-12-12 22 | 23 | - Add support for Cypress 12.x. 24 | 25 | ## [2.2.2] - 2022-11-23 26 | 27 | - Add support for Cypress 11.x. 28 | 29 | ## [2.2.1] - 2022-06-29 30 | 31 | - Fix swapped variables in move command. 32 | 33 | ## [2.2.0] - 2022-06-16 34 | 35 | - Add support for Cypress 10.x. 36 | 37 | ## [2.1.0] - 2021-11-24 38 | 39 | - Add ability to check the drag command outcome. 40 | - Add support for Cypress 9.x. 41 | 42 | ## [2.0.0] - 2021-09-08 43 | 44 | - It's possible to apply different options to either the drag source or the drop target. 45 | - BREAKING: Default position for the event trigger is in the element's center. 46 | 47 | ## [1.8.1] - 2021-09-01 48 | 49 | - Introduce Changelog 50 | 51 | ## [1.8.0] 52 | 53 | - Initial implementation 54 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # cypress-drag-drop 2 | 3 | A Cypress child command for drag'n'drop support. 4 | 5 | # Setup 6 | 7 | Install using npm: 8 | 9 | ```bash 10 | npm install --save-dev @4tw/cypress-drag-drop 11 | ``` 12 | 13 | or yarn 14 | 15 | ```bash 16 | yarn add --dev @4tw/cypress-drag-drop 17 | ``` 18 | 19 | Before Cypress is loaded (usually in your `commands.js`) put the following line: 20 | 21 | ```javascript 22 | require('@4tw/cypress-drag-drop') 23 | ``` 24 | 25 | Or, if you are using ES module syntax: 26 | 27 | ```javascript 28 | import '@4tw/cypress-drag-drop' 29 | ``` 30 | 31 | This will register the `drag` and `move` command. 32 | 33 | 34 | If you're using TypeScript, put the following configuration in a `tsconfig.json` 35 | 36 | ```json 37 | { 38 | "compilerOptions": { 39 | "types": ["cypress", "@4tw/cypress-drag-drop"] 40 | } 41 | } 42 | ``` 43 | 44 | # Usage 45 | 46 | ## drag 47 | 48 | The `drag` command is a child command. 49 | The command only accepts elements. 50 | As the drop target simply pass a selector as a string. 51 | 52 | In your Cypress spec use the command as follows: 53 | 54 | ```javascript 55 | describe('Dragtest', () => { 56 | it('should dragndrop', () => { 57 | cy.visit('/yourpage') 58 | 59 | cy.get('.sourceitem').drag('.targetitem') 60 | }) 61 | }) 62 | ``` 63 | 64 | Pass the options as an object in the second paramteter. 65 | 66 | ```javascript 67 | describe('Dragtest', () => { 68 | it('should dragndrop', () => { 69 | cy.visit('/yourpage') 70 | 71 | cy.get('.sourceitem').drag('.targetitem', options) 72 | }) 73 | }) 74 | ``` 75 | 76 | During the drag and drop interaction, two elements are involved. The source element being dragged and the drop target. 77 | In order to decide what options should either be applied to the source or the target, the options object can be divided in `source` and `target`. Options that are not specific to the source or target are applied to both the source and the target. 78 | 79 | ``` javascript 80 | cy.get('.sourceitem').drag('.target', { 81 | source: { x: 100, y: 100 }, // applies to the element being dragged 82 | target: { position: 'left' }, // applies to the drop target 83 | force: true, // applied to both the source and target element 84 | }) 85 | ``` 86 | 87 | The options are directly passed to Cypress' `trigger` command. 88 | So, all options from https://docs.cypress.io/api/commands/trigger#Arguments are possible. 89 | 90 | ### Check command outcome 91 | 92 | The `drag` command is able to tell whether the drag attempt was successful or not. So, the command will yield `true` when the drag attempt was successful and `false` otherwise: 93 | 94 | ``` javascript 95 | cy.get('.sourceitem').drag('.target').then((success) => { 96 | assert.isTrue(success) 97 | }) 98 | ``` 99 | 100 | Or you might also want to check that the element is not draggable: 101 | 102 | ``` javascript 103 | cy.get('.sourceitem').drag('.target').then((success) => { 104 | assert.isFalse(success) 105 | }) 106 | ``` 107 | 108 | ## move 109 | 110 | The `move` command is a child command. 111 | The command only accepts elements. 112 | Define `deltaX` and `deltaY` as an object parameter to move the element in x- and y-position relative to the element's current position. 113 | 114 | In your Cypress spec use the command as follows: 115 | 116 | ```javascript 117 | describe('Movetest', () => { 118 | it('should move', () => { 119 | cy.visit('/yourpage') 120 | 121 | cy.get('.sourceitem').move({ deltaX: 100, deltaY: 100 }) 122 | }) 123 | }) 124 | ``` 125 | 126 | The command accepts all options from https://docs.cypress.io/api/commands/trigger#Arguments except `position`, `x` and `y` because they have no effect, since the command makes use of `clientX` and `clientY` internally. 127 | 128 | ```javascript 129 | describe('Movetest', () => { 130 | it('should move', () => { 131 | cy.visit('/yourpage') 132 | 133 | cy.get('.sourceitem').move({ deltaX: 100, deltaY: 100, ...options }) 134 | }) 135 | }) 136 | ``` 137 | 138 | # Development 139 | 140 | The plugin itself is implemented in the `index.js` file. 141 | 142 | ## Testing 143 | 144 | The tests can be run using Cypress: 145 | 146 | ``` 147 | yarn test 148 | ``` 149 | 150 | The test fixtures are under `src/examples/`. Using the `setExample` Cypress command 151 | the fixture is loaded and ready to run tests on. The first attribute in the `setExample` command 152 | is the name of the fixture which needs to be the filename of the component. 153 | 154 | ```javascript 155 | cy.setExample('NameOfTheComponent') 156 | ``` 157 | 158 | 159 | # Release 160 | 161 | Release a new version of this package: 162 | 163 | ``` 164 | yarn run release 165 | ``` 166 | 167 | # Changelog 168 | 169 | Have a look at the [Changelog](CHANGELOG.md) 170 | -------------------------------------------------------------------------------- /cypress.config.js: -------------------------------------------------------------------------------- 1 | const { defineConfig } = require('cypress') 2 | 3 | module.exports = defineConfig({ 4 | fixturesFolder: 'tests/fixtures', 5 | video: false, 6 | viewportWidth: 1600, 7 | viewportHeight: 1200, 8 | defaultCommandTimeout: 1000, 9 | numTestsKeptInMemory: 1, 10 | e2e: { 11 | baseUrl: 'http://localhost:8080', 12 | specPattern: 'tests/specs/**/*.cy.{js,jsx,ts,tsx}', 13 | supportFile: 'tests/support/index.js', 14 | }, 15 | }) 16 | -------------------------------------------------------------------------------- /index.d.ts: -------------------------------------------------------------------------------- 1 | /// 2 | 3 | type LocationOptions = { 4 | x: number 5 | y: number 6 | } 7 | 8 | type Options = Partial 12 | 13 | type MoveOptions = Partial 17 | 18 | declare namespace Cypress { 19 | interface Chainable { 20 | drag(targetSelector: K, options?: Options): true 21 | drag(targetSelector: string, options?: Options): true 22 | drag(targetAlias: string, options?: Options): true 23 | move(options: MoveOptions): Chainable 24 | } 25 | } 26 | -------------------------------------------------------------------------------- /index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | Drag Drop Test 7 | 8 | 9 |
10 | 11 | 12 | 13 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | const dataTransfer = new DataTransfer() 2 | 3 | function omit(object = {}, keys = []) { 4 | return Object.entries(object).reduce((accum, [key, value]) => (key in keys ? accum : { ...accum, [key]: value }), {}) 5 | } 6 | 7 | function isAttached(element) { 8 | return !!element.closest('html') 9 | } 10 | 11 | const DragSimulator = { 12 | MAX_TRIES: 5, 13 | DELAY_INTERVAL_MS: 10, 14 | counter: 0, 15 | targetElement: null, 16 | rectsEqual(r1, r2) { 17 | return r1.top === r2.top && r1.right === r2.right && r1.bottom === r2.bottom && r1.left === r2.left 18 | }, 19 | createDefaultOptions(options) { 20 | const commonOptions = omit(options, ['source', 'target']) 21 | const source = { ...commonOptions, ...options.source } 22 | const target = { ...commonOptions, ...options.target } 23 | return { source, target } 24 | }, 25 | get dropped() { 26 | const currentSourcePosition = this.source.getBoundingClientRect() 27 | return !this.rectsEqual(this.initialSourcePosition, currentSourcePosition) 28 | }, 29 | get hasTriesLeft() { 30 | return this.counter < this.MAX_TRIES 31 | }, 32 | set target(target) { 33 | this.targetElement = target 34 | }, 35 | get target() { 36 | return cy.wrap(this.targetElement) 37 | }, 38 | dragstart(clientPosition = {}) { 39 | return cy 40 | .wrap(this.source) 41 | .trigger('pointerdown', { 42 | which: 1, 43 | button: 0, 44 | ...clientPosition, 45 | eventConstructor: 'PointerEvent', 46 | ...this.options.source, 47 | }) 48 | .trigger('mousedown', { 49 | which: 1, 50 | button: 0, 51 | ...clientPosition, 52 | eventConstructor: 'MouseEvent', 53 | ...this.options.source, 54 | }) 55 | .trigger('dragstart', { dataTransfer, eventConstructor: 'DragEvent', ...this.options.source }) 56 | }, 57 | drop(clientPosition = {}) { 58 | return this.target 59 | .trigger('drop', { 60 | dataTransfer, 61 | eventConstructor: 'DragEvent', 62 | ...this.options.target, 63 | }) 64 | .then(() => { 65 | if (isAttached(this.targetElement)) { 66 | this.target 67 | .trigger('mouseup', { 68 | which: 1, 69 | button: 0, 70 | ...clientPosition, 71 | eventConstructor: 'MouseEvent', 72 | ...this.options.target, 73 | }) 74 | .then(() => { 75 | if (isAttached(this.targetElement)) { 76 | this.target.trigger('pointerup', { 77 | which: 1, 78 | button: 0, 79 | ...clientPosition, 80 | eventConstructor: 'PointerEvent', 81 | ...this.options.target, 82 | }) 83 | } 84 | }) 85 | } 86 | }) 87 | }, 88 | dragover(clientPosition = {}) { 89 | if (!this.counter || (!this.dropped && this.hasTriesLeft)) { 90 | this.counter += 1 91 | return this.target 92 | .trigger('dragover', { 93 | dataTransfer, 94 | eventConstructor: 'DragEvent', 95 | ...this.options.target, 96 | }) 97 | .trigger('mousemove', { 98 | ...this.options.target, 99 | ...clientPosition, 100 | eventConstructor: 'MouseEvent', 101 | }) 102 | .trigger('pointermove', { 103 | ...this.options.target, 104 | ...clientPosition, 105 | eventConstructor: 'PointerEvent', 106 | }) 107 | .wait(this.DELAY_INTERVAL_MS) 108 | .then(() => this.dragover(clientPosition)) 109 | } 110 | if (!this.dropped) { 111 | console.error(`Exceeded maximum tries of: ${this.MAX_TRIES}, aborting`) 112 | return false 113 | } else { 114 | return true 115 | } 116 | }, 117 | init(source, target, options = {}) { 118 | this.options = this.createDefaultOptions(options) 119 | this.counter = 0 120 | this.source = source.get(0) 121 | this.initialSourcePosition = this.source.getBoundingClientRect() 122 | return cy.get(target).then((targetWrapper) => { 123 | this.target = targetWrapper.get(0) 124 | }) 125 | }, 126 | drag(sourceWrapper, targetSelector, options) { 127 | this.init(sourceWrapper, targetSelector, options) 128 | .then(() => this.dragstart()) 129 | .then(() => this.dragover()) 130 | .then((success) => { 131 | if (success) { 132 | return this.drop().then(() => true) 133 | } else { 134 | return false 135 | } 136 | }) 137 | }, 138 | move(sourceWrapper, options) { 139 | const { deltaX, deltaY } = options 140 | const { top, left } = sourceWrapper.offset() 141 | const finalCoords = { clientX: left + deltaX, clientY: top + deltaY } 142 | this.init(sourceWrapper, sourceWrapper, options) 143 | .then(() => this.dragstart({ clientX: left, clientY: top })) 144 | .then(() => this.dragover(finalCoords)) 145 | .then(() => this.drop(finalCoords)) 146 | }, 147 | } 148 | 149 | function addChildCommand(name, command) { 150 | Cypress.Commands.add(name, { prevSubject: 'element' }, (...args) => command(...args)) 151 | } 152 | 153 | addChildCommand('drag', DragSimulator.drag.bind(DragSimulator)) 154 | addChildCommand('move', DragSimulator.move.bind(DragSimulator)) 155 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "@4tw/cypress-drag-drop", 3 | "version": "2.3.0", 4 | "description": "A cypress child command for drag'n'drop support.", 5 | "main": "index.js", 6 | "types": "index.d.ts", 7 | "scripts": { 8 | "lint": "eslint --ext .js,.vue --ignore-path .gitignore .", 9 | "test": "NODE_OPTIONS=--openssl-legacy-provider webpack-dev-server & cypress open", 10 | "test:ci": "NODE_OPTIONS=--openssl-legacy-provider webpack-dev-server & cypress run", 11 | "release": "yarn run lint && yarn run test:ci && release-it" 12 | }, 13 | "prettier": "@4tw/prettier-config", 14 | "repository": { 15 | "type": "git", 16 | "url": "git+https://github.com/4teamwork/cypress-drag-drop.git" 17 | }, 18 | "keywords": [ 19 | "cypress", 20 | "test", 21 | "drag", 22 | "drop", 23 | "javascript" 24 | ], 25 | "author": "Kevin Bieri", 26 | "license": "GPL-3.0", 27 | "bugs": { 28 | "url": "https://github.com/4teamwork/cypress-drag-drop/issues" 29 | }, 30 | "homepage": "https://github.com/4teamwork/cypress-drag-drop#readme", 31 | "devDependencies": { 32 | "@4tw/eslint-config": "^0.6.0", 33 | "@4tw/prettier-config": "^1.0.3", 34 | "@release-it/keep-a-changelog": "^2.3.0", 35 | "@testing-library/cypress": "^7.0.2", 36 | "css-loader": "^3.4.0", 37 | "cypress": "^14.0.0", 38 | "eslint": "^7.15.0", 39 | "prettier": "^2.2.1", 40 | "release-it": "^14.11.5", 41 | "vue": "^2.6.12", 42 | "vue-loader": "^15.9.5", 43 | "vue-style-loader": "^4.1.2", 44 | "vue-template-compiler": "^2.6.12", 45 | "vuedraggable": "^2.24.3", 46 | "webpack": "^4.41.4", 47 | "webpack-cli": "^3.3.10", 48 | "webpack-dev-server": "^3.11.0" 49 | }, 50 | "peerDependencies": { 51 | "cypress": "2 - 14" 52 | } 53 | } 54 | -------------------------------------------------------------------------------- /src/App.vue: -------------------------------------------------------------------------------- 1 | 7 | 8 | 18 | 42 | -------------------------------------------------------------------------------- /src/examples/Basic.vue: -------------------------------------------------------------------------------- 1 | 11 | 12 | 23 | -------------------------------------------------------------------------------- /src/examples/Detach.vue: -------------------------------------------------------------------------------- 1 | 18 | 19 | 31 | -------------------------------------------------------------------------------- /src/examples/Force.vue: -------------------------------------------------------------------------------- 1 | 12 | 13 | 24 | 34 | -------------------------------------------------------------------------------- /src/examples/Move.vue: -------------------------------------------------------------------------------- 1 | 11 | 12 | 54 | 55 | 65 | -------------------------------------------------------------------------------- /src/examples/MoveOnMouseUp.vue: -------------------------------------------------------------------------------- 1 | 10 | 11 | 51 | 52 | 62 | -------------------------------------------------------------------------------- /src/examples/NotDraggable.vue: -------------------------------------------------------------------------------- 1 | 7 | 8 | 13 | -------------------------------------------------------------------------------- /src/examples/index.js: -------------------------------------------------------------------------------- 1 | import path from 'path' 2 | import Vue from 'vue' 3 | 4 | /** 5 | * Automatically loads all examples 6 | * and initializes according components in Vue. 7 | * See https://goo.gl/NqtXNE 8 | */ 9 | 10 | function resolveComponents(components) { 11 | return components.keys().map((fileName) => { 12 | // Get component config 13 | const component = components(fileName) 14 | 15 | // Get PascalCase name of component 16 | const name = path.basename(fileName).replace('.vue', '') 17 | 18 | // Look for the component options on `.default`, which will 19 | // exist if the component was exported with `export default`, 20 | // otherwise fall back to module's root. 21 | return { component: component.default || component, name, fileName } 22 | }) 23 | } 24 | 25 | const requireLocalComponents = require.context( 26 | // The relative path of the components folder 27 | './', 28 | // Whether or not to look in subfolders 29 | true, 30 | // The regular expression used to match base component filenames 31 | /\.(vue)$/, 32 | ) 33 | 34 | const registeredComponents = Object.keys(Vue.options.components) 35 | 36 | // Register local components globally 37 | resolveComponents(requireLocalComponents).forEach(({ name, component, fileName }) => { 38 | if (registeredComponents.includes(name)) { 39 | throw new Error( 40 | `Naming clash: The component under ${fileName} could not be registered, because there is already a component with the same name registered.`, 41 | ) 42 | } 43 | Vue.component(name, component) 44 | }) 45 | -------------------------------------------------------------------------------- /src/index.js: -------------------------------------------------------------------------------- 1 | import Vue from 'vue' 2 | import Vuedraggable from 'vuedraggable' 3 | import App from './App.vue' 4 | import './examples' 5 | 6 | Vue.component('draggable', Vuedraggable) 7 | 8 | new Vue({ 9 | render: (h) => h(App), 10 | }).$mount('#app') 11 | -------------------------------------------------------------------------------- /tests/specs/basic.cy.js: -------------------------------------------------------------------------------- 1 | describe('Drag drop', () => { 2 | it('should be able to drag and drop elements', () => { 3 | cy.visit('/') 4 | 5 | cy.setExample('Basic') 6 | 7 | cy.findByTestId('left').find('.item').assertList(['1', '2', '3', '4', '5', '6']) 8 | 9 | cy.findByTestId('item-1') 10 | .drag('[data-testid="right"]', { target: { position: 'left' } }) 11 | .then((success) => { 12 | assert.isTrue(success) 13 | }) 14 | 15 | cy.findByTestId('right').find('.item').assertList(['1']) 16 | 17 | cy.findByTestId('left').find('.item').assertList(['2', '3', '4', '5', '6']) 18 | }) 19 | }) 20 | -------------------------------------------------------------------------------- /tests/specs/detach.cy.js: -------------------------------------------------------------------------------- 1 | describe('Drag drop', () => { 2 | it('should not throw error when element is detached on drop', () => { 3 | cy.visit('/') 4 | 5 | cy.setExample('Detach') 6 | 7 | cy.findByTestId('item-1').drag('[data-testid="right"]') 8 | }) 9 | }) 10 | -------------------------------------------------------------------------------- /tests/specs/force.cy.js: -------------------------------------------------------------------------------- 1 | describe('Drag drop', () => { 2 | it('should be able to drag and drop elements through elements using force', () => { 3 | cy.visit('/') 4 | 5 | cy.setExample('Force') 6 | 7 | cy.findByTestId('left').find('.item').assertList(['1', '2', '3', '4', '5', '6']) 8 | 9 | cy.findByTestId('item-1').drag('[data-testid="right"]', { force: true }) 10 | 11 | cy.findByTestId('right').find('.item').assertList(['1']) 12 | 13 | cy.findByTestId('left').find('.item').assertList(['2', '3', '4', '5', '6']) 14 | }) 15 | }) 16 | -------------------------------------------------------------------------------- /tests/specs/move.cy.js: -------------------------------------------------------------------------------- 1 | describe('Drag drop', () => { 2 | it('should be able to move elements', () => { 3 | cy.visit('/') 4 | 5 | cy.setExample('Move') 6 | 7 | cy.findByTestId('draggable').should((target) => { 8 | const { top, left } = target.offset() 9 | expect(top).to.be.equal(10) 10 | expect(left).to.be.equal(20) 11 | }) 12 | 13 | cy.findByTestId('draggable').move({ deltaX: 30, deltaY: 40 }) 14 | 15 | cy.findByTestId('draggable').should('have.css', 'transform', 'matrix(1, 0, 0, 1, 30, 40)') 16 | cy.findByTestId('draggable').should((target) => { 17 | const { top, left } = target.offset() 18 | expect(top).to.be.equal(50) 19 | expect(left).to.be.equal(50) 20 | }) 21 | }) 22 | 23 | it('should trigger mouseup at the final mouse location', () => { 24 | cy.visit('/') 25 | 26 | cy.setExample('MoveOnMouseUp') 27 | 28 | cy.findByTestId('draggable').should((target) => { 29 | const { top, left } = target.offset() 30 | expect(top).to.be.equal(10) 31 | expect(left).to.be.equal(20) 32 | }) 33 | 34 | cy.findByTestId('draggable').move({ deltaX: 30, deltaY: 40 }) 35 | 36 | cy.findByTestId('draggable').should('have.css', 'transform', 'matrix(1, 0, 0, 1, 30, 40)') 37 | cy.findByTestId('draggable').should((target) => { 38 | const { top, left } = target.offset() 39 | expect(top).to.be.equal(50) 40 | expect(left).to.be.equal(50) 41 | }) 42 | }) 43 | }) 44 | -------------------------------------------------------------------------------- /tests/specs/not-draggable.cy.js: -------------------------------------------------------------------------------- 1 | describe('Drag drop', () => { 2 | it('should catch no draggable elements', () => { 3 | cy.visit('/') 4 | 5 | cy.setExample('NotDraggable') 6 | 7 | cy.findByTestId('not-draggable') 8 | .drag('[data-testid="target"]') 9 | .then((success) => { 10 | assert.isFalse(success) 11 | }) 12 | }) 13 | }) 14 | -------------------------------------------------------------------------------- /tests/support/commands.js: -------------------------------------------------------------------------------- 1 | import '@testing-library/cypress/add-commands' 2 | import '../../index' 3 | 4 | Cypress.Commands.add( 5 | 'assertList', 6 | { 7 | prevSubject: true, 8 | }, 9 | (subject, expected) => { 10 | cy.wrap(subject).should((items) => { 11 | expect(items.get().map((a) => a.textContent)).to.deep.equal(expected) 12 | }) 13 | }, 14 | ) 15 | 16 | Cypress.Commands.add('setExample', (example) => { 17 | cy.findByTestId('activeExample').clear().type(example, { delay: 0 }) 18 | }) 19 | -------------------------------------------------------------------------------- /tests/support/index.js: -------------------------------------------------------------------------------- 1 | // *********************************************************** 2 | // This example support/index.js is processed and 3 | // loaded automatically before your test files. 4 | // 5 | // This is a great place to put global configuration and 6 | // behavior that modifies Cypress. 7 | // 8 | // You can change the location of this file or turn off 9 | // automatically serving support files with the 10 | // 'supportFile' configuration option. 11 | // 12 | // You can read more here: 13 | // https://on.cypress.io/configuration 14 | // *********************************************************** 15 | 16 | import './commands' 17 | 18 | Cypress.Screenshot.defaults({ screenshotOnRunFailure: false }) 19 | 20 | before(function before() { 21 | // Do not truncate assertion outputs of arrays and objects 22 | window.chai.config.truncateThreshold = 0 23 | }) 24 | -------------------------------------------------------------------------------- /webpack.config.js: -------------------------------------------------------------------------------- 1 | const VueLoaderPlugin = require('vue-loader/lib/plugin') 2 | 3 | module.exports = { 4 | module: { 5 | rules: [ 6 | // ... other rules 7 | { 8 | test: /\.vue$/, 9 | loader: 'vue-loader', 10 | }, 11 | { 12 | test: /\.css$/, 13 | use: ['vue-style-loader', 'css-loader'], 14 | }, 15 | ], 16 | }, 17 | plugins: [ 18 | // make sure to include the plugin! 19 | new VueLoaderPlugin(), 20 | ], 21 | devServer: { 22 | port: process.env.PORT1 || 8080, 23 | }, 24 | } 25 | --------------------------------------------------------------------------------