search

SolidOS / solid-ui

User Interface widgets and utilities for Solid
https://solidos.github.io/solid-ui/dist/solid-ui.js
MIT License
147 stars 41 forks source link

Clean up API #120

Open megoth opened 5 years ago

megoth commented 5 years ago

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.

megoth commented 4 years ago

An example of a module with a weird name is authn - https://github.com/solid/solid-ui/pull/168#discussion_r359049327. We want to find a better name for this.

brownhoward commented 4 years ago

@RubenVerborgh @jaxoncreed Can you provide thoughts/comments on this ticket?

RubenVerborgh commented 4 years ago

Can you provide thoughts/comments on this ticket?

Not directly, as I have not worked with solid-ui so I don't know the current API. What I can do, if there is an API proposal (or a small UML diagram of the components exposed), then I can provide feedback.