REFERENCE

YAMLForms Complete Reference Guide

Comprehensive Schema Reference


Revision History

Version Date Author Description
0.1.0 2024-01-10 YAMLForms Docs Initial draft
0.9.0 2024-04-20 Jane Doe Added tables and calculations sections
1.0.0 2024-06-15 YAMLForms Docs Added cover page feature, finalized for release

YAMLForms Complete Reference Guide

v1.0.0

1. Content Elements

1.1 Headings

Headings support levels 1 through 6, similar to HTML h1-h6 tags.

Level 3 Heading Example

Level 4 Heading Example

1.2 Paragraphs

Paragraphs display body text. They support optional maxWidth and fontSize properties for fine-tuned control over text presentation.

This paragraph has a custom maximum width of 400 points and a larger font size of 14 points.

1.3 Rules

Rules create horizontal dividing lines between content sections.


1.4 Spacers

Spacers add vertical whitespace. Height is specified in points.

(24 points of space was added above this paragraph)

1.5 Admonitions

Page 1 of 5

Admonitions are callout boxes for important information. Five variants are available.

Note
Use notes for supplementary information that adds context.
Information
Info boxes highlight general helpful information.
Tip
Tips provide helpful suggestions and best practices.
Warning
Warnings alert users to potential issues or important considerations.
Danger
Danger boxes indicate critical warnings that require immediate attention.

2. Form Fields

2.1 Text Fields

Single-line text input fields with optional placeholder and validation.

Page 2 of 5

2.2 Textarea Fields

Multi-line text areas for longer content like descriptions or comments.

2.3 Checkbox Fields

Boolean checkbox fields for yes/no selections.

2.4 Dropdown Fields

Dropdown select fields with predefined options.

3. Tables

3.1 Basic Table with Manual Rows

Page 3 of 5

Tables can contain form fields in cells. Define columns and rows explicitly.

9. Contact Information
NameEmailPhonePrimary

3.2 Auto-Generated Table Rows

Use rowCount with fieldPrefix and fieldSuffix for automatic row generation.

10. Line Items
DescriptionQuantityUnit PriceTaxable

3.3 Table with Dropdown Options

11. Team Assignments
Team MemberRoleStatus

3.4 Table with Static Labels

Page 4 of 5
12. Product Specifications
SpecificationValue
Model Number
Serial Number
Warranty Status
Page 5 of 5