README.md

Mynah UI

A Data & Event Driven Chat Interface Library for Browsers and Webviews

Mynah UI is a data and event driven chat interface designed for browsers and webviews on IDEs or any platform supporting the latest web technologies. It is utilized by Amazon Q for VSCode and JetBrains, and is included with the AWS Toolkit extension.

Mynah UI operates independently of any framework or UI library, enabling seamless integration into any web-based project. This design choice ensures high configurability for theming, supporting various use cases. It functions as a standalone solution, requiring only a designated rendering location within the DOMTree.

Table of contents

• Quick links
• Setup, configuration and use
  • Guides and documentation
  • Preview
• Supported Browsers
• Security
• License

Quick links

• Live Demo
• API Docs

Setup, configuration and use

Tip

Local environment quick start

git clone [email protected]:aws/mynah-ui.git
cd mynah-ui && npm install
cd example && npm install

Now run npm watch in both the mynah-ui and the example directories, and open mynah-ui/example/dist/index.html in a browser of choice.

Guides and documentation

Please refer to the following guides:

• Startup guide
• Constructor properties
• Configuration
• Usage
• Data model
• Styling
• Developer guidelines (contribution)

Preview

Supported Browsers

Mynah UI - due to its extensive CSS structure - supports only evergreen browsers, including WebKit-based WebUI renderers.

Security

See CONTRIBUTING for more information.

License

Apache 2.0 License.