@aws/mynah-ui 4.16.1 → 4.17.0
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 +14 -7
- package/dist/components/chat-item/chat-item-card.d.ts +1 -0
- package/dist/components/chat-item/chat-item-information-card.d.ts +22 -0
- package/dist/main.js +1 -1
- package/dist/main.js.map +1 -1
- package/dist/static.d.ts +19 -7
- package/docs/DATAMODEL.md +49 -0
- package/docs/img/data-model/chatItems/information-card-statuses.jpg +0 -0
- package/docs/img/data-model/chatItems/information-card.png +0 -0
- package/package.json +6 -4
- package/ui-tests/dist/main.js +1 -1
- package/ui-tests/dist/main.js.map +1 -1
package/README.md
CHANGED
|
@@ -24,16 +24,23 @@ Mynah UI operates independently of any framework or UI library, enabling seamles
|
|
|
24
24
|
* [Live Demo](https://aws.github.io/mynah-ui/)
|
|
25
25
|
* [API Docs](https://aws.github.io/mynah-ui/api-doc/index.html)
|
|
26
26
|
|
|
27
|
+
|
|
27
28
|
### Setup, configuration and use
|
|
28
29
|
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
cd mynah-ui && npm install
|
|
34
|
-
cd example && npm install
|
|
30
|
+
To set up your local development environment quickly, run the following command:
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
npm run dev
|
|
35
34
|
```
|
|
36
|
-
|
|
35
|
+
|
|
36
|
+
This command will:
|
|
37
|
+
1. **Clean**: Remove existing `dist` and `node_modules` directories to ensure you're working with a fresh environment.
|
|
38
|
+
2. **Install**: Reinstall all necessary dependencies for both the main project and the example project.
|
|
39
|
+
3. **Build**: Compile the project using Webpack in production mode.
|
|
40
|
+
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`.
|
|
41
|
+
5. **Watch**: Start the main project in `watch` mode.
|
|
42
|
+
After running this command, any changes you make will automatically rebuild and refresh your development environment, allowing you to work seamlessly.
|
|
43
|
+
|
|
37
44
|
|
|
38
45
|
#### Guides and documentation
|
|
39
46
|
Please refer to the following guides:
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import { ExtendedHTMLElement } from '../../helper/dom';
|
|
2
|
+
import { ChatItemContent, Status } from '../../static';
|
|
3
|
+
import { MynahIcons } from '../icon';
|
|
4
|
+
export interface ChatItemInformationCardProps {
|
|
5
|
+
tabId: string;
|
|
6
|
+
messageId: string | undefined;
|
|
7
|
+
informationCard: {
|
|
8
|
+
title?: string;
|
|
9
|
+
status?: {
|
|
10
|
+
status?: Status;
|
|
11
|
+
icon?: MynahIcons;
|
|
12
|
+
body?: string;
|
|
13
|
+
};
|
|
14
|
+
description?: string;
|
|
15
|
+
icon?: MynahIcons;
|
|
16
|
+
content: ChatItemContent;
|
|
17
|
+
};
|
|
18
|
+
}
|
|
19
|
+
export declare class ChatItemInformationCard {
|
|
20
|
+
render: ExtendedHTMLElement;
|
|
21
|
+
constructor(props: ChatItemInformationCardProps);
|
|
22
|
+
}
|