https://github.com/rfkhusnutdinov/cg-modal
Simple JS library for modal windows
https://github.com/rfkhusnutdinov/cg-modal
es6 js modal modal-dialogs modal-windows
Last synced: 3 days ago
JSON representation
Simple JS library for modal windows
- Host: GitHub
- URL: https://github.com/rfkhusnutdinov/cg-modal
- Owner: rfkhusnutdinov
- License: mit
- Created: 2022-06-19T10:06:45.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-06-22T12:37:52.000Z (almost 3 years ago)
- Last Synced: 2025-04-27T05:21:42.888Z (21 days ago)
- Topics: es6, js, modal, modal-dialogs, modal-windows
- Language: JavaScript
- Homepage: https://rfkhusnutdinov.github.io/cg-modal/demo/index.html
- Size: 396 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CgModal
CgModal - is simple and lightweight JS plugin of displaying modal windows which does not depend on jQuery or others.
For examples and demos, see [link](https://rfkhusnutdinov.github.io/cg-modal/demo)
## Installation
- **Via npm** `npm install --save cg-modal`
- **Via script tag** (change `@latest` to latest version `ex: @1.0.1`)
```html
```
## Usage
If you are using **import/export syntax**, you need to import library:
```javascript
import "cg-modal";
// or
import "cg-modal/dist/cg-modal.min.js";
import "cg-modal/dist/cg-modal.min.css";
```
Append to document following HTML:
```html
Button
Close
```
**Note:** Button which open modal window should contains data attribute (data-open-modal) and modal window should contains (data-modal)
Then, create an instance of class
```javascript
const modals = new CgModal({
// Options
});
```
## API
### Parameters
| Name | Type | Default | Description |
| ----------------------- | --------- | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **selector** | `string` | `.modal` | Selector HTML element that will act as a modal window |
| **openButtonSelector** | `string` | `[data-open-modal]` | Selector HTML element that will act as the button that opens the modal window |
| **closeButtonSelector** | `string` | `.modal__close-btn` | The HTML element selector that will act as the modal's close button. Should be inside this window. |
| **wrapperClass** | `string` | `modal__wrapper` | Class of wrapper container inside modal |
| **contentClass** | `string` | `modal__content` | Class of content part of modal window |
| **effect** | `null` | `string`\|`null` | Modal open and close effect. There are following effects: `"fade" \| "scaleCenter" \| "transformLeft" \| "transformBottom" \| "transformRight" \|"transformTop"` |
| **speed** | `number` | `300` | Modal opening and closing animation speed |
| **position** | `string` | `center` | Modal position on screen. There are following values: `"center" \| "left" \| "right"` |
| **addTechClasses** | `boolean` | `true` | Adding technical classes for the main elements of the modal window so that the default styles work. If the value is false, then you need to write all the styles for the modal window yourself. Classes such as `"cg-modal", "cg-modal-wrapper", "cg-modal-content"` |
### Methods
- **open(modalData)** - open modal by data-attribute (data-modal)
- **close(modal)** - close modal by Node Element
- **closeActive()** - close active modal
- **update()** - update instance
### Events
You can listen different useful events. Using `on` parameter on initialization
```javascript
const modals = new CgModal({
// ...
on: {
update: function () {
console.log("updated");
},
},
});
```
#### List of events:
- **beforeOpen** - Event before open modal
- **afterOpen** - Event after open modal
- **beforeClose** - Event before close modal
- **afterClose** - Event after close modal
- **openBtnClick** - Event at moment of click on open button
- **update** - Event at moment of update instance
## License
The code and the documentation are released under the [MIT License](https://github.com/rfkhusnutdinov/cg-modal/blob/main/LICENSE).