|
6 | 6 | * @description |
7 | 7 | * Component for rendering a notification drawer. This provides a common mechanism to handle how the notification |
8 | 8 | * drawer should look and behave without mandating the look of the notification group heading or notification body. |
9 | | - * <br><br> |
10 | | - * The notification groups must be passed to create each group in the drawer. Each notification |
11 | | - * group must include a collection of notifications to be shown for that group, the collection MUST be called 'notifications'. |
12 | | - * Each notification should have an 'unread' field in order to style unread notifications and hide/show the Mark All Unread button if desired. |
13 | | - * You must provide the source for the heading, sub-heading, and notification body to show the content you desire for each. |
14 | | - * Pass a customScope object containing any scope variables/functions you need to access from the included source, access these |
15 | | - * via handlers.<your handler> in your included source. |
16 | | - * |
17 | | - * Each notification group can add a 'noNotificationsText' field to override the text specifically for that group. If not supplied the overall |
18 | | - * text given will be used for the group if that is supplied. Otherwise, the default empty message is displayed. |
19 | | - * |
20 | | - * <br><br> |
21 | | - * The pfNotificationDrawer has stylings pre-set from Patternfly (http://www.patternfly.org/) for use within the |
22 | | - * navbar-pf and navbar-pf-vertical containers. If neither is being used, the top and height should be set such that the |
23 | | - * drawer will take up the entire viewport vertically. For instance:<br> |
24 | | - * <p style="margin-left: 20px;"> |
25 | | - * .my-nav-container .drawer-pf {<br> |
26 | | - * height: calc(~"100vh - 46px");<br> |
27 | | - * top: 26px;</br> |
28 | | - * } |
29 | | - * </p> |
30 | | - * Note, this should be bottom aligned with the trigger, and leave a 20px at the bottom of the viewport. |
31 | | - * <br><br> |
| 9 | + * <br> |
| 10 | + * <span class="label-title">Configuration Requirements:</span> |
| 11 | + * <ul> |
| 12 | + * <li>The notification groups must be passed to create each group in the drawer. Each notification group must include a collection of notifications to be shown for that group, the collection MUST be called 'notifications'.</li> |
| 13 | + * <li>Each notification should have an 'unread' field in order to style unread notifications and hide/show the Mark All Unread button if desired.</li> |
| 14 | + * <li>You must provide the source for the heading, sub-heading, and notification body to show the content you desire for each notification.</li> |
| 15 | + * <li> |
| 16 | + * The pfNotificationDrawer has stylings pre-set from Patternfly (http://www.patternfly.org/) for use within the |
| 17 | + * navbar-pf and navbar-pf-vertical containers. If neither is being used, the top and height should be set such that the |
| 18 | + * drawer will take up the entire viewport vertically.<br> |
| 19 | + * For instance:<br> |
| 20 | + * <p style="margin-left: 20px;"> |
| 21 | + * .my-nav-container .drawer-pf {<br> |
| 22 | + * height: calc(~"100vh - 46px");<br> |
| 23 | + * top: 26px;</br> |
| 24 | + * } |
| 25 | + * </p> |
| 26 | + * Note, this should be bottom aligned with the trigger, and leave a 20px at the bottom of the viewport. |
| 27 | + * </li> |
| 28 | + * </ul> |
| 29 | + * <span class="label-title">Other Configuration Options:</span> |
| 30 | + * <ul> |
| 31 | + * <li> Pass a customScope object containing any scope variables/functions you need to access from the included source, access these |
| 32 | + * via handlers.<your handler> in your included source.</li> |
| 33 | + * <li>Each notification group can add a 'noNotificationsText' field to override the text specifically for that group. If not supplied the overall text given will be used for the group if that is supplied. Otherwise, the default empty message is displayed.</li> |
| 34 | + * </ul> |
32 | 35 | * |
33 | 36 | * @param {boolean} drawerHidden Flag if the drawer is currently hidden |
34 | 37 | * @param {boolean} allowExpand Flag if the drawer can be expanded. Optional, default: false |
|
0 commit comments