Outdated documentation for instance.hide

marcelodolza / iziToast

Elegant, responsive, flexible and lightweight notification plugin with no dependencies.

https://marcelodolza.github.io/iziToast/

Apache License 2.0

2.62k stars 306 forks source link

Outdated documentation for instance.hide #125

Closed zachsteffens closed 6 years ago

zachsteffens commented 6 years ago

Throughout the demo page you have this code (or some variant) as an example of how to programmatically close the toast. instance.hide({ transitionOut: 'fadeOut' }, toast, 'button');

Seems like this is out of order, the hide method signature looks like this $iziToast.hide = function ($toast, options, closedBy) {

So the options need to be the second parameter. Not a huge issue and any decent Dev can figure it out quickly. Just wanted to call it to your attention.

spankie commented 6 years ago

Really threw me off guard at first.

marcelodolza commented 6 years ago

Are you looking at v1.3.0? The correct is: $iziToast.hide = function (options, $toast, closedBy) The documentation will always be updated to the latest version.