Ask before sending: the ypy-prompt extension
ypy-prompt shows a question before the request goes out. The answer travels in the YPY-Prompt request header. If
the visitor cancels, no request is made. It is useful for a rename, a reason for a refusal or a number of items, where
one small question is enough and a form would be too much.
Load it
<script src="ypy.min.js"></script>
<script src="ext/ypy-prompt.js"></script>The extension is not part of ypy.max.
Use it
<button ypy-post="/projects/7/rename" ypy-target="#project-7" ypy-swap="outerHTML"
ypy-prompt="New name for this project?">Rename</button>The browser's own prompt() dialog asks the question. ypy-prompt is inherited, so you can set it on a container.
An empty answer is sent (an empty header); Cancel stops the request.
For your own dialog, define window.ypyPrompt. It receives the question and must return the answer as a string, or
null when the visitor cancels. It has to answer at once (a synchronous function). For a dialog that waits for the visitor, use
layers and send a normal form.
Attributes
| Attribute | Value | Meaning |
|---|---|---|
ypy-prompt |
text | the question; inherited |
Events
| Event | Cancelable | detail |
Fires |
|---|---|---|---|
ypy:prompt |
yes | prompt (the answer), target |
on the element after the visitor answered; cancel it to stop the request |
Headers
| Header | Direction | Value |
|---|---|---|
YPY-Prompt |
request | the answer, URI-encoded |
Server
The answer arrives in the YPY-Prompt request header. Trim it, validate it like any input and escape it before it goes
into HTML. For a missing or invalid name, answer 422 with a fragment; otherwise save and answer the new fragment.
Notes
-
The answer comes from the visitor: validate it on the server as any other input, and escape it before it goes into HTML.
- To ask for a yes or no, use
ypy-confirmfrom the core; see the confirm example.