@atlaskit/modal-dialog 14.11.4 → 14.11.5

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/modal-dialog
 
+## 14.11.5
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 14.11.4
 
 ### Patch Changes

package/dist/cjs/internal/components/modal-wrapper.js

@@ -88,7 +88,7 @@ var InternalModalWrapper = function InternalModalWrapper(props) {
     action: 'closed',
     componentName: 'modalDialog',
     packageName: "@atlaskit/modal-dialog",
-    packageVersion: "0.0.0-development"
+    packageVersion: "14.11.4"
   });
   var onBlanketClicked = (0, _react.useCallback)(function (e) {
     if (shouldCloseOnOverlayClick) {

package/dist/es2019/internal/components/modal-wrapper.js

@@ -75,7 +75,7 @@ const InternalModalWrapper = props => {
     action: 'closed',
     componentName: 'modalDialog',
     packageName: "@atlaskit/modal-dialog",
-    packageVersion: "0.0.0-development"
+    packageVersion: "14.11.4"
   });
   const onBlanketClicked = useCallback(e => {
     if (shouldCloseOnOverlayClick) {

package/dist/esm/internal/components/modal-wrapper.js

@@ -79,7 +79,7 @@ var InternalModalWrapper = function InternalModalWrapper(props) {
     action: 'closed',
     componentName: 'modalDialog',
     packageName: "@atlaskit/modal-dialog",
-    packageVersion: "0.0.0-development"
+    packageVersion: "14.11.4"
   });
   var onBlanketClicked = useCallback(function (e) {
     if (shouldCloseOnOverlayClick) {

package/modal-dialog.docs.tsx

@@ -0,0 +1,54 @@
+import path from 'path';
+
+import type { ComponentStructuredContentSource } from '@atlassian/structured-docs-types';
+
+const documentation: ComponentStructuredContentSource[] = [
+	{
+		name: 'Modal',
+		description: 'A modal dialog component for important content.',
+		status: 'general-availability',
+		import: {
+			name: 'Modal',
+			package: '@atlaskit/modal-dialog',
+			type: 'default',
+			packagePath: path.resolve(__dirname),
+			packageJson: require('./package.json'),
+		},
+		usageGuidelines: [
+			'Use for immediate task or critical/warning requiring a response; blocking until closed',
+			'Use sparingly—modals are invasive',
+			'One task per modal; limit interactions; no nested modals (inaccessible)',
+			'Anatomy: header (h1 title), close button, body, footer with primary + cancel/close',
+			'Footer: primary button on the right of secondary; multiple dismissal methods (close button, Esc, blanket click, Cancel/Close)',
+			'Use Popup for smaller info + controls; Spotlight for onboarding; Inline message for alert/action',
+		],
+		contentGuidelines: [
+			'Use clear, descriptive titles',
+			'Primary button label should reflect the modal title',
+			'Use action verbs in button labels',
+			'Keep content focused on a single task or message',
+			'Use sentence case for all text',
+		],
+		accessibilityGuidelines: [
+			'Modal must have a title: use title component, or titleId from useModal, or label (avoid if no visual title)',
+			'Close button is required (except rare cases—consult a11y team)',
+			'Do not rely on color alone for severity; provide accessible label for icons',
+			'Focus order: 1) close (or title or container), 2) first focusable, 3) secondary button, 4) primary, 5) return focus to trigger on close',
+			'Dismiss via: close button, Esc, click blanket, Cancel/Close in footer',
+			'Ensure modal content is announced by screen readers',
+			'Ensure keyboard navigation and escape key support',
+			'Maintain focus within modal when open',
+		],
+		examples: [
+			{
+				name: 'Default',
+				description: 'The default form of a modal dialog.',
+				source: path.resolve(__dirname, './examples/constellation/modal-default.tsx'),
+			},
+		],
+		keywords: ['modal', 'dialog', 'popup', 'overlay', 'focused', 'interaction', 'layer'],
+		categories: ['overlay'],
+	},
+];
+
+export default documentation;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/modal-dialog",
-	"version": "14.11.4",
+	"version": "14.11.5",
 	"description": "A modal dialog displays content that requires user interaction, in a layer above the page.",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -32,7 +32,7 @@
 		"@atlaskit/button": "^23.10.0",
 		"@atlaskit/css": "^0.19.0",
 		"@atlaskit/ds-lib": "^6.0.0",
-		"@atlaskit/icon": "^32.0.0",
+		"@atlaskit/icon": "^33.0.0",
 		"@atlaskit/layering": "^3.6.0",
 		"@atlaskit/motion": "^5.4.0",
 		"@atlaskit/platform-feature-flags": "^1.1.0",
@@ -55,7 +55,7 @@
 		"@af/accessibility-testing": "workspace:^",
 		"@af/integration-testing": "workspace:^",
 		"@af/visual-regression": "workspace:^",
-		"@atlaskit/avatar": "^25.8.0",
+		"@atlaskit/avatar": "^25.9.0",
 		"@atlaskit/avatar-group": "^12.4.0",
 		"@atlaskit/banner": "^14.0.0",
 		"@atlaskit/breadcrumbs": "^15.3.0",
@@ -63,7 +63,7 @@
 		"@atlaskit/code": "^17.4.0",
 		"@atlaskit/datetime-picker": "^17.5.0",
 		"@atlaskit/docs": "^11.7.0",
-		"@atlaskit/dropdown-menu": "^16.6.0",
+		"@atlaskit/dropdown-menu": "^16.7.0",
 		"@atlaskit/flag": "^17.8.0",
 		"@atlaskit/form": "^15.4.0",
 		"@atlaskit/heading": "^5.3.0",
@@ -76,6 +76,7 @@
 		"@atlaskit/textfield": "^8.2.0",
 		"@atlaskit/tooltip": "^20.14.0",
 		"@atlassian/ssr-tests": "workspace:^",
+		"@atlassian/structured-docs-types": "workspace:^",
 		"@testing-library/dom": "^10.1.0",
 		"@testing-library/react": "^16.3.0",
 		"@testing-library/user-event": "^14.4.3",