-
Notifications
You must be signed in to change notification settings - Fork 22
Open
Description
Description:
Our component library lacks a consistent event naming and handling pattern across different packages. Each component may be using different event conventions, payloads, and bubbling behaviors. We need to standardize the event system to provide a predictable and consistent API for all consumers, whether they're using Web Components directly or through React bindings.
Expected Behaviour:
- Unified event naming convention (e.g.,
ecc:component-actionorcomponent-action) - Consistent event payload structure with typed interfaces
- Standardized custom event options (bubbles, composed, cancelable)
- Documentation of all events emitted by each component
- Type-safe event listeners for TypeScript users
Approach:
- Audit all existing components in
packages/to document current event usage - Define standard event naming convention and payload structure
- Create shared event utilities/types in
ecc-utils-designfor reusable event helpers - Update all components to use standardized events (breaking change - requires major version bump)
- Generate event documentation automatically from TypeScript definitions
- Update documentation site with event reference guide
- Provide migration guide for existing consumers
Metadata
Metadata
Assignees
Labels
No labels
Type
Projects
Status
Ready