aboutsummaryrefslogtreecommitdiff
path: root/catapult/third_party/polymer/components/iron-form/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'catapult/third_party/polymer/components/iron-form/README.md')
-rw-r--r--catapult/third_party/polymer/components/iron-form/README.md52
1 files changed, 52 insertions, 0 deletions
diff --git a/catapult/third_party/polymer/components/iron-form/README.md b/catapult/third_party/polymer/components/iron-form/README.md
new file mode 100644
index 00000000..01357142
--- /dev/null
+++ b/catapult/third_party/polymer/components/iron-form/README.md
@@ -0,0 +1,52 @@
+
+<!---
+
+This README is automatically generated from the comments in these files:
+iron-form.html
+
+Edit those files, and our readme bot will duplicate them over here!
+Edit this file, and the bot will squash your changes :)
+
+The bot does some handling of markdown. Please file a bug if it does the wrong
+thing! https://github.com/PolymerLabs/tedium/issues
+
+-->
+
+[![Build status](https://travis-ci.org/PolymerElements/iron-form.svg?branch=master)](https://travis-ci.org/PolymerElements/iron-form)
+
+_[Demo and API docs](https://elements.polymer-project.org/elements/iron-form)_
+
+
+## &lt;iron-form&gt;
+`<iron-form>` is a wrapper around the HTML `<form>` element, that can
+validate and submit both custom and native HTML elements.
+
+It has two modes: if `allow-redirect` is true, then after the form submission you
+will be redirected to the server response. Otherwise, if it is false, it will
+use an `iron-ajax` element to submit the form contents to the server.
+
+ Example:
+
+```html
+ <iron-form>
+ <form method="get" action="/form/handler">
+ <input type="text" name="name" value="Batman">
+ <input type="checkbox" name="donuts" checked> I like donuts<br>
+ <paper-checkbox name="cheese" value="yes" checked></paper-checkbox>
+ </form>
+ </iron-form>
+```
+
+By default, a native `<button>` element (or `input type="submit"`) will submit this form. However, if you
+want to submit it from a custom element's click handler, you need to explicitly
+call the `iron-form`'s `submit` method.
+
+ Example:
+
+```html
+ <paper-button raised onclick="submitForm()">Submit</paper-button>
+
+ function submitForm() {
+ document.getElementById('iron-form').submit();
+ }
+```