v5 component refactor: Dialog/Modal

[HollyJoyPhillips]

Abstract

As part of the v5 Elements release, each component will be reviewed and refactored to ensure best practice and design system alignment

Specification

• Is new component or existing? Existing
• Is the component being re-named? Yes - currently we use 'Modal' - DS renamed to 'Dialog'
• Is the component design signed off by product and design? Yes
• Guide to component structure & documentation in storybook
• Link to DS in Figma
• Link to Elements Audit in Figma
• Link to Elements
• Accessibility requirements
• See below comment from Kurt as a suggested approach

Developer Checklist

• [ ] Styles alignment between Design System and Elements
• [ ] Check design tokens in Figma and implement CSS variable tokens if available for relevant component
• [ ] Align with accessibility standards / spec as per above
• [ ] If relevant, break down component into Styles Only and React component structures
• [ ] Ensure all variants of components are documented as appropriate
• [ ] Ensure unit test coverage is adequate for component
• [ ] Update documentation in MDX file as per guidelines
• [ ] Changelog updated to reflect a single beta version per component ideally

Release Checklist

• [ ] Approved PR merged to main
• [ ] Design & product review and feedback addressed by developer
• [ ] Beta release by product / engineering lead to next beta version

Additional Context or Information

[kurtdoherty]

suggestion: It would be great if we could align Element's Dialog/Modal component with the Console Cloud team's react-ui-core Dialog, as that will make migration for us much simpler.

suggestion: Given the a11y requirements around modals, it might be best for us to leverage the built-in dialog. I recently did a POC demonstrating this is possible for both Drawers and Dialogs.

[willmcvay]

suggestion: It would be great if we could align Element's Dialog/Modal component with the Console Cloud team's react-ui-core Dialog, as that will make migration for us much simpler.

suggestion: Given the a11y requirements around modals, it might be best for us to leverage the built-in dialog. I recently did a POC demonstrating this is possible for both Drawers and Dialogs.

Really like this as an approach - nice one @kurtdoherty