voussoir/etiquette
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Improve the docstring for init_button_with_confirm.

Browse source
This commit is contained in:
voussoir 2019-06-15 02:15:31 -07:00
parent 65605253bf
commit 139d54f344
1 changed files with 10 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
frontends/etiquette_flask/static/js/common.js
View file

@ -137,18 +137,22 @@ common.init_button_with_confirm =
function init_button_with_confirm() function init_button_with_confirm()
{ {
/* /*
To create a button that requires confirmation, simply assign it the class To create a button that requires a second confirmation step, assign it the
"button_with_confirm" and give it a data-onclick that would normally class "button_with_confirm".
be the onclick. The rest is taken care of automatically.
Required:
data-onclick: String that would normally be the button's onclick.
Optional: Optional:
data-prompt, otherwise "Are you sure?". data-prompt: Text that appears next to the confirm button. Default is
"Are you sure?".
data-prompt-class data-prompt-class
data-confirm, otherwise inherits the original button's text. data-confirm: Text inside the confirm button. Default is to inherit the
original button's text.
data-confirm-class data-confirm-class
data-cancel, otherwise "Cancel". data-cancel: Text inside the cancel button. Default is "Cancel".
data-cancel-class data-cancel-class
*/ */
var buttons = document.getElementsByClassName("button_with_confirm"); var buttons = document.getElementsByClassName("button_with_confirm");