{"id":23156531,"url":"https://github.com/thecreation/jquery-asmodal","last_synced_at":"2026-03-11T17:01:23.901Z","repository":{"id":8379657,"uuid":"9951692","full_name":"thecreation/jquery-asModal","owner":"thecreation","description":"A lightweight jquery plugin that help create a modal dialog.","archived":false,"fork":false,"pushed_at":"2017-09-19T11:55:41.000Z","size":571,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-09T11:48:13.766Z","etag":null,"topics":["jquery-plugin","lightbox","modal"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/thecreation.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-05-09T03:44:33.000Z","updated_at":"2017-02-16T17:05:48.000Z","dependencies_parsed_at":"2022-08-26T18:51:20.259Z","dependency_job_id":null,"html_url":"https://github.com/thecreation/jquery-asModal","commit_stats":null,"previous_names":["amazingsurge/jquery-asmodal"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thecreation%2Fjquery-asModal","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thecreation%2Fjquery-asModal/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thecreation%2Fjquery-asModal/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thecreation%2Fjquery-asModal/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thecreation","download_url":"https://codeload.github.com/thecreation/jquery-asModal/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247226193,"owners_count":20904464,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["jquery-plugin","lightbox","modal"],"created_at":"2024-12-17T21:13:54.782Z","updated_at":"2025-12-12T03:26:33.845Z","avatar_url":"https://github.com/thecreation.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# [jQuery asModal](https://github.com/amazingSurge/jquery-asModal) ![bower][bower-image] [![NPM version][npm-image]][npm-url] [![Dependency Status][daviddm-image]][daviddm-url] [![prs-welcome]](#contributing)\n\n\u003e A lightweight jQuery plugin that help create a modal dialog.\n\n## Table of contents\n- [Main files](#main-files)\n- [Quick start](#quick-start)\n- [Requirements](#requirements)\n- [Usage](#usage)\n- [Examples](#examples)\n- [Options](#options)\n- [Methods](#methods)\n- [Events](#events)\n- [No conflict](#no-conflict)\n- [Browser support](#browser-support)\n- [Contributing](#contributing)\n- [Development](#development)\n- [Changelog](#changelog)\n- [Copyright and license](#copyright-and-license)\n\n## Main files\n```\ndist/\n├── jquery-asModal.js\n├── jquery-asModal.es.js\n├── jquery-asModal.min.js\n└── css/\n    ├── asModal.css\n    └── asModal.min.css\n```\n\n## Quick start\nSeveral quick start options are available:\n#### Download the latest build\n\n * [Development](https://raw.githubusercontent.com/amazingSurge/jquery-asModal/master/dist/jquery-asModal.js) - unminified\n * [Production](https://raw.githubusercontent.com/amazingSurge/jquery-asModal/master/dist/jquery-asModal.min.js) - minified\n\n#### Install From Bower\n```sh\nbower install jquery-asModal --save\n```\n\n#### Install From Npm\n```sh\nnpm install jquery-asModal --save\n```\n\n#### Install From Yarn\n```sh\nyarn add jquery-asModal\n```\n\n#### Build From Source\nIf you want build from source:\n\n```sh\ngit clone git@github.com:amazingSurge/jquery-asModal.git\ncd jquery-asModal\nnpm install\nnpm install -g gulp-cli babel-cli\ngulp build\n```\n\nDone!\n\n## Requirements\n`jquery-asModal` requires the latest version of [`jQuery`](https://jquery.com/download/).\n\n## Usage\n#### Including files:\n\n```html\n\u003clink rel=\"stylesheet\" href=\"/path/to/asModal.css\"\u003e\n\u003cscript src=\"/path/to/jquery.js\"\u003e\u003c/script\u003e\n\u003cscript src=\"/path/to/jquery-asModal.js\"\u003e\u003c/script\u003e\n```\n\n#### Required HTML structure\n\n```html\n\u003cbutton href=\"login.html\" class=\"example\"\u003eclick to open modal\u003c/button\u003e\n```\n\n#### Initialization\nAll you need to do is call the plugin on the element:\n\n```javascript\njQuery(function($) {\n  $('.example').asModal(); \n});\n```\n\n## Examples\nThere are some example usages that you can look at to get started. They can be found in the\n[examples folder](https://github.com/amazingSurge/jquery-asModal/tree/master/examples).\n\n## Options\n`jquery-asModal` can accept an options object to alter the way it behaves. You can see the default options by call `$.asModal.setDefaults()`. The structure of an options object is as follows:\n\n```\n{\n  namespace: 'modal', // String: Prefix string attached to the class of every element generated by the plugin\n  skin: null, // set plugin skin\n\n  content: null, // Set the URL, ID or Class.\n  overlay: true, // Show the overlay.\n  closeElement: null, // Element ID or Class to close the modal\n  effect: 'fadeScale', // fadein | slide | newspaper | fall\n  overlaySpeed: 200, // Sets the speed of the overlay, in milliseconds\n  effectFallback: 'fade', // set default jquery animate when css3 animation doesn't support\n  focus: true, // set focus to form element in content\n  errorContent: 'sorry, ajax error.', // set ajax error content\n  loadingContent: 'loading...', // set loading content\n\n  closeByEscape: true, // Allow the user to close the modal by pressing 'ESC'.\n  closeByOverlayClick: true, // Allow the user to close the modal by clicking the overlay.\n\n  width: null, // Set a fixed total width.\n  hieght: null, // Set a fixed total height.\n\n  // Callback API\n  onOpen: null, // Callback: function() - Fires when the modal open\n  onClose: null // Callback: function() - Fires when the modal close\n  //onComplete: null // Callback: function() - Fires when the effect end\n}\n```\n\n## Methods\nMethods are called on asModal instances through the asModal method itself.\nYou can also save the instances to variable for further use.\n\n```javascript\n// call directly\n$().asModal('destroy');\n\n// or\nvar api = $().data('asModal');\napi.destroy();\n```\n\n#### moveTo(position)\nMove the modal handle to the position.\n```javascript\n// move to 50px\n$().asModal('moveTo', '50');\n\n// move to 50%\n$().asModal('moveTo', '50%');\n```\n\n#### open()\nOpen the modal.\n```javascript\n$().asModal('open');\n```\n\n#### close()\nClose the modal.\n```javascript\n$().asModal('close');\n```\n\n#### enable()\nEnable the modal functions.\n```javascript\n$().asModal('enable');\n```\n\n#### disable()\nDisable the modal functions.\n```javascript\n$().asModal('disable');\n```\n\n#### destroy()\nDestroy the modal instance.\n```javascript\n$().asModal('destroy');\n```\n\n## Events\n`jquery-asModal` provides custom events for the plugin’s unique actions. \n\n```javascript\n$('.the-element').on('asModal::ready', function (e) {\n  // on instance ready\n});\n\n```\n\nEvent   | Description\n------- | -----------\nready   | Fires when the instance is ready for API use.\nenable  | Fired when the `enable` instance method has been called.\ndisable | Fired when the `disable` instance method has been called.\ndestroy | Fires when an instance is destroyed. \n\n## No conflict\nIf you have to use other plugin with the same namespace, just call the `$.asModal.noConflict` method to revert to it.\n\n```html\n\u003cscript src=\"other-plugin.js\"\u003e\u003c/script\u003e\n\u003cscript src=\"jquery-asModal.js\"\u003e\u003c/script\u003e\n\u003cscript\u003e\n  $.asModal.noConflict();\n  // Code that uses other plugin's \"$().asModal\" can follow here.\n\u003c/script\u003e\n```\n\n## Browser support\n\nTested on all major browsers.\n\n| \u003cimg src=\"https://raw.githubusercontent.com/alrra/browser-logos/master/safari/safari_32x32.png\" alt=\"Safari\"\u003e | \u003cimg src=\"https://raw.githubusercontent.com/alrra/browser-logos/master/chrome/chrome_32x32.png\" alt=\"Chrome\"\u003e | \u003cimg src=\"https://raw.githubusercontent.com/alrra/browser-logos/master/firefox/firefox_32x32.png\" alt=\"Firefox\"\u003e | \u003cimg src=\"https://raw.githubusercontent.com/alrra/browser-logos/master/edge/edge_32x32.png\" alt=\"Edge\"\u003e | \u003cimg src=\"https://raw.githubusercontent.com/alrra/browser-logos/master/internet-explorer/internet-explorer_32x32.png\" alt=\"IE\"\u003e | \u003cimg src=\"https://raw.githubusercontent.com/alrra/browser-logos/master/opera/opera_32x32.png\" alt=\"Opera\"\u003e |\n|:--:|:--:|:--:|:--:|:--:|:--:|\n| Latest ✓ | Latest ✓ | Latest ✓ | Latest ✓ | 9-11 ✓ | Latest ✓ |\n\nAs a jQuery plugin, you also need to see the [jQuery Browser Support](http://jquery.com/browser-support/).\n\n## Contributing\nAnyone and everyone is welcome to contribute. Please take a moment to\nreview the [guidelines for contributing](CONTRIBUTING.md). Make sure you're using the latest version of `jquery-asModal` before submitting an issue. There are several ways to help out:\n\n* [Bug reports](CONTRIBUTING.md#bug-reports)\n* [Feature requests](CONTRIBUTING.md#feature-requests)\n* [Pull requests](CONTRIBUTING.md#pull-requests)\n* Write test cases for open bug issues\n* Contribute to the documentation\n\n## Development\n`jquery-asModal` is built modularly and uses Gulp as a build system to build its distributable files. To install the necessary dependencies for the build system, please run:\n\n```sh\nnpm install -g gulp\nnpm install -g babel-cli\nnpm install\n```\n\nThen you can generate new distributable files from the sources, using:\n```\ngulp build\n```\n\nMore gulp tasks can be found [here](CONTRIBUTING.md#available-tasks).\n\n## Changelog\nTo see the list of recent changes, see [Releases section](https://github.com/amazingSurge/jquery-asModal/releases).\n\n## Copyright and license\nCopyright (C) 2016 amazingSurge.\n\nLicensed under [the LGPL license](LICENSE).\n\n[⬆ back to top](#table-of-contents)\n\n[bower-image]: https://img.shields.io/bower/v/jquery-asModal.svg?style=flat\n[bower-link]: https://david-dm.org/amazingSurge/jquery-asModal/dev-status.svg\n[npm-image]: https://badge.fury.io/js/jquery-asModal.svg?style=flat\n[npm-url]: https://npmjs.org/package/jquery-asModal\n[license]: https://img.shields.io/npm/l/jquery-asModal.svg?style=flat\n[prs-welcome]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg\n[daviddm-image]: https://david-dm.org/amazingSurge/jquery-asModal.svg?style=flat\n[daviddm-url]: https://david-dm.org/amazingSurge/jquery-asModal","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthecreation%2Fjquery-asmodal","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthecreation%2Fjquery-asmodal","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthecreation%2Fjquery-asmodal/lists"}