Document Show/Close Methods

[celsowhite]

Issue

There are instructions in the documentation for how to programmatically show/close the modal. See here. The show example doesn't fully explain how the show method functions and doesn't mention the second parameter (config).

If a user uses the show method they assume that it will open the modal with the same config as they used to init the modal. This is not the case, all config settings from the original init are replaced when using the show method.

I specifically faced this issue when trying to get my modal to close with a close animation. The awaitCloseAnimation property was reset when I used the show method.

Solution

Add a config parameter to the documentation and explicity state that when using that method you need to pass in a fresh config.

[fysherman]

That's what i need to know, i confused that config in init method apply to every modal.
Thanks

[Lovor01]

@celsowhite Your comment was a lifesaver! I was wondering for half an hour what is happening, why it does not work. Documentation is really insufficient.

[Dinver]

@celsowhite Thanks for help!