├── .gitignore ├── LICENSE ├── boot.properties ├── build.boot ├── resources ├── docs.cljs.edn └── index.html ├── src ├── docs │ └── om_mantras │ │ ├── docs.cljs │ │ └── docs │ │ ├── selectable.cljs │ │ └── sortable.cljs └── main │ └── om_mantras │ ├── core.cljs │ ├── selectable.cljs │ ├── sortable.cljs │ └── util.cljs └── update-gh-pages /.gitignore: -------------------------------------------------------------------------------- 1 | /target/ 2 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 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 Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published by 637 | the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | -------------------------------------------------------------------------------- /boot.properties: -------------------------------------------------------------------------------- 1 | BOOT_CLOJURE_VERSION=1.7.0 2 | BOOT_VERSION=2.2.0 3 | -------------------------------------------------------------------------------- /build.boot: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env boot 2 | 3 | (set-env! 4 | :source-paths #{"src/docs" "src/main"} 5 | :resource-paths #{"resources" "src/main"} 6 | :dependencies '[; Boot setup 7 | [adzerk/boot-cljs "1.7.170-1"] 8 | [adzerk/boot-reload "0.4.1"] 9 | [adzerk/bootlaces "0.1.13"] 10 | [pandeiro/boot-http "0.7.0-SNAPSHOT"] 11 | 12 | ; Library dependencies 13 | [org.clojure/clojurescript "1.7.170"] 14 | [org.omcljs/om "1.0.0-alpha18-SNAPSHOT"] 15 | 16 | ; Development dependencies 17 | [devcards "0.2.0-8"] 18 | [garden "1.3.0-SNAPSHOT"]]) 19 | 20 | (require '[adzerk.boot-cljs :refer [cljs]] 21 | '[adzerk.bootlaces :refer :all] 22 | '[adzerk.boot-reload :refer [reload]] 23 | '[boot.git :refer [last-commit]] 24 | '[pandeiro.boot-http :refer [serve]]) 25 | 26 | (def version "0.1.0-alpha3-SNAPSHOT") 27 | 28 | (bootlaces! version) 29 | 30 | (task-options! 31 | push {:repo "deploy" 32 | :ensure-branch "master" 33 | :ensure-clean true 34 | :ensure-tag (last-commit) 35 | :ensure-version version} 36 | pom {:project 'om-mantras 37 | :version version 38 | :description "A collection of truly reusable components for Om (Next)" 39 | :url "https://github.com/jannis/om-mantras" 40 | :scm {:url "https://github.com/jannis/om-mantras"} 41 | :license {"GNU Affero General Public License Version 3" 42 | "http://www.gnu.org/licenses/agpl-3.0.en.html"}}) 43 | 44 | (deftask build-dev 45 | [] 46 | (comp 47 | (cljs :source-map true 48 | :optimizations :none 49 | :pretty-print true 50 | :compiler-options {:devcards true}))) 51 | 52 | (deftask build-docs 53 | [] 54 | (comp 55 | (cljs :optimizations :advanced 56 | :pretty-print false 57 | :compiler-options {:devcards true}))) 58 | 59 | (deftask dev 60 | [] 61 | (comp 62 | (watch) 63 | (reload) 64 | (build-dev) 65 | (serve :dir "target"))) 66 | 67 | (deftask docs 68 | [] 69 | (comp 70 | (build-docs))) 71 | -------------------------------------------------------------------------------- /resources/docs.cljs.edn: -------------------------------------------------------------------------------- 1 | {:require [om-mantras.docs]} 2 | -------------------------------------------------------------------------------- /resources/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Om Mantras / Documentation 5 | 6 | 7 | 8 | 9 | 10 | -------------------------------------------------------------------------------- /src/docs/om_mantras/docs.cljs: -------------------------------------------------------------------------------- 1 | (ns om-mantras.docs 2 | (:require [devcards.core :refer-macros [defcard start-devcard-ui!]] 3 | [om-mantras.docs.selectable] 4 | [om-mantras.docs.sortable])) 5 | 6 | (enable-console-print!) 7 | 8 | (start-devcard-ui!) 9 | 10 | (defcard 11 | "# Om Mantras 12 | 13 | Om Mantras are a collection of truly reusable, generic components for 14 | Om (Next). Often, generic components are released with predefined styles, 15 | expectations on what the data should look like, or even assumptions about 16 | your app state and its structure. 17 | 18 | Om Mantras make none of these assumptions. They follow three principles: 19 | 20 | 1. They come unstyled by default, but provide logical CSS classes to give 21 | you full freedom to style them the way you want. 22 | 2. They accept generic data (either single data items or collections of them) 23 | and allow you to extract the bits needed for items to be identified and 24 | rendered via your own functions. 25 | 3. They operate in isolation from your app state but allow you to integrate 26 | them into your apps by defining callbacks that can then mutate your app 27 | state. 28 | 29 | ## Example interface 30 | 31 | ``` 32 | (sortable {:items 33 | :key-fn (fn [item] ) 34 | :element-fn (fn [item] ) 35 | :change-fn (fn [items] )}) 36 | ``` 37 | 38 | ## Usage 39 | 40 | First, you have to add the following dependency to your project, e.g. 41 | in `project.clj` or `build.boot`: 42 | 43 | ``` 44 | [\"om-mantras\" \"0.1.0-alpha3-SNAPSHOT\"] 45 | ``` 46 | 47 | To use the components in your app, require `om-mantras.` and 48 | create components just like you would do with any other components written 49 | using Om (Next): 50 | 51 | ``` 52 | (ns yourapp.some-ns 53 | (:require [om-mantras.sortable :refer [sortable]])) 54 | 55 | (defui YourComponent 56 | Object 57 | (render [this] 58 | (dom/div nil 59 | (sortable {:items ... 60 | :key-fn ... 61 | :element-fn ... 62 | :change-fn ...})))) 63 | ```") 64 | -------------------------------------------------------------------------------- /src/docs/om_mantras/docs/selectable.cljs: -------------------------------------------------------------------------------- 1 | (ns om-mantras.docs.selectable 2 | (:require [clojure.string :refer [join split]] 3 | [devcards.core :refer-macros [defcard defcard-doc]] 4 | [garden.core :refer [css]] 5 | [om.dom :as dom] 6 | [om-mantras.selectable :refer [selectable]])) 7 | 8 | (defcard-doc 9 | "# Selectable 10 | 11 | Selectable is a reusable Om Next component for selecting multiple items 12 | from a collection. It is based on text input and provides a mechanism to 13 | filter matches rendered in a popup. Selectable can be used in flexible 14 | ways, preserves all freedom of styling and allows custom elements to be 15 | defined for the items and matches in the popup. It also supports a callback 16 | to notify the outside world whenever the selected items have changed.") 17 | 18 | (defcard-doc 19 | "## Known issues 20 | 21 | * When the user clicks somewhere outside the Selectable, the matches 22 | popup should disappear.") 23 | 24 | (defcard-doc 25 | "## Interface 26 | 27 | Selectable is created as follows: 28 | 29 | ``` 30 | (selectable {:items ... 31 | :key-fn ... 32 | :element-fn ... 33 | :match-fn ... 34 | :match-element-fn ... 35 | :change-fn ...}) 36 | ``` 37 | 38 | ### Parameters 39 | 40 | * `items` (mandatory) - a collection of items; these can be anything: 41 | numbers, strings, maps, vectors, it doesn't matter 42 | * `key-fn` (optional but recommended) - a function that takes one argument, 43 | an item, and must return a unique key for the item in the collection; can 44 | be omitted if the items themselves are distinct strings or numbers 45 | * `element-fn` (optional but recommended) - a function that takes one 46 | argument, an item, and must return a React element for the item; inside 47 | Selectable, the returned elements are each wrapped in a 48 | `
`; can be omitted if the items are 49 | strings, numbers or anything else that converts to a string that browsers 50 | can display 51 | * `match-fn` (optional but recommended) - a function that takes two 52 | arguments, an item and the text currently entered into the Selectable; 53 | the function must return a true-ish value if the item is to be included 54 | in the matches for the text 55 | * `match-element-fn` (optional but recommended) - a function that takes 56 | on argument, an item, and must return a React element for the item; this 57 | element is then rendered inside a `
` in 58 | the popup showing the matches for the current text; can be omitted if the 59 | items are strings, numbers or anything else that converts to a string that 60 | browsers can display 61 | * `change-fn` (optional) - a function that takes one argument, an ordered 62 | collection of a subset of the input items; this function is called 63 | whenever the selected items change; it can be used to sync the change to 64 | your application state") 65 | 66 | (defcard 67 | "## Keyboard navigation 68 | 69 | In addition to typing text into the selectable, special behaviour is 70 | defined for the following keys: 71 | 72 | * *Backspace* - removes the selected item before the caret 73 | * *Delete* - removes the selected item after the caret 74 | * *Escape* - hides the matches popup 75 | * *Return* - adds the highlighted match in the popup to the selection 76 | * *Up* - highlights the previous match in the popup 77 | * *Down* - highlights the next match in the popup 78 | * *Left* - moves the caret to the left 79 | * *Right* - moves the caret to the right 80 | * *Home* - moves the caret to the beginning of the selection 81 | * *End* - moves the caret to the end of the selection") 82 | 83 | (defcard-doc 84 | "## Usage examples") 85 | 86 | (defn style-container1 [child] 87 | (dom/div #js {:className "style-container1"} 88 | (dom/style nil 89 | (css [:.style-container1 {} 90 | [[:.selectable {:box-sizing "border-box" 91 | :border "thin solid #ddd" 92 | :position "relative" 93 | :padding "5px" 94 | :padding-left "5px"}] 95 | [:.selectable-selected-item {:display "inline-block" 96 | :padding "5px" 97 | :margin-right "5px" 98 | :background "#00b8d4" 99 | :color "#fff"}] 100 | [:.selectable-input-box {:display "inline-block"}] 101 | [:.selectable-input {:padding "5px" 102 | :padding-left "0px" 103 | :margin "0"}] 104 | [:.selectable-matches {:position "absolute" 105 | :top "100%" 106 | :left 0 107 | :z-index 99 108 | :box-sizing "border-box" 109 | :width "100%" 110 | :background "#fff" 111 | :border-left "thin solid #ddd" 112 | :border-right "thin solid #ddd" 113 | :border-bottom "thin solid #ddd"}] 114 | [:.selectable-match {:padding "5px"}] 115 | [:.selectable-match-active {:background "#eee"}]]])) 116 | child)) 117 | 118 | (defcard 119 | "Selectable list of numbers 120 | 121 | ``` 122 | (selectable {:items (:numbers @state) 123 | :key-fn identity 124 | :match-fn #(re-matches (re-pattern (str \".*\" %2 \".*\")) 125 | (str %1)) 126 | :change-fn #(swap! state assoc :selected %)}) 127 | ```" 128 | (fn [state _] 129 | (style-container1 130 | (selectable {:items (:numbers @state) 131 | :key-fn identity 132 | :match-fn #(re-matches (re-pattern (str ".*" %2 ".*")) 133 | (str %1)) 134 | :change-fn #(swap! state assoc :selected %)}))) 135 | {:numbers [1 10 100 1000 2 25 250 1025 3330 130]} 136 | {:inspect-data true :history false}) 137 | 138 | (defcard 139 | "Selectable list of maps (blog posts), matched by tags. 140 | 141 | ``` 142 | (selectable {:items (:maps @state) 143 | :key-fn :id 144 | :element-fn #(dom/button nil (:title %)) 145 | :match-element-fn 146 | (fn [item] 147 | (dom/p nil 148 | (dom/strong nil (:title item)) 149 | (dom/span #js {:style #js {:marginLeft \"10px\"}} 150 | \"Tags: \" (join \", \" (:tags item))))) 151 | :match-fn 152 | (fn [item text] 153 | (let [pattern (re-pattern (str \".*\" text \".*\"))] 154 | (some #(re-matches pattern %) (:tags item)))) 155 | :change-fn #(swap! state assoc :selected %)}))) 156 | ```" 157 | (fn [state _] 158 | (style-container1 159 | (selectable {:items (:maps @state) 160 | :key-fn :id 161 | :element-fn #(dom/button nil (:title %)) 162 | :match-element-fn 163 | (fn [item] 164 | (dom/p nil 165 | (dom/strong nil (:title item)) 166 | (dom/span #js {:style #js {:marginLeft "10px"}} 167 | "Tags: " (join ", " (:tags item))))) 168 | :match-fn 169 | (fn [item text] 170 | (let [pattern (re-pattern (str ".*" text ".*"))] 171 | (some #(re-matches pattern %) (:tags item)))) 172 | :change-fn #(swap! state assoc :selected %)}))) 173 | {:maps [{:id 1 :title "Post 1" :tags ["personal" "work"]} 174 | {:id 2 :title "Post 3" :tags ["work"]} 175 | {:id 3 :title "Post 4" :tags ["personal" "work" "community"]}]} 176 | {:inspect-data true :history false}) 177 | 178 | (defcard 179 | "Basic styling 180 | 181 | ``` 182 | .selectable { 183 | position: relative; 184 | box-sizing: border-box; 185 | border: thin solid #ddd; 186 | padding: 5px; 187 | padding-left: 5px; 188 | } 189 | 190 | .selectable-selected-item { 191 | display: inline-block; 192 | margin-right: 5px; 193 | padding: 5px; 194 | background: #00b8d4; 195 | color: #fff; 196 | } 197 | 198 | .selectable-input-box { 199 | display: inline-block; 200 | } 201 | 202 | .selectable-input { 203 | margin: 0; 204 | padding: 5px; 205 | padding-left: 0px; 206 | } 207 | 208 | .selectable-matches { 209 | position: absolute; 210 | width: 100%; 211 | top: 100%; 212 | left: 0; 213 | z-index: 99; 214 | box-sizing: border-box; 215 | border-bottom: thin solid #ddd; 216 | border-left: thin solid #ddd; 217 | border-right: thin solid #ddd; 218 | background: #fff; 219 | } 220 | 221 | .selectable-match { 222 | padding: 5px; 223 | } 224 | 225 | .selectable-match-active { 226 | background: #eee; 227 | } 228 | ```" 229 | (fn [state _] 230 | (style-container1 231 | (selectable {:items (:items @state) 232 | :key-fn identity 233 | :match-fn #(re-matches (re-pattern (str ".*" %2 ".*")) %1) 234 | :change-fn #(swap! state assoc :selected %)}))) 235 | {:items ["First" "Second" "Third" "Fourth" "Fifth"]} 236 | {:inspect-data true :history false}) 237 | -------------------------------------------------------------------------------- /src/docs/om_mantras/docs/sortable.cljs: -------------------------------------------------------------------------------- 1 | (ns om-mantras.docs.sortable 2 | (:require [clojure.string :refer [split]] 3 | [devcards.core :refer-macros [defcard defcard-doc]] 4 | [garden.core :refer [css]] 5 | [om.dom :as dom] 6 | [om-mantras.sortable :refer [sortable]])) 7 | 8 | (defcard-doc 9 | "# Sortable 10 | 11 | Sortable is a reusable Om Next component for rendering an ordered 12 | collection of items as a vertical or horizontal list and reordering 13 | its items using drag and drop. Sortable can be used in flexible ways, 14 | preserves all freedom of styling and allows custom elements to be 15 | defined for the items. It also supports a callback to notify the 16 | outside world whenever the order of items has changed.") 17 | 18 | (defcard-doc 19 | "## Interface 20 | 21 | Sortable is created as follows: 22 | 23 | ``` 24 | (sortable {:items ... 25 | :direction ... 26 | :key-fn ... 27 | :element-fn ... 28 | :change-fn ...}) 29 | ``` 30 | 31 | ### Parameters 32 | 33 | * `items` (mandatory) - an ordered collection of items; these can be anything: 34 | numbers, strings, maps, vectors, it doesn't matter 35 | * `direction` (optional) - the direction along which the items are rendered; 36 | either `:vertical` (default) or `:horizontal`; this has no effect on 37 | rendering, it only affects how the drag position is calculated 38 | * `key-fn` (optional but recommended) - a function that takes one argument, 39 | an item, and must return a unique key for the item in the collection; can 40 | be omitted if the items themselves are distinct strings or numbers 41 | * `element-fn` (optional but recommended) - a function that takes one 42 | argument, an item, and must return a React element for the item; inside 43 | Sortable, the returned elements are each wrapped in a 44 | `
`; can be optional if the items are strings, 45 | numbers or anything else that converts to a string that browsers can 46 | display 47 | * `change-fn` (optional) - a function that takes one argument, a reordered 48 | collection of the input items; this function is called whenever the items 49 | are reordered using drag and drop; it can be used to sync the change to 50 | your application state") 51 | 52 | (defcard-doc 53 | "## Usage examples") 54 | 55 | (defcard 56 | "Sortable list of numbers 57 | 58 | ``` 59 | (sortable {:items (:numbers @state) 60 | :key-fn identity 61 | :change-fn (fn [items] 62 | (js/alert items) 63 | (swap! state assoc :numbers items))}) 64 | ```" 65 | (fn [state _] 66 | (sortable {:items (:numbers @state) 67 | :change-fn (fn [items] 68 | (js/alert items) 69 | (swap! state assoc :numbers items))})) 70 | {:numbers [1 2 3 4]} 71 | {:inspect-data true :history true}) 72 | 73 | (defcard 74 | "Sortable list of maps 75 | 76 | ``` 77 | (sortable {:items (:maps @state) 78 | :key-fn :id 79 | :element-fn #(dom/span nil (str (:id %) \" - \" (:text %))) 80 | :change-fn (fn [items] 81 | (swap! state assoc :maps items))}) 82 | ```" 83 | (fn [state _] 84 | (sortable {:items (:maps @state) 85 | :key-fn :id 86 | :element-fn #(dom/span nil (str (:id %) " - " (:text %))) 87 | :change-fn (fn [items] 88 | (swap! state assoc :maps items))})) 89 | {:maps [{:id 1 :text "Foo"} {:id 2 :text "Bar"} {:id 3 :text "Baz"}]} 90 | {:inspect-data true :history true}) 91 | 92 | (defcard 93 | "Sortable list of vectors 94 | 95 | ``` 96 | (sortable {:items (:vectors @state) 97 | :key-fn first 98 | :element-fn #(dom/span nil (str (first %) \" - \" (second %))) 99 | :change-fn (fn [items] 100 | (swap! state assoc :vectors items))}) 101 | ```" 102 | (fn [state _] 103 | (sortable {:items (:vectors @state) 104 | :key-fn first 105 | :element-fn #(dom/span nil (str (first %) " - " (second %))) 106 | :change-fn (fn [items] 107 | (swap! state assoc :vectors items))})) 108 | {:vectors [[1 "Foo"] [2 "Bar"] [3 "Baz"]]} 109 | {:inspect-data true :history true}) 110 | 111 | (defcard-doc 112 | "## Styling 113 | 114 | Sortable can be styled freely. It defines three CSS classes that you 115 | can customize to whatever degree you like. They are: 116 | 117 | * `.sortable` - set on the sortable container (a `div`) 118 | * `.sortable-item` - set on the items (`div`) that wrap the elements 119 | created for each item in the collection 120 | * `.sortable-item-dragged` - set on the item that is currently being 121 | dragged 122 | 123 | In addition, the selector `.sortable-item-dragged *` is often useful 124 | to hide the content of the item currently being dragged or apply other 125 | transformations (opacity, scaling etc.) to it. 126 | 127 | ### Vertical vs. horizontal 128 | 129 | Styling is entirely up to your app. The `:direction` parameter that can 130 | be passed to Sortable does not affect rendering in any way. The HTML element 131 | structure of Sortable looks like this: 132 | 133 | ``` 134 |
135 |
136 | Some item 137 |
138 |
139 | Another item 140 |
141 |
142 | Dragged item 143 |
144 |
145 | ``` 146 | 147 | Since `div`s are, by default, rendered as block elements, the default 148 | rendering is vertical. To change Sortable to be horizontal, your app 149 | can employ style hints like 150 | 151 | ``` 152 | .sortable-item { display: inline-block; } 153 | ``` 154 | 155 | or even 156 | 157 | ``` 158 | .sortable { display: table; } 159 | .sortable-item { display: table-cell; } 160 | ```") 161 | 162 | (defcard-doc 163 | "### Styling examples") 164 | 165 | (defcard 166 | "No styling at all" 167 | (fn [state _] 168 | (sortable {:items (:items @state) 169 | :change-fn #(swap! state assoc :items %)})) 170 | {:items ["First" "Second" "Third" "Fourth" "Fifth"]} 171 | {:inspect-data true :history true}) 172 | 173 | (defn style-container1 [child] 174 | (dom/div #js {:className "style-container1"} 175 | (dom/style nil 176 | (css [:.style-container1 {} 177 | [[:.sortable {:border "thin solid #eee"}] 178 | [:.sortable-item {:margin "10px" 179 | :padding "10px" 180 | :border "thin solid #ddd" 181 | :background "#f8f8f8" 182 | :cursor "move"}]]])) 183 | child)) 184 | 185 | (defcard 186 | "Basic styling, excluding the dragged item 187 | 188 | ``` 189 | .sortable { 190 | border: thin solid #eee; 191 | } 192 | .sortable-item { 193 | margin: 10px; 194 | padding: 10px; 195 | border: thin solid #ddd; 196 | background: #f8f8f8; 197 | cursor: move; 198 | } 199 | ```" 200 | (fn [state _] 201 | (style-container1 202 | (sortable {:items (:items @state) 203 | :change-fn #(swap! state assoc :items %)}))) 204 | {:items ["First" "Second" "Third" "Fourth" "Fifth"]} 205 | {:inspect-data true :history true}) 206 | 207 | (defn style-container2 [child] 208 | (dom/div #js {:className "style-container2"} 209 | (dom/style nil 210 | (css [:.style-container2 {} 211 | [[:.sortable {:border "thin solid #eee"}] 212 | [:.sortable-item {:margin "10px" 213 | :padding "10px" 214 | :border "thin solid #ddd" 215 | :background "#f8f8f8" 216 | :cursor "move"}] 217 | [:.sortable-item-dragged {:opacity "0"}]]])) 218 | child)) 219 | 220 | (defcard 221 | "Hiding the dragged item to make it look like other items are 222 | pushed out of the way. 223 | 224 | ``` 225 | .sortable { 226 | border: thin solid #eee; 227 | } 228 | .sortable-item { 229 | margin: 10px; 230 | padding: 10px; 231 | border: thin solid #ddd; 232 | background: #f8f8f8; 233 | cursor: move; 234 | } 235 | .sortable-item-dragged { 236 | opacity: 0; 237 | } 238 | ```" 239 | (fn [state _] 240 | (style-container2 241 | (sortable {:items (:items @state) 242 | :change-fn #(swap! state assoc :items %)}))) 243 | {:items ["First" "Second" "Third" "Fourth" "Fifth"]} 244 | {:inspect-data true :history true}) 245 | 246 | (defn style-container3 [child] 247 | (dom/div #js {:className "style-container3"} 248 | (dom/style nil 249 | (css [:.style-container3 {} 250 | [[:.sortable {:border "thin solid #eee"}] 251 | [:.sortable-item {:margin "10px" 252 | :padding "10px" 253 | :border "thin solid #ddd" 254 | :background "#f8f8f8" 255 | :cursor "move"}] 256 | [:.sortable-item-dragged {:border "thin solid transparent"} 257 | [:* {:opacity "0"}]]]])) 258 | child)) 259 | 260 | (defcard 261 | "Hiding the contents of the dragged item to make it look like a drop area. 262 | 263 | ``` 264 | .sortable { 265 | border: thin solid #eee; 266 | } 267 | .sortable-item { 268 | margin: 10px; 269 | padding: 10px; 270 | border: thin solid #ddd; 271 | background: #f8f8f8; 272 | cursor: move; 273 | } 274 | .sortable-item-dragged { 275 | border: thin solid transparent; 276 | * { 277 | opacity: 0; 278 | } 279 | } 280 | ```" 281 | (fn [state _] 282 | (style-container3 283 | (sortable {:items (:items @state) 284 | :element-fn #(dom/span nil %) 285 | :change-fn #(swap! state assoc :items %)}))) 286 | {:items ["First" "Second" "Third" "Fourth" "Fifth"]} 287 | {:inspect-data true :history true}) 288 | 289 | (defn style-container4 [child] 290 | (dom/div #js {:className "style-container4"} 291 | (dom/style nil 292 | (css [:.style-container4 {} 293 | [[:.sortable {:padding "10px"}] 294 | [:.sortable-item {:margin "10px" 295 | :padding "10px" 296 | :background "#00b8d4" 297 | :color "#fff" 298 | :cursor "move" 299 | :transition "transform 0.1s ease-in"}] 300 | [:.sortable-item-dragged {:opacity "0.5" 301 | :transform "scale(0.8, 0.8)"}]]])) 302 | child)) 303 | 304 | (defcard 305 | "Applying a scale transition to the dragged item 306 | 307 | ``` 308 | .sortable { 309 | padding: 10px; 310 | } 311 | .sortable-item { 312 | margin: 10px; 313 | padding: 10px; 314 | background: #00b8d4; 315 | color: #fff; 316 | cursor: move; 317 | transition: transform 0.1s ease-in; 318 | } 319 | .sortable-item-dragged { 320 | opacity: 0.5; 321 | transform: scale(0.8, 0.8); 322 | } 323 | ```" 324 | (fn [state _] 325 | (style-container4 326 | (sortable {:items (:items @state) 327 | :element-fn #(dom/span nil %) 328 | :change-fn #(swap! state assoc :items %)}))) 329 | {:items ["First" "Second" "Third" "Fourth" "Fifth"]} 330 | {:inspect-data true :history true}) 331 | 332 | (defn style-container5 [child] 333 | (dom/div #js {:className "style-container5"} 334 | (dom/style nil 335 | (css [:.style-container5 {} 336 | [[:.sortable {:padding "10px"}] 337 | [:.sortable-item {:display "inline-block" 338 | :margin "10px" 339 | :background "#eee" 340 | :cursor "move"} 341 | [:* {:display "inline-block" 342 | :padding "10px" 343 | :background "#00b8d4" 344 | :color "#fff"}]] 345 | [:.sortable-item-dragged {} 346 | [:* {:opacity "0"}]]]])) 347 | child)) 348 | 349 | (defcard 350 | "Horizontal sortable with drop area look 351 | 352 | ``` 353 | .sortable { 354 | padding: 10px; 355 | } 356 | .sortable-item { 357 | display: inline-block; 358 | margin: 10px; 359 | background: #eee; 360 | cursor: move; 361 | * { 362 | display: inline-block; 363 | padding: 10px; 364 | background: #00b8d4; 365 | color: #fff; 366 | } 367 | } 368 | .sortable-item-dragged { 369 | * { opacity: 0; } 370 | } 371 | ```" 372 | (fn [state _] 373 | (style-container5 374 | (sortable {:items (:items @state) 375 | :direction :horizontal 376 | :element-fn #(dom/span nil %) 377 | :change-fn #(swap! state assoc :items %)}))) 378 | {:items ["First" "Second" "Third" "Fourth" "Fifth"]} 379 | {:inspect-data true :history true}) 380 | -------------------------------------------------------------------------------- /src/main/om_mantras/core.cljs: -------------------------------------------------------------------------------- 1 | (ns om-mantras.core) 2 | -------------------------------------------------------------------------------- /src/main/om_mantras/selectable.cljs: -------------------------------------------------------------------------------- 1 | (ns om-mantras.selectable 2 | (:require [om.next :as om :refer-macros [defui]] 3 | [om.dom :as dom] 4 | [om-mantras.util :refer [index-of]])) 5 | 6 | (defn selectable-key [x] 7 | (let [props (cond-> x (om/component? x) om/props) 8 | key-fn (:key-fn props)] 9 | (if key-fn 10 | (key-fn (:item props)) 11 | (:item props)))) 12 | 13 | (defui SelectableMatch 14 | Object 15 | (render [this] 16 | (let [{:keys [item key-fn match-element-fn hover-fn select-fn active?]} 17 | (om/props this)] 18 | (dom/div #js {:className (str "selectable-match" 19 | (when active? " selectable-match-active")) 20 | :style #js {:cursor "pointer"} 21 | :key (cond-> item key-fn key-fn) 22 | :onMouseOver #(some-> hover-fn (apply [this])) 23 | :onClick #(some-> select-fn (apply [this]))} 24 | (cond-> item match-element-fn match-element-fn))))) 25 | 26 | (def selectable-match (om/factory SelectableMatch {:keyfn selectable-key})) 27 | 28 | (defui SelectableInput 29 | Object 30 | (set-width [this n] 31 | (om/update-state! this assoc :width n)) 32 | 33 | (componentDidMount [this] 34 | (let [width (-> this (om/react-ref :input/hidden) .-offsetWidth)] 35 | (.set-width this width))) 36 | 37 | (componentDidUpdate [this old-props old-state] 38 | (let [width (-> this (om/react-ref :input/hidden) .-offsetWidth)] 39 | (when-not (= width (:width (om/get-state this))) 40 | (.set-width this width)))) 41 | 42 | (render [this] 43 | (let [{:keys [ref text key-down-fn change-fn]} (om/props this) 44 | {:keys [width]} (om/get-state this)] 45 | (dom/div #js {:ref ref 46 | :className "selectable-input-box"} 47 | (dom/span #js {:ref :input/hidden 48 | :style #js {:position "absolute" 49 | :left -9999 50 | :visibility "hidden"}} 51 | text) 52 | (dom/input #js {:ref :input/input 53 | :className "selectable-input" 54 | :style #js {:font "inherit" 55 | :border "none" 56 | :outline "none" 57 | :MozOutline "none" 58 | :WebkitOutline "none" 59 | :width (max 5 width)} 60 | :value text 61 | :onKeyDown #(some-> key-down-fn (apply [this %])) 62 | :onChange (fn [e] 63 | (some-> change-fn 64 | (apply [this (.. e -target -value)])) 65 | (.preventDefault e))}))))) 66 | 67 | (def selectable-input (om/factory SelectableInput)) 68 | 69 | (defui Selectable 70 | Object 71 | (matches-for-text [this text] 72 | (if (empty? text) 73 | (->> this om/props :items) 74 | (let [match-fn (:match-fn (om/props this))] 75 | (->> this om/props :items 76 | (filter #(cond-> % match-fn (match-fn text))))))) 77 | 78 | (update-matches [this] 79 | (->> this om/get-state :text 80 | (.matches-for-text this) 81 | (remove #(some #{%} (:selected (om/get-state this)))) 82 | (into []) 83 | (om/update-state! this assoc :matches))) 84 | 85 | (recalculate-active-match [this] 86 | (let [matches (:matches (om/get-state this))] 87 | (om/update-state! this update :active-match 88 | #(if (some #{%} matches) % (first matches))))) 89 | 90 | (update-text [this text] 91 | (om/update-state! this assoc :text text) 92 | (.update-matches this) 93 | (.recalculate-active-match this) 94 | (.show-matches this true)) 95 | 96 | (update-selected [this f] 97 | (let [selected (f (:selected (om/get-state this)))] 98 | (om/update-state! this assoc :selected selected) 99 | (some-> this om/props :change-fn (apply [selected])))) 100 | 101 | (select-match [this match] 102 | (let [match (cond-> match (om/component? match) (-> om/props :item)) 103 | caret (:caret (om/get-state this))] 104 | (.update-selected this 105 | (fn [selected] 106 | (let [[before after] (split-at caret selected)] 107 | (into [] (concat before [match] after)))))) 108 | (.update-caret this inc) 109 | (.update-text this "")) 110 | 111 | (show-matches [this show?] 112 | (om/update-state! this assoc :show-matches show?)) 113 | 114 | (focus [this e] 115 | (-> this 116 | (om/react-ref :input/box) 117 | (om/react-ref :input/input) 118 | dom/node 119 | .focus) 120 | (.show-matches this true)) 121 | 122 | (set-active-match [this child] 123 | (om/update-state! this assoc :active-match (-> child om/props :item))) 124 | 125 | (update-caret [this f] 126 | (let [selected (:selected (om/get-state this))] 127 | (om/update-state! this update :caret 128 | (fn [caret] 129 | (-> (f caret) 130 | (max 0) 131 | (min (count selected))))))) 132 | 133 | (key-backspace [this e] 134 | (when (empty? (:text (om/get-state this))) 135 | (let [caret (:caret (om/get-state this))] 136 | (.update-selected this 137 | (fn [selected] 138 | (let [[before after] (split-at caret selected)] 139 | (into [] (concat (butlast before) after)))))) 140 | (.update-caret this dec))) 141 | 142 | (key-delete [this e] 143 | (when (empty? (:text (om/get-state this))) 144 | (let [caret (:caret (om/get-state this))] 145 | (.update-selected this 146 | (fn [selected] 147 | (let [[before after] (split-at caret selected)] 148 | (into [] (concat before (rest after))))))) 149 | (.update-caret this identity))) 150 | 151 | (key-escape [this e] 152 | (.show-matches this false)) 153 | 154 | (key-return [this e] 155 | (some->> this om/get-state :active-match (.select-match this))) 156 | 157 | (key-up [this e] 158 | (let [{:keys [matches active-match]} (om/get-state this) 159 | index (index-of active-match matches)] 160 | (->> (max (dec index) 0) 161 | (get matches) 162 | (om/update-state! this assoc :active-match))) 163 | (.preventDefault e)) 164 | 165 | (key-down [this e] 166 | (let [{:keys [matches active-match]} (om/get-state this) 167 | index (index-of active-match matches)] 168 | (->> (min (inc index) (-> matches count (- 1))) 169 | (get matches) 170 | (om/update-state! this assoc :active-match))) 171 | (.preventDefault e)) 172 | 173 | (key-left [this e] 174 | (when (empty? (:text (om/get-state this))) 175 | (.update-caret this dec))) 176 | 177 | (key-right [this e] 178 | (when (empty? (:text (om/get-state this))) 179 | (.update-caret this inc))) 180 | 181 | (key-home [this e] 182 | (when (empty? (:text (om/get-state this))) 183 | (.update-caret this (constantly 0)))) 184 | 185 | (key-end [this e] 186 | (when (empty? (:text (om/get-state this))) 187 | (.update-caret this #(count (:selected (om/get-state this)))))) 188 | 189 | (key-press [this e] 190 | (case (.-keyCode e) 191 | 8 (.key-backspace this e) 192 | 46 (.key-delete this e) 193 | 27 (.key-escape this e) 194 | 13 (.key-return this e) 195 | 38 (.key-up this e) 196 | 40 (.key-down this e) 197 | 37 (.key-left this e) 198 | 39 (.key-right this e) 199 | 36 (.key-home this e) 200 | 35 (.key-end this e) 201 | true)) 202 | 203 | (componentWillMount [this] 204 | (.update-text this "") 205 | (.update-selected this (constantly [])) 206 | (.update-caret this (constantly 0)) 207 | (.show-matches this false)) 208 | 209 | (componentWillReceiveProps [this props] 210 | (.update-matches this)) 211 | 212 | (render [this] 213 | (let [{:keys [key-fn element-fn match-element-fn]} (om/props this) 214 | {:keys [text selected show-matches matches active-match caret]} 215 | (om/get-state this)] 216 | (dom/div #js {:className "selectable" 217 | :style #js {:cursor "text"} 218 | :onClick #(.focus this)} 219 | (for [item (take caret selected)] 220 | (dom/div #js {:className "selectable-selected-item" 221 | :key (cond-> item key-fn key-fn)} 222 | (cond-> item element-fn element-fn))) 223 | (selectable-input {:text text 224 | :ref :input/box 225 | :key-down-fn #(.key-press this %2) 226 | :change-fn #(.update-text this %2)}) 227 | (for [item (drop caret selected)] 228 | (dom/div #js {:className "selectable-selected-item" 229 | :key (cond-> item key-fn key-fn)} 230 | (cond-> item element-fn element-fn))) 231 | (when (and show-matches matches) 232 | (dom/div #js {:className "selectable-matches"} 233 | (for [match (remove #(some #{%} (or selected [])) matches)] 234 | (selectable-match {:item match 235 | :active? (and active-match 236 | (= active-match match)) 237 | :key-fn key-fn 238 | :match-element-fn match-element-fn 239 | :hover-fn #(.set-active-match this %) 240 | :select-fn #(.select-match this %)})))))))) 241 | 242 | (def selectable (om/factory Selectable)) 243 | -------------------------------------------------------------------------------- /src/main/om_mantras/sortable.cljs: -------------------------------------------------------------------------------- 1 | (ns om-mantras.sortable 2 | (:require [om.next :as om :refer-macros [defui]] 3 | [om.dom :as dom] 4 | [om-mantras.util :refer [index-of]])) 5 | 6 | (defn sortable-key [x] 7 | (let [props (cond-> x (om/component? x) om/props) 8 | key-fn (:key-fn props)] 9 | (if key-fn 10 | (key-fn (:item props)) 11 | (:item props)))) 12 | 13 | (defui SortableItem 14 | Object 15 | (render [this] 16 | (let [{:keys [item dragged element-fn drag-fns]} (om/props this)] 17 | (dom/div #js {:className (str "sortable-item" 18 | (when dragged 19 | " sortable-item-dragged")) 20 | :draggable true 21 | ; :style #js {:opacity (if dragged "0.0" "1.0")} 22 | :onDragStart #(some-> drag-fns :start (apply [% this])) 23 | :onDrag #(some-> drag-fns :drag (apply [% this])) 24 | :onDragEnd #(some-> drag-fns :end (apply [% this])) 25 | :onDragOver #(some-> drag-fns :over (apply [% this])) 26 | :onDrop #(some-> drag-fns :drop (apply [% this]))} 27 | (cond-> item element-fn element-fn))))) 28 | 29 | (def sortable-item (om/factory SortableItem {:keyfn sortable-key})) 30 | 31 | (defui Sortable 32 | Object 33 | (drag-start [this e child] 34 | (.. e -dataTransfer (setData "text/plain" (sortable-key child))) 35 | (let [item (-> child om/props :item)] 36 | (om/update-state! this assoc :drag-item item))) 37 | 38 | (drag [this e child] 39 | (om/update-state! this assoc :dragging true)) 40 | 41 | (drag-over [this e] 42 | (-> e .-dataTransfer .-dropEffect (set! "move")) 43 | (.preventDefault e)) 44 | 45 | (reorder-items [this drag-item target-item after? items] 46 | (->> items 47 | (split-at (-> target-item 48 | (index-of items) 49 | (cond-> after? inc))) 50 | (map #(remove #{drag-item} %)) 51 | ((fn [[before after]] (concat before [drag-item] after))))) 52 | 53 | (drag-over-child [this e child] 54 | (-> e .-dataTransfer .-dropEffect (set! "move")) 55 | (.preventDefault e) 56 | (let [drag-item (:drag-item (om/get-state this)) 57 | target-item (:item (om/props child))] 58 | (when (and drag-item (not= drag-item target-item)) 59 | (let [x (.-clientX e) 60 | y (.-clientY e) 61 | rect (-> child dom/node (.getBoundingClientRect)) 62 | center-x (-> (.-left rect) (+ (.-right rect)) (/ 2)) 63 | center-y (-> (.-top rect) (+ (.-bottom rect)) (/ 2)) 64 | after? (if (-> this om/props :direction (= :horizontal)) 65 | (>= x center-x) 66 | (>= y center-y)) 67 | items (or (:items (om/get-state this)) 68 | (:items (om/props this)))] 69 | (->> items 70 | (.reorder-items this drag-item target-item after?) 71 | (om/update-state! this assoc :items)))))) 72 | 73 | (drag-end [this e child] 74 | (.preventDefault e) 75 | (let [items (or (:items (om/get-state this)) 76 | (:items (om/props this)))] 77 | (some-> this om/props :change-fn (apply [items]))) 78 | (om/update-state! this (fn [state] (-> state 79 | (dissoc :drag-item) 80 | (dissoc :dragging))))) 81 | 82 | (drop [this e] 83 | (.preventDefault e)) 84 | 85 | (componentWillReceiveProps [this new-props] 86 | (om/update-state! this (fn [state] (-> state 87 | (dissoc :items) 88 | (dissoc :drag-item) 89 | (dissoc :dragging))))) 90 | 91 | (render [this] 92 | (let [{:keys [key-fn element-fn]} (om/props this) 93 | {:keys [dragging drag-item]} (om/get-state this)] 94 | (dom/div #js {:className "sortable" 95 | :dragOver #(.drag-over this %) 96 | :drop #(.drop this %)} 97 | (for [item (or (:items (om/get-state this)) 98 | (:items (om/props this)))] 99 | (sortable-item 100 | {:item item 101 | :dragged (and dragging drag-item (= item drag-item)) 102 | :key-fn key-fn 103 | :element-fn element-fn 104 | :drag-fns {:start #(.drag-start this %1 %2) 105 | :drag #(.drag this %1 %2) 106 | :end #(.drag-end this %1 %2) 107 | :over #(.drag-over-child this %1 %2) 108 | :drop #(.drop this %1)}})))))) 109 | 110 | (def sortable (om/factory Sortable)) 111 | -------------------------------------------------------------------------------- /src/main/om_mantras/util.cljs: -------------------------------------------------------------------------------- 1 | (ns om-mantras.util) 2 | 3 | (defn indexes-of [x coll] 4 | (keep-indexed #(when (= x %2) %1) coll)) 5 | 6 | (defn index-of [x coll] 7 | (first (indexes-of x coll))) 8 | -------------------------------------------------------------------------------- /update-gh-pages: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # Create temporary directory 4 | 5 | tmpdir=$(mktemp -d) 6 | 7 | # Copy the latest build to it 8 | 9 | cp -R target/docs.* target/*.html "$tmpdir" 10 | 11 | # Switch to the gh-pages branch 12 | git checkout gh-pages 13 | 14 | # Remove the old sources 15 | git rm -rf docs.* *.html 16 | 17 | # Copy the build into it 18 | cp -R "$tmpdir"/* . 19 | rm -rf "$tmpdir" 20 | 21 | # Determine the latest commit in master 22 | commit=$(git log -n1 --format="%H" master) 23 | 24 | # Create a new commit from the new sources 25 | git add docs.* *.html 26 | git commit -a -m "Update to $commit" 27 | 28 | # Push gh-pages to GitHub 29 | git push origin gh-pages:gh-pages 30 | 31 | # Switch back to master 32 | git checkout master 33 | --------------------------------------------------------------------------------