Home > Documentation > Use Case Guides

Use Case Guides

Focused guides for specific communication scenarios with ParleyJS.

Overview

These guides provide step-by-step instructions for implementing ParleyJS in common use cases. Each guide includes complete code examples, security considerations, and troubleshooting tips.

Choose the guide that matches your scenario, or start with iFrame Communication for the most common use case.

Available Guides

Communication Types

• iFrame Communication - Embedding and communicating with iframes

  • Widget embedding
  • Configuration passing
  • Event forwarding
  • Dynamic resizing

• Popup Window Communication - Parent and popup window communication

  • OAuth authentication flows
  • Payment processing
  • File selection dialogs
  • Settings windows

• Web Worker Communication - Main thread and worker communication

  • Background processing
  • Data transfer
  • Progress reporting
  • Worker lifecycle

• Multi-Window Communication - Coordinating multiple windows

  • Hub-and-spoke pattern
  • Peer-to-peer messaging
  • Broadcasting
  • Window coordination

Integration Scenarios

• React Integration - Using ParleyJS in React applications (see Examples)
• Vue Integration - Using ParleyJS in Vue applications (see Examples)
• Authentication Flows - OAuth and SSO patterns (see Popup Communication)

Choosing the Right Guide

I want to:

• Embed a third-party widget → iFrame Communication
• Build OAuth login → Popup Communication
• Process data in background → Web Worker Communication
• Coordinate multiple windows → Multi-Window Communication

My app uses:

• React → See Examples: React Integration
• Vue → See Examples: Vue Integration
• Vanilla JavaScript → Any guide applies

Guide Structure

Each guide follows this format:

1. Overview - What the guide covers and common use cases
2. Basic Setup - Minimal working example
3. Common Patterns - Typical implementation patterns
4. Security Considerations - Security best practices
5. Troubleshooting - Common issues and solutions
6. Complete Example - Full working code

Prerequisites

Before following these guides:

• Complete Getting Started
• Review Core Concepts
• Understand Security Basics

Related Sections

• Patterns - Reusable code patterns
• Examples - Complete code examples
• API Reference - Method documentation
• Troubleshooting - Problem solving

Need Help?

If you're stuck:

1. Check Troubleshooting for common issues
2. Review Common Errors for error messages
3. See Examples for working code
4. Open an issue on GitHub

---

Navigation

Guides:

• iFrame Communication
• Popup Communication
• Worker Communication
• Multi-Window Communication

Back to: Documentation Home | Project Home