{"repo":"matrix-org/matrix-widget-api","free":true,"listed":false,"github":"https://github.com/matrix-org/matrix-widget-api","clone":"git clone https://github.com/matrix-org/matrix-widget-api.git","description":"JavaScript/TypeScript API for widgets & web clients to communicate","language":"TypeScript","stars":95,"topics":["widgets","matrix","matrix-widget-api","hacktoberfest"],"license":"Apache-2.0","category":"chat-messaging","readme_excerpt":"matrix-widget-api JavaScript/TypeScript SDK for widgets & clients to communicate. For help and support, visit #matrix-widgets:matrix.org on Matrix. Disclaimer: Widgets are not yet in the Matrix spec, so this library may not work with other implementations. Building To transpile this project to JavaScript, run: Using the API without a bundler If you're looking to drop the widget-api into a web browser without the use of a bundler, add a script tag similar to the following: Note that the version number may need changing to match the current release. Once included, the widget-api will be available under mxwidgets . For example, new mxwidgets.WidgetApi(...) to instantiate the WidgetApi class. Usage for widgets The general usage for this would be: For a more complete example, see the examples directory of this repo. Usage for web clients This SDK is meant for use in browser-based applications. The concepts may be transferable to other platforms, though currently this SDK is intended to only be used by browsers. In the future it may be possible for this SDK to provide an interface for other platforms. TODO: Improve this","default_branch":null,"files":null,"tree":[],"storefront":"/r/matrix-org","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/matrix-org/matrix-widget-api/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}