Home > Documentation > Getting Started

Getting Started with ParleyJS

Learn the basics of ParleyJS and build your first cross-window communication application.

What You'll Learn

This section covers everything you need to get started with ParleyJS:

• How to install and set up ParleyJS
• Your first working example
• Core concepts and terminology
• Common patterns and best practices

Contents

Quick Start

1. Installation - Install ParleyJS in your project
2. First Example - Build your first ParleyJS application
3. Core Concepts - Understanding channels, messages, and origins

Next Steps

After completing this section:

• Build something specific: See Guides for use-case focused tutorials
• Learn patterns: See Patterns for reusable code patterns
• Deep dive: See API Reference for complete documentation

Prerequisites

Before starting, you should have:

• Basic JavaScript or TypeScript knowledge
• Understanding of browser window objects (window, iframe)
• Familiarity with async/await syntax

No prior knowledge of postMessage API is required.

Learning Path

Recommended order:

1. Read Installation to set up your project
2. Follow First Example to build a working application
3. Review Core Concepts to understand the fundamentals
4. Explore Guides for your specific use case

Related Sections

• Framework Reference - Quick reference for common operations
• Guides - Use-case specific implementation guides
• Examples - Complete working examples
• Troubleshooting - Common issues and solutions

Need Help?

• Common issues: See Troubleshooting
• Error messages: See Common Errors
• Questions: Open an issue on GitHub

---

Navigation

Next: Installation

Back to: Documentation Home | Project Home