EditableList's attribute-based approach makes for a confusing example
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 30/100
- Issue type
- Refactor
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- javascript
Research direction
Locate the EditableList web component example and inspect how it currently receives individual list items through attributes. Compare the proposed property, JSON-attribute, and child-element approaches, then establish one consistent API and update the example so its usage demonstrates the chosen design.
Written by the indexing model from the issue text.
Description
Taking list items as individual items is a pretty awkward API that people are using as an example of why web components have a bad API. It's a poor argument - you can make a similar component API in any framework - but there's no reason IMO to design a component this way. It would be far more ergonomic to take a list of items as a property, a JSON array as an attributes, and/or a list of child elements.
- Dominant language
- JavaScript
- Stars
- 3.4k
- Forks
- 815
- PR merge metrics
- No merged PRs in 30d
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from mdn/web-components-examples
-
needs triage
Difficulty 5/5 Over a week Newbie friendliness 10/100
mdn/web-components-examples#100 ·
-
Add form-associated element exampleMay be free again @JuanJefry23 claimed this 1059 days ago, and no pull request is open. Openaccepting pr effort: medium new example
Difficulty 2/5 1-3 hours Newbie friendliness 45/100
mdn/web-components-examples#53 · 2 comments ·
-
bug Content: WebAPI help wanted
Difficulty 3/5 1-2 days Newbie friendliness 28/100
mdn/web-components-examples#29 · 1 comment ·
All issues in mdn/web-components-examples
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
keyxmakerx/Chronicle#2284 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 73/100
soroswap/token-list#125 ·
Maintainers usually reply within 1 day
-
marketing
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
Maintainers usually reply within 1 day
-
bug help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
EveryInc/compound-engineering-plugin#2085 ·
Maintainers usually reply within 1 day