Shorthand Syntax

Write forms faster with Formdown's powerful shorthand syntax. Every shorthand expression converts to standard [attributes] syntax.

Why Shorthand?

Compare these equivalent forms:

Standard Syntax

@name: [text required]
@email: [email required]
@age: [number min=18 max=100]
@phone: [tel pattern="\\(\\d{3}\\)\\d{3}-\\d{4}"]
@interests: [checkbox options="Web,Mobile,AI"]

Shorthand Syntax

@name*: []
@email*: @[]
@age: #[min=18 max=100]
@phone{(###)###-####}: %[]
@interests{Web,Mobile,AI}: c[]

50% less typing, same functionality!

Core Shorthand Patterns

Required Fields with *

Example:

# Registration form
@username*: []
@email*: @[]
@password*: ?[]
@age*: #[min=18]

Type Markers

Quick type specification with single characters:

Example:

@email: @[]                    # Email field
@age: #[]                      # Number field
@phone: %[]                    # Phone field
@website: &[]                  # URL field
@password: ?[]                 # Password field
@birth_date: d[]               # Date field
@meeting_time: t[]             # Time field
@appointment: dt[]             # DateTime field
@birth_month: M[]              # Month picker
@work_week: W[]                # Week picker
@description: T[]              # Textarea
@bio: T4[]                     # 4-row textarea
@volume: R[]                   # Range slider
@avatar: F[]                   # File upload
@theme_color: C[]              # Color picker

Content Patterns with {}

The {} syntax changes meaning based on field type:

Selection Fields → Options

Example:

@size{S,M,L,XL}: r[]           # Radio buttons
@skills{JS,Python,Java}: c[]   # Checkbox group
@country{USA,Canada,UK}: s[]   # Select dropdown

Text Fields → Validation Pattern

Example:

@ssn{###-##-####}: []
@phone{(###)###-####}: []
@work_email{*@company.com}: []

Date/Time Fields → Format

Example:

@birth_date{yyyy-MM-dd}: d[]
@meeting_time{HH:mm}: t[]

Combining Shorthand

Required + Type

@email*: @[]              # Required email
@age*: #[]                # Required number
@password*: ?[]           # Required password
@description*: T4[]       # Required 4-row textarea

Required + Type + Pattern

@email*{*@company.com}: @[]           # Required company email
@phone*{(###)###-####}: %[]           # Required formatted phone
@username*{^[a-zA-Z0-9_]{3,20}$}: []  # Required username pattern

Custom Labels + Shorthand

@first_name(Full Name)*: []
@user_email(Email Address)*: @[]
@birth_date(Date of Birth){yyyy-MM-dd}: d[]
@work_phone(Work Phone){(###)###-####}: %[]

Pattern Shortcuts

Formdown converts user-friendly patterns to proper regex:

Mask Patterns

Example:

@phone{(###)###-####}: []      # Phone format
@ssn{###-##-####}: []          # SSN format  
@zip{#####}: []                # 5-digit ZIP
@license{***-###}: []          # License plate

Glob Patterns

Example:

@work_email{*@company.com}: @[]
@username{user_*}: []
@resume{*.pdf}: [file]

Inline Shorthand

Use shorthand in inline fields too:

Hello ___@name*!
Your email: ___@email*: @[]
Age: ___@age*: #[] years old
Phone: ___@phone{(###)###-####}: %[]

Complete Examples

Quick Contact Form

# Contact Us
@name*: []
@email*: @[]
@phone{(###)###-####}: %[]
@message*: T4[]
@submit: [submit label="Send"]

User Registration

# Create Account
@username*{^[a-zA-Z0-9_]{3,20}$}: [placeholder="3-20 characters"]
@email*: @[]
@password*{^(?=.*[A-Z])(?=.*[a-z])(?=.*\\d).{8,}$}: ?[]
@birth_date{yyyy-MM-dd}: d[max="2010-12-31"]
@country{USA,Canada,UK,Other}: s[]
@interests{Web,Mobile,AI,Gaming}: c[]
@newsletter(Subscribe): c[]
@terms*: c[label="I agree to terms"]
@register: [submit label="Create Account"]

Event Booking

# Book Appointment
Dear ___@customer_name*,

Your appointment details:
- Service: ___@service{Consultation,Checkup,Treatment}: s[]
- Date: ___@date{yyyy-MM-dd}: d[min="2024-01-01"]
- Time: ___@time{HH:mm}: t[min="09:00" max="17:00"]
- Phone: ___@phone{(###)###-####}: %[]

@special_requests: T3[placeholder="Any special requirements?"]
@book: [submit label="Book Appointment"]

Shorthand Reference Tables

Type Markers Quick Reference

Pattern Examples

When to Use Shorthand

✅ Perfect for Shorthand

• Common field types: email, phone, numbers
• Simple validation: required fields, basic patterns
• Rapid prototyping: quick form mockups
• Standard forms: contact, registration, surveys

🔧 Use Standard Syntax

• Complex validation: multi-step regex patterns
• Custom attributes: CSS classes, data attributes
• Framework integration: dynamic values
• Advanced features: conditional logic

💡 Mixed Approach (Recommended)

# Use shorthand for simple fields
@name*: []
@email*: @[]
@phone{(###)###-####}: %[]

# Use standard for complex fields
@bio: [textarea rows=4 maxlength=500 class="bio-field" 
      placeholder="Tell us about yourself..." 
      data-counter="true"]
      
@preferences: [checkbox options="Email,SMS,Phone" 
               class="notification-prefs" 
               data-toggle="advanced-options"]

Conversion Chart

Every shorthand expression has a standard equivalent:

Tips for Effective Shorthand

Start Simple

# Begin with basic shorthand
@name*: []
@email*: @[]

Add Complexity Gradually

# Add patterns and options
@phone{(###)###-####}: %[]
@interests{Web,Mobile,AI}: c[]

Mix with Standard When Needed

# Shorthand for simple fields
@name*: []
@email*: @[]

# Standard for complex requirements
@advanced_options: [checkbox options="opt1,opt2,opt3" 
                   class="advanced-section" 
                   data-toggle="collapse-panel"]

Use Descriptive Field Names

# Good - descriptive names
@work_email*: @[]
@home_phone{(###)###-####}: %[]

# Avoid - unclear names  
@email1*: @[]
@phone2{(###)###-####}: %[]

Shorthand syntax makes Formdown incredibly fast to write while maintaining full functionality and readability.