@aws/mynah-ui 4.15.2 → 4.15.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
|
@@ -1,40 +1,60 @@
|
|
|
1
|
+
|
|
1
2
|
# Mynah UI
|
|
2
|
-
|
|
3
|
+
> *A Data & Event Driven Chat Interface Library for Browsers and Webviews*
|
|
3
4
|
|
|
4
|
-
|
|
5
|
-
|
|
5
|
+
[](https://github.com/aws/mynah-ui/actions/workflows/new_pr.yml)
|
|
6
|
+
[](https://github.com/aws/mynah-ui/actions/workflows/beta.yml)
|
|
7
|
+
[](https://github.com/aws/mynah-ui/actions/workflows/publish.yml)
|
|
8
|
+
[](https://github.com/aws/mynah-ui/actions/workflows/deploy.yml)
|
|
6
9
|
|
|
7
|
-
|
|
10
|
+
**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](https://marketplace.visualstudio.com/items?itemName=AmazonWebServices.aws-toolkit-vscode) and [JetBrains](https://plugins.jetbrains.com/plugin/11349-aws-toolkit--amazon-q-codewhisperer-and-more), and is included with the AWS Toolkit extension.
|
|
8
11
|
|
|
9
|
-
|
|
12
|
+
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.
|
|
10
13
|
|
|
11
|
-
|
|
14
|
+
## Table of contents
|
|
15
|
+
- [Quick links](#quick-links)
|
|
16
|
+
- [Setup, configuration and use](#setup-configuration-and-use)
|
|
17
|
+
- [Guides and documentation](#guides-and-documentation)
|
|
18
|
+
- [Preview](#preview)
|
|
19
|
+
- [Supported Browsers](#supported-browsers)
|
|
20
|
+
- [Security](#security)
|
|
21
|
+
- [License](#license)
|
|
12
22
|
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
### [Configuration](./docs/CONFIG.md)
|
|
17
|
-
### [How to use MynahUI](./docs/USAGE.md)
|
|
18
|
-
### [Data Model](./docs/DATAMODEL.md)
|
|
19
|
-
### [Styling Configuration](./docs/STYLING.md)
|
|
23
|
+
### Quick links
|
|
24
|
+
* [Live Demo](https://aws.github.io/mynah-ui/)
|
|
25
|
+
* [API Docs](https://aws.github.io/mynah-ui/api-doc/index.html)
|
|
20
26
|
|
|
21
|
-
and
|
|
27
|
+
### Setup, configuration and use
|
|
22
28
|
|
|
23
|
-
|
|
29
|
+
>[!TIP]
|
|
30
|
+
> Local environment quick start
|
|
31
|
+
```console
|
|
32
|
+
git clone git@github.com:aws/mynah-ui.git
|
|
33
|
+
cd mynah-ui
|
|
34
|
+
npm run dev
|
|
35
|
+
```
|
|
24
36
|
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
</p>
|
|
37
|
+
#### Guides and documentation
|
|
38
|
+
Please refer to the following guides:
|
|
28
39
|
|
|
29
|
-
|
|
30
|
-
|
|
40
|
+
* [Startup guide](./docs/STARTUP.md)
|
|
41
|
+
* [Constructor properties](./docs/PROPERTIES.md)
|
|
42
|
+
* [Configuration](./docs/CONFIG.md)
|
|
43
|
+
* [Usage](./docs/USAGE.md)
|
|
44
|
+
* [Data model](./docs/DATAMODEL.md)
|
|
45
|
+
* [Styling](./docs/STYLING.md)
|
|
46
|
+
* [Developer guidelines (contribution)](./docs/DEVELOPER.md)
|
|
31
47
|
|
|
48
|
+
#### Preview
|
|
49
|
+
|
|
32
50
|
|
|
33
|
-
|
|
51
|
+
### Supported Browsers
|
|
34
52
|
|
|
35
|
-
|
|
53
|
+
**Mynah UI** <em>- due to its extensive CSS structure -</em> supports only evergreen browsers, including WebKit-based WebUI renderers.
|
|
36
54
|
|
|
37
|
-
##
|
|
55
|
+
## Security
|
|
38
56
|
|
|
39
|
-
|
|
57
|
+
See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
|
|
40
58
|
|
|
59
|
+
# License
|
|
60
|
+
[Apache 2.0 License.](LICENSE)
|
|
@@ -29,6 +29,7 @@ export declare class ChatPromptInput {
|
|
|
29
29
|
constructor(props: ChatPromptInputProps);
|
|
30
30
|
private readonly updateAvailableCharactersIndicator;
|
|
31
31
|
private readonly handleInputKeydown;
|
|
32
|
+
private readonly handleInputFocus;
|
|
32
33
|
private readonly getQuickPickItemGroups;
|
|
33
34
|
private readonly handleQuickActionCommandSelection;
|
|
34
35
|
private readonly handleContextCommandSelection;
|