Skip to content

Commit aa0bb52

Browse files
committed
merging release v3.6.1
2 parents 53a46f6 + d91210e commit aa0bb52

14 files changed

Lines changed: 46 additions & 21 deletions

File tree

docs/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "nci-design-system",
3-
"version": "3.6.0",
3+
"version": "3.6.1",
44
"description": "NCI Design System",
55
"author": "NCIOCPL",
66
"private": true,

lerna.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,6 @@
1919
]
2020
},
2121
"npmClient": "pnpm",
22-
"version": "3.6.0",
22+
"version": "3.6.1",
2323
"$schema": "node_modules/lerna/schemas/lerna-schema.json"
2424
}

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "ncids",
3-
"version": "3.6.0",
3+
"version": "3.6.1",
44
"description": "Monorepo for the NCI Design System",
55
"main": "index.js",
66
"repository": "https://github.com/NCIOCPL/ncids.git",

packages/ncids-css/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@nciocpl/ncids-css",
3-
"version": "3.6.0",
3+
"version": "3.6.1",
44
"description": "CSS library for the National Cancer Institute Design System (NCIDS)",
55
"repository": {
66
"type": "git",

packages/ncids-js/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@nciocpl/ncids-js",
3-
"version": "3.6.0",
3+
"version": "3.6.1",
44
"description": "JS library for the National Cancer Institute Design System",
55
"author": "NCIOCPL",
66
"homepage": "https://github.com/NCIOCPL/ncids#readme",

packages/ncids-js/src/components/usa-accordion/index.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,6 @@
22
* @packageDocumentation
33
*/
44
export { USAAccordion } from './usa-accordion.component';
5+
6+
import { AccordionOptions } from './usa-accordion-options';
7+
export type { AccordionOptions };
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,25 @@
11
import { ModalEventDetails } from './modal.event-details';
22

3+
/**
4+
* Enum representing the possible actions that can trigger the closing of a modal.
5+
*/
36
export enum ModalCloseAction {
7+
/* Modal Closed with Escape Key */
48
KEY_ESCAPE = 'escape',
9+
/* Modal Closed with Click Outside the Modal */
510
CLICK_OUTSIDE = 'outside',
11+
/* Modal Closed with Close Icon */
612
CLOSE_BUTTON = 'close',
13+
/* Modal Closed with Escape Key */
714
FOOTER_BUTTON = 'footer',
15+
/* Modal Closed with Escape Key */
816
OTHER_BUTTON = 'other',
917
}
1018

1119
/**
1220
* Custom event details for the `modal:close` event.
1321
*/
1422
export type ModalCloseEventDetails = ModalEventDetails & {
23+
/** The Close Action that triggered the event */
1524
closeAction?: ModalCloseAction;
1625
};

packages/ncids-js/src/components/usa-modal/index.ts

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,16 @@ export { USAModal } from './modal.component';
1010

1111
import type { ModalEventDetails } from './event-details/modal.event-details';
1212
import type { ModalCloseEventDetails } from './event-details/modal.close.event-details';
13+
import type { ModalCloseAction } from './event-details/modal.close.event-details';
14+
import type { ModalConfig } from './modal-config';
15+
import type { ModalContent } from './modal-content';
16+
import type { ModalButtons } from './modal-buttons';
1317

14-
export type { ModalEventDetails, ModalCloseEventDetails };
18+
export type {
19+
ModalEventDetails,
20+
ModalCloseEventDetails,
21+
ModalCloseAction,
22+
ModalConfig,
23+
ModalContent,
24+
ModalButtons,
25+
};

packages/ncids-js/src/components/usa-modal/modal-content.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,10 @@ import { ModalButtons } from './modal-buttons';
1515
* ```
1616
*/
1717
export type ModalContent = {
18+
/** The title of the modal, which can be a string or an HTML heading element. */
1819
title?: string | HTMLHeadingElement;
20+
/** The content of the modal, which can be a string or an HTML element. */
1921
content: string | HTMLElement;
22+
/** An optional array of buttons to be displayed in the modal footer. */
2023
footer?: ModalButtons[];
2124
};

packages/ncids-js/src/components/usa-modal/modal.component.ts

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
import { ModalConfig } from './modal-config';
2+
import { ModalContent } from './modal-content';
3+
import { ModalButtons } from './modal-buttons';
4+
import { FocusTrap } from '../../utils/focus-trap';
5+
import { scrollbarWidth } from './utils/scrollbar-width';
6+
import { ModalEventDetails } from './event-details/modal.event-details';
7+
import { ModalCloseEventDetails } from './event-details/modal.close.event-details';
8+
import { ModalCloseAction } from './event-details/modal.close.event-details';
9+
110
/**
211
* The USAModal component is used to initialize and manage the `.usa-modal`
312
* component.
@@ -95,16 +104,6 @@
95104
*
96105
* These events provide hooks for integrating with analytics or other JavaScript logic to enhance user interaction tracking.
97106
*/
98-
99-
import { ModalConfig } from './modal-config';
100-
import { ModalContent } from './modal-content';
101-
import { ModalButtons } from './modal-buttons';
102-
import { FocusTrap } from '../../utils/focus-trap';
103-
import { scrollbarWidth } from './utils/scrollbar-width';
104-
import { ModalEventDetails } from './event-details/modal.event-details';
105-
import { ModalCloseEventDetails } from './event-details/modal.close.event-details';
106-
import { ModalCloseAction } from './event-details/modal.close.event-details';
107-
108107
export class USAModal {
109108
/** The .usa-modal element. */
110109
protected modal: HTMLElement;

0 commit comments

Comments
 (0)