@aws/mynah-ui

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

To set up your local development environment quickly, run the following command:

npm run dev

This command will:

1. Clean: Remove existing dist and node_modules directories to ensure you're working with a fresh environment.
2. Install: Reinstall all necessary dependencies for both the main project and the example project.
3. Build: Compile the project using Webpack in production mode.
4. Start Example: Install dependencies and build the example project, then start the development server with watch mode enabled. The project will be served on localhost:9000 using live-server.
5. Watch: Start the main project in watch mode. After running this command, any changes you make will automatically rebuild and refresh your development environment, allowing you to work seamlessly.

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.