This is an automated email from the ASF dual-hosted git repository.
dklco pushed a commit to branch master
in repository
https://gitbox.apache.org/repos/asf/sling-org-apache-sling-app-cms.git
The following commit(s) were added to refs/heads/master by this push:
new 814015d SLING-8719 - adding docs for forms
814015d is described below
commit 814015d89910b4a3a52f677e5a766a489463a019
Author: Dan Klco <[email protected]>
AuthorDate: Wed Sep 18 15:49:48 2019 -0400
SLING-8719 - adding docs for forms
---
docs/reference.md | 22 +++++++++++++++++++++-
1 file changed, 21 insertions(+), 1 deletion(-)
diff --git a/docs/reference.md b/docs/reference.md
index 92829eb..e777973 100644
--- a/docs/reference.md
+++ b/docs/reference.md
@@ -16,11 +16,14 @@ The reference project provides a number of example
components to use, develop on
These components are:
+## General
+
- base page - a basic page using the Apache Sling website styling
- breadcrumb - breadcrumb based on the page hierarchy
- cta - a call to action link / button
- codeblock - displays a block of code in a `<pre>` tag
- columncontrol - allows authors to create columns of content
+ - form - adds a form to a page
- iframe - allows for adding an iframe
- image - a block level image allowing linked and styled images
- list - a base component for creating dynamic lists
@@ -31,7 +34,24 @@ These components are:
- rss - renders an RSS feed backed on a query
- tags - displays the taxonomy tags on a page
+
In addition to these reference components, there are two general use
components in the main ui project. These are found at
`/libs/sling-cms/components/general` and are:
- container - a container into which other components can be added. This is
the most foundational component in Sling CMS allowing for component-driven
content development
- - rte - a HTML based rich text editor using [wysihtml](http://wysihtml.com/)
as the RTE
\ No newline at end of file
+ - rte - a HTML based rich text editor using [wysihtml](http://wysihtml.com/)
as the RTE
+
+## Form Components
+
+There are a number of components specifically for configuring the form.
+
+**Form Value Provider**
+
+ - userprofile - Loads form field values from the current user's profile
subnode
+
+**Form Field**
+
+ - fieldset - displays a HTML Fieldset for grouping fields, with an optional
legend
+ - honeypot - adds a spam-blocking honeypot to the form, should be hidden from
view, any submission with this field filled out will be blocked
+ - selection - allows for the users to select from options defined in tags,
can be rendered as radio, checkboxes or a dropdown
+ - textfield - basic text field with support for HTML5 types
+ - textarea - basic text area
\ No newline at end of file
