block-readme-template.md

Block

Overview

Integration

Block Configuration

Configuration Key	Type	Default	Description	Required	Side Effects
key-name	string	'default'	Description of what this config does	No	How it affects block behavior

URL Parameters

• param-name - Description of parameter usage

Local Storage

• storage-key - Description of stored data

Events

Event Listeners

• events.on('event-name', callback) - Description of what triggers this and what it does
• events.on('another-event', callback) - Description

Event Emitters

• events.emit('event-name', data) - When this is emitted and what data is sent

Behavior Patterns

Page Context Detection

• Context A: When [condition], the block [behavior]
• Context B: When [condition], the block [behavior]

User Interaction Flows

1. Flow Name: [Step-by-step description of user interaction]

Error Handling

• Error Type: How it's caught and handled
• Fallback Behavior: What happens when errors occur