Skip to content

Commit

Permalink
first commit
Browse files Browse the repository at this point in the history
  • Loading branch information
Ashley committed Oct 30, 2023
1 parent e4be2bf commit b4ee6aa
Show file tree
Hide file tree
Showing 43 changed files with 695 additions and 648 deletions.
30 changes: 15 additions & 15 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,44 +2,44 @@

##### New Features

* add example for sidebar-modal, issue [#88](https://github.com/Jenesius/vue-modal/pull/88) ([4eaa39d4](https://github.com/Jenesius/vue-modal/commit/4eaa39d47ec2c58270d93c3d0e6f6fcebb15e2ae))
* add example for sidebar-modal, issue [#88](https://github.com/wizarrrr/wizarr-modal/pull/88) ([4eaa39d4](https://github.com/wizarrrr/wizarr-modal/commit/4eaa39d47ec2c58270d93c3d0e6f6fcebb15e2ae))

##### Bug Fixes

* change src to types. ([3c5add4f](https://github.com/Jenesius/vue-modal/commit/3c5add4fa7326ef33da2148f1dea58ee176bfcee))
* change src to types. ([3c5add4f](https://github.com/wizarrrr/wizarr-modal/commit/3c5add4fa7326ef33da2148f1dea58ee176bfcee))

#### 1.9.1 (2023-08-28)

##### Documentation Changes

* end ru translate ([3a9838f3](https://github.com/Jenesius/vue-modal/commit/3a9838f385d8da589bf57f3b7e8c2e274d0e3e8a))
* add ru Language ([a64ceaa8](https://github.com/Jenesius/vue-modal/commit/a64ceaa8b117c08af39dad2fb57003e8c7ef3638))
* end ru translate ([3a9838f3](https://github.com/wizarrrr/wizarr-modal/commit/3a9838f385d8da589bf57f3b7e8c2e274d0e3e8a))
* add ru Language ([a64ceaa8](https://github.com/wizarrrr/wizarr-modal/commit/a64ceaa8b117c08af39dad2fb57003e8c7ef3638))

##### New Features

* move from plugin to src ([25492c24](https://github.com/Jenesius/vue-modal/commit/25492c24522dd1ecce10d42c2a80f1e33017b32e))
* add example for router-integration ([af156a4a](https://github.com/Jenesius/vue-modal/commit/af156a4a0263084499b791e5e5d6e69e8eb5a7e6))
* move from plugin to src ([25492c24](https://github.com/wizarrrr/wizarr-modal/commit/25492c24522dd1ecce10d42c2a80f1e33017b32e))
* add example for router-integration ([af156a4a](https://github.com/wizarrrr/wizarr-modal/commit/af156a4a0263084499b791e5e5d6e69e8eb5a7e6))

##### Other Changes

* remove babel lib ([a4cd95b5](https://github.com/Jenesius/vue-modal/commit/a4cd95b58f5a3d6b640726cab68e6798564fe1cd))
* remove died link ([2e9bdba1](https://github.com/Jenesius/vue-modal/commit/2e9bdba161c590837cbc4f3c5a4ac8b32c1d7a6b))
* remove babel lib ([a4cd95b5](https://github.com/wizarrrr/wizarr-modal/commit/a4cd95b58f5a3d6b640726cab68e6798564fe1cd))
* remove died link ([2e9bdba1](https://github.com/wizarrrr/wizarr-modal/commit/2e9bdba161c590837cbc4f3c5a4ac8b32c1d7a6b))

### 1.9.0 (2023-04-10)

##### Documentation Changes

* add information about store. ([51fd468a](https://github.com/Jenesius/vue-modal/commit/51fd468aa1df8aaa875f4447c109ab9e2e20ed1e))
* add new page-example for animation. ([07dd725f](https://github.com/Jenesius/vue-modal/commit/07dd725f7fc836b82eb5f67a5883b4ff4a37cd02))
* update information about closing modal with route. ([00e21b48](https://github.com/Jenesius/vue-modal/commit/00e21b486a0c434abcee468d047d936743b5dfd1))
* add information about store. ([51fd468a](https://github.com/wizarrrr/wizarr-modal/commit/51fd468aa1df8aaa875f4447c109ab9e2e20ed1e))
* add new page-example for animation. ([07dd725f](https://github.com/wizarrrr/wizarr-modal/commit/07dd725f7fc836b82eb5f67a5883b4ff4a37cd02))
* update information about closing modal with route. ([00e21b48](https://github.com/wizarrrr/wizarr-modal/commit/00e21b486a0c434abcee468d047d936743b5dfd1))

##### New Features

* update pushModal, add string name for modal component, add test ([231b7356](https://github.com/Jenesius/vue-modal/commit/231b7356fb7be909fb6ee585265240dcf2625678))
* add new method getComponentFromStore, add test, add store to config.ts ([1844100d](https://github.com/Jenesius/vue-modal/commit/1844100d5d154f20900217f457cb52d10974e38d))
* add type declaration for props. Add options to prompt-modal.ts ([0a2c771e](https://github.com/Jenesius/vue-modal/commit/0a2c771e70a7d5e11e2e77e199fbf33f2d0d4046))
* update pushModal, add string name for modal component, add test ([231b7356](https://github.com/wizarrrr/wizarr-modal/commit/231b7356fb7be909fb6ee585265240dcf2625678))
* add new method getComponentFromStore, add test, add store to config.ts ([1844100d](https://github.com/wizarrrr/wizarr-modal/commit/1844100d5d154f20900217f457cb52d10974e38d))
* add type declaration for props. Add options to prompt-modal.ts ([0a2c771e](https://github.com/wizarrrr/wizarr-modal/commit/0a2c771e70a7d5e11e2e77e199fbf33f2d0d4046))

##### Tests

* add new tests for opening modal from the store. ([5550c4a1](https://github.com/Jenesius/vue-modal/commit/5550c4a193e4cbdff3775c61df8f438306fa12ba))
* add new tests for opening modal from the store. ([5550c4a1](https://github.com/wizarrrr/wizarr-modal/commit/5550c4a193e4cbdff3775c61df8f438306fa12ba))

2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright 2021 Jenesius
Copyright 2021 Wizarr

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

Expand Down
48 changes: 24 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
<p align="center"><a href="https://modal.jenesius.com/" target="_blank" rel="noopener noreferrer"><img height="100" src="https://modal.jenesius.com/images/logo.svg" alt="Vue logo"></a></p>
<p align="center"><a href="https://modal.wizarr.dev/" target="_blank" rel="noopener noreferrer"><img height="100" src="https://modal.wizarr.dev/images/logo.svg" alt="Vue logo"></a></p>

<p align="center">
<a href="https://img.shields.io/github/issues/Jenesius/vue-modal"><img src="https://img.shields.io/github/issues/Jenesius/vue-modal" alt="Downloads"></a>
<a href="https://img.shields.io/npm/dw/jenesius-vue-modal"><img src="https://img.shields.io/npm/dw/jenesius-vue-modal" alt="Downloads"></a>
<a href="https://img.shields.io/github/stars/Jenesius/vue-modal"><img src="https://img.shields.io/github/stars/Jenesius/vue-modal" ></a>
<a href="https://github.com/Jenesius/vue-modal/actions/workflows/node.js.yml/badge.svg"><img src="https://github.com/Jenesius/vue-modal/actions/workflows/node.js.yml/badge.svg" alt="Issue"></a>
<a href="https://img.shields.io/npm/l/jenesius-vue-modal"><img src="https://img.shields.io/npm/l/jenesius-vue-modal" alt="Stars"></a>
<a href="https://img.shields.io/github/issues/wizarrrr/wizarr-modal"><img src="https://img.shields.io/github/issues/wizarrrr/wizarr-modal" alt="Downloads"></a>
<a href="https://img.shields.io/npm/dw/wizarr-vue-modal"><img src="https://img.shields.io/npm/dw/wizarr-vue-modal" alt="Downloads"></a>
<a href="https://img.shields.io/github/stars/wizarrrr/wizarr-modal"><img src="https://img.shields.io/github/stars/wizarrrr/wizarr-modal" ></a>
<a href="https://github.com/wizarrrr/wizarr-modal/actions/workflows/node.js.yml/badge.svg"><img src="https://github.com/wizarrrr/wizarr-modal/actions/workflows/node.js.yml/badge.svg" alt="Issue"></a>
<a href="https://img.shields.io/npm/l/wizarr-vue-modal"><img src="https://img.shields.io/npm/l/wizarr-vue-modal" alt="Stars"></a>
</p>

# Jenesius Vue Modal
# Wizarr Vue Modal

Jenesius vue modal is simple modal system library for **Vue 3** only .
Wizarr vue modal is simple modal system library for **Vue 3** only .


Using this library, you can simply show both one and several modal windows at the same time, integrate with vue-router

- [Full Documentation](https://modal.jenesius.com)
- [Examples](https://modal.jenesius.com/examples/list.html)
- [Full Documentation](https://modal.wizarr.dev)
- [Examples](https://modal.wizarr.dev/examples/list.html)

### Installation

```shell
npm i jenesius-vue-modal
npm i wizarr-vue-modal
```

![Alt Text](./demo-gif.gif)
Expand All @@ -37,7 +37,7 @@ The main condition for library initialization is adding a **container** inside y
<widget-container-modal />
</template>
<script>
import {container} from "jenesius-vue-modal";
import {container} from "wizarr-vue-modal";
export default {
components: {WidgetContainerModal: container},
Expand All @@ -54,15 +54,15 @@ Methods `openModal` and `pushModal` used to display modal windows.
- `pushModal` - display provided component

```js
import {openModal} from "jenesius-vue-modal";
import {openModal} from "wizarr-vue-modal";
import SomeVueComponent from "SomeVueComponent.vue";

openModal(SomeVueComponent, props);
```
- props will provide in your component, [example](#example-vuemodalcomponent)

Methods return promise, in this case promise is resolved **modalObject**.
[More information](https://modal.jenesius.com/guide/modal-object.html)
[More information](https://modal.wizarr.dev/guide/modal-object.html)
```js
const modal = await openModal(SomeVueComponent);
// modal {id, close, onclose, closed, instance, on}
Expand All @@ -75,17 +75,17 @@ const modal = await openModal(SomeVueComponent);
- `pushModal` - add one more provided modal.
- `closeModal`- close all modals.
- `popModal` - close last opened modal.
- `promptModal` - opening a modal window and waiting for a value to be returned. [More information](https://modal.jenesius.com/guide/guide-methods.html#prompt-modal)
- `promptModal` - opening a modal window and waiting for a value to be returned. [More information](https://modal.wizarr.dev/guide/guide-methods.html#prompt-modal)

For detailed information about existing methods, follow the [link](https://modal.jenesius.com/guide/guide-methods.html)
For detailed information about existing methods, follow the [link](https://modal.wizarr.dev/guide/guide-methods.html)

```js
import {openModal, pushModal, closeModal, popModal} from "jenesius-vue-modal"
import {openModal, pushModal, closeModal, popModal} from "wizarr-vue-modal"
```

## How to return value?

Sometimes a modal needs to return a value. This case is described in detail in the [following article](https://modal.jenesius.com/guide/guide-returned-value.html).
Sometimes a modal needs to return a value. This case is described in detail in the [following article](https://modal.wizarr.dev/guide/guide-returned-value.html).

## Handle events

Expand Down Expand Up @@ -154,7 +154,7 @@ export default {
```
- Composition style
```js
import {onBeforeModalClose} from "jenesius-vue-modal"
import {onBeforeModalClose} from "wizarr-vue-modal"
export default{
setup() {
onBeforeModalClose(() => {
Expand Down Expand Up @@ -192,7 +192,7 @@ For integrate modals into VueRouter you need to initialize your application:

```js
import {createWebHistory, createRouter} from "vue-router";
import {useModalRouter} from "jenesius-vue-modal";
import {useModalRouter} from "wizarr-vue-modal";

const router = createRouter({
history: createWebHistory(),
Expand All @@ -215,10 +215,10 @@ const routes = [
```

Now, when route will be */any-route* the Modal window will open.
For more information see [Docs](https://modal.jenesius.com/guide/integration-introduction.html).
For more information see [Docs](https://modal.wizarr.dev/guide/integration-introduction.html).

# Style and Animation
Please refer to the [documentation](https://modal.jenesius.com/guide/details-styles.html) to change the styles or animations of modals.
Please refer to the [documentation](https://modal.wizarr.dev/guide/details-styles.html) to change the styles or animations of modals.

# Example VueModalComponent

Expand All @@ -237,7 +237,7 @@ Please refer to the [documentation](https://modal.jenesius.com/guide/details-sty
```
To show this component
```js
import {openModal} from "jenesius-vue-modal"
import {openModal} from "wizarr-vue-modal"
import WidgeTestModal from "WidgeTestModal.vue";

openModal(WidgeTestModal, {
Expand All @@ -247,4 +247,4 @@ openModal(WidgeTestModal, {

---

#### Do you like this module? Put a star on [GitHub](https://github.com/Jenesius/vue-modal)
#### Do you like this module? Put a star on [GitHub](https://github.com/wizarrrr/wizarr-modal)
Loading

0 comments on commit b4ee6aa

Please sign in to comment.