Clean up API
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 153
- Forks
- 46
- Avg merge
- 1d 8h
- Merged PRs (30d)
- 7
Description
Some methods are currently a bit misplaced and hence become more difficult for people to discover for people unbeknownst to solid-ui.
I suggest that at some point we do some analysis of the current API (especially the methods in widgets/button, which contains a lot of lower-level functionality that doesn't necessarily pertain to buttons at all) to move some methods around to "proper" namespaces.
The challenge with this is to make sure we are backward-compatible, so probably want to maintain some of the methods even though they are moved, but show a deprecation warning for a certain amount of time.
Contributor guide
No contributing guide indexed for this repository
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.
Research direction
Start by auditing the current API, especially the methods in widgets/button, and identify functionality that does not belong to button-specific namespaces. Map possible destination namespaces and review how backward compatibility could be preserved through deprecated methods. Done means the API has a documented reorganization plan with a deprecation approach.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- frontend
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100