a2ui-project / a2ui-project/a2ui

Reserve internal keywords in component props like child, children, path, etc

Open
#1,376 3 comments 0 reactions 0 assignees View on GitHub
component: specification P2 type: feature/enhancement
Dominant language
TypeScript
Stars
16.4k
Forks
1.3k
Avg merge
2d 13h
Merged PRs (30d)
134

Description

There are some special keywords that should be reserved for the internals of A2UI. Some examples are child, children, path, among others. This surfaced in #1347.

We should do what we can to prevent unintended name collisions with these internal keywords. Maybe add an uncommon prefix, or have some type of build time check that prevents developers from using reserved keywords in their component props

This applies both to internal catalog components, as well as custom components created by devs.

Contributor guide

Open the contributing guide

Research direction

Look at the component prop system in the codebase, likely in core files handling component definitions. Identify where prop names are validated or processed. Reference issue #1347 to understand the specific collision that surfaced. Determine how to add a prefix or build-time check, and ensure it works for both internal catalog components and custom components. Testing will involve creating components with reserved keywords to verify they are blocked or flagged.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
frontend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.