@atlaskit/modal-dialog/offerings.json

A modal dialog displays content that requires user interaction, in a layer above the page.

[
	{
		"name": "Modal",
		"package": "@atlaskit/modal-dialog",
		"import": {
			"name": "Modal",
			"package": "@atlaskit/modal-dialog",
			"type": "default"
		},
		"keywords": ["modal", "dialog", "popup", "overlay", "focused", "interaction", "layer"],
		"categories": ["overlay"],
		"shortDescription": "A modal dialog component for important content.",
		"status": "general-availability",
		"accessibilityGuidelines": [
			"Ensure modal content is announced by screen readers",
			"Provide appropriate focus management",
			"Use clear, descriptive modal titles",
			"Ensure keyboard navigation and escape key support",
			"Maintain focus within modal when open"
		],
		"usageGuidelines": [
			"Use for important content that requires user attention",
			"Keep modal content focused on a single task",
			"Provide clear action buttons",
			"Use appropriate modal sizes for content",
			"Consider mobile responsiveness"
		],
		"contentGuidelines": [
			"Use clear, descriptive titles",
			"Keep content focused on a single task or message",
			"Include clear action buttons",
			"Use sentence case for all text",
			"Provide clear next steps"
		],
		"examples": ["./examples/constellation/modal-default.tsx"]
	}
]