Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Consider a less confusing package name #60

Open
robintown opened this issue Jul 13, 2022 · 2 comments
Open

Consider a less confusing package name #60

robintown opened this issue Jul 13, 2022 · 2 comments
Labels
enhancement New feature or request

Comments

@robintown
Copy link
Member

robintown commented Jul 13, 2022

Is your feature request related to a problem? Please describe.
The name 'matrix-widget-api' causes the package to frequently get confused with the The Widget API when talking to people about widgets

Describe the solution you'd like
Something like matrix-widget-sdk?

Describe alternatives you've considered
Unsure

Additional context
Add any other context or screenshots about the feature request here.

@robintown robintown added the enhancement New feature or request label Jul 13, 2022
@turt2live
Copy link
Member

(loose) rationale for naming: "SDK" implies everything is built in for you to make a widget, but it also has a client surface to it which makes it more like a library. "matrix-widget-lib" was awkward to type, so picked "matrix-widget-api".

@turt2live
Copy link
Member

If we do update the name of this package, the following will also need to be updated:

  • Element Web + React SDK
  • Example sticker picker widget
  • Pre-refactoring spec & guides (they're still referenced today)
  • ... other things I forgot, but probably the downstream consumers of this outside of Element.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants