Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Modal Button Examples Update #2904

Closed
wants to merge 6 commits into from
Closed

chore: Modal Button Examples Update #2904

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
98c9bd0
chore: Updated Modal examples and added docs
josh-bagwell Sep 3, 2024
e5a22f3
chore: Updated button placements
josh-bagwell Sep 4, 2024
66dbc78
chore: Removed commented code in Modal Stories
josh-bagwell Sep 4, 2024
2fc36cb
chore: Removed commented code in Modal Stories
josh-bagwell Sep 4, 2024
ed83053
chore: Made edits to note in Modal docs
josh-bagwell Sep 4, 2024
86c636d
Merge branch 'prerelease/major' into modal-button-example-update-24-08
mannycarrera4 Sep 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions cypress/component/Modal.spec.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ describe('Modal', () => {
});

it('should trap focus inside the modal element', () => {
cy.tab().should('contain', 'Acknowledge').tab().should('contain', 'Cancel').tab();
cy.tab().should('contain', 'Cancel').tab().should('contain', 'Acknowledge').tab();
cy.findByRole('dialog', {name: 'MIT License'})
.findByRole('button', {name: 'Close'})
.should('have.focus');
Expand Down Expand Up @@ -520,11 +520,11 @@ context(`given the [Components/Popups/Modal, Custom focus] story is rendered`, (

it('should trap focus inside the modal element', () => {
cy.focused()
.tab()
.should('contain', 'Acknowledge')
.tab()
.should('contain', 'Cancel')
.tab()
.should('contain', 'Acknowledge')
.tab()
.should('have.attr', 'aria-label', 'Close')
.tab();
cy.findByLabelText('Initials').should('have.focus');
Expand Down
5 changes: 5 additions & 0 deletions modules/react/modal/stories/Modal.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import {ExampleCodeBlock, SymbolDoc, Specifications} from '@workday/canvas-kit-docs';
import {Source, Canvas, Stories} from '@storybook/blocks'

import {Basic} from './examples/Basic';
import {WithoutCloseIcon} from './examples/WithoutCloseIcon';
Expand All @@ -19,6 +20,10 @@ interaction with the rest of the page. A Modal will render the rest of the page
Modal is dismissed. A Modal should be used when the user needs to presented with important
information that must be interacted with before continuing interaction with the rest of the page.

>**Note: We recommend the main call-to-action button (i.e. "Acknowledge", "Submit", "Accept", etc.) be positioned after a non-call-to-action button (i.e. "Cancel", "Close", etc.)**

>**This allows a user to view all of their options when making a decision on which button to click for a Modal.**

## Installation

```sh
Expand Down
2 changes: 1 addition & 1 deletion modules/react/modal/stories/examples/Basic.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,10 @@ export const Basic = () => {
</Box>
</Modal.Body>
<Flex gap="s" padding="xxs" marginTop="xxs">
<Modal.CloseButton onClick={handleCancel}>Cancel</Modal.CloseButton>
<Modal.CloseButton as={PrimaryButton} onClick={handleAcknowledge}>
Acknowledge
</Modal.CloseButton>
<Modal.CloseButton onClick={handleCancel}>Cancel</Modal.CloseButton>
</Flex>
</Modal.Card>
</Modal.Overlay>
Expand Down
2 changes: 1 addition & 1 deletion modules/react/modal/stories/examples/BodyOverflow.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,10 +82,10 @@ export const BodyOverflow = () => {
</p>
</Modal.Body>
<Flex gap="s" padding="xxs" marginTop="xxs">
<Modal.CloseButton onClick={handleCancel}>Cancel</Modal.CloseButton>
<Modal.CloseButton as={PrimaryButton} onClick={handleAcknowledge}>
Acknowledge
</Modal.CloseButton>
<Modal.CloseButton onClick={handleCancel}>Cancel</Modal.CloseButton>
</Flex>
</Modal.Card>
</Modal.Overlay>
Expand Down
2 changes: 1 addition & 1 deletion modules/react/modal/stories/examples/CustomFocus.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,10 @@ export const CustomFocus = () => {
</FormField>
</Modal.Body>
<Flex gap="s" padding="xxs" marginTop="xxs">
<Modal.CloseButton>Cancel</Modal.CloseButton>
<Modal.CloseButton as={PrimaryButton} onClick={handleAcknowledge}>
Acknowledge
</Modal.CloseButton>
<Modal.CloseButton>Cancel</Modal.CloseButton>
</Flex>
</Modal.Card>
</Modal.Overlay>
Expand Down
2 changes: 1 addition & 1 deletion modules/react/modal/stories/examples/FullOverflow.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,10 +82,10 @@ export const FullOverflow = () => {
</p>
</Modal.Body>
<Flex gap="s" padding="xxs" marginTop="xxs">
<Modal.CloseButton onClick={handleCancel}>Cancel</Modal.CloseButton>
<Modal.CloseButton as={PrimaryButton} onClick={handleAcknowledge}>
Acknowledge
</Modal.CloseButton>
<Modal.CloseButton onClick={handleCancel}>Cancel</Modal.CloseButton>
</Flex>
</Modal.Card>
</Modal.OverflowOverlay>
Expand Down
2 changes: 1 addition & 1 deletion modules/react/modal/stories/examples/IframeTest.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ export const IframeTest = () => {
<Modal.Body>
<p>Are you sure you want to delete the item?</p>
<Flex gap="s">
<Modal.CloseButton as={DeleteButton}>Delete</Modal.CloseButton>
<Modal.CloseButton>Cancel</Modal.CloseButton>
<Modal.CloseButton as={DeleteButton}>Delete</Modal.CloseButton>
</Flex>
<iframe srcDoc="<html><body>Hello, <b>world</b>.<button>iframe button 1</button><button>iframe button 2</button></body></html>" />
</Modal.Body>
Expand Down
2 changes: 1 addition & 1 deletion modules/react/modal/stories/examples/ModalWithPopup.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ export const ModalWithPopup = () => {
<Popup.Body>
<p>Are you sure you'd like to delete the item titled 'My Item'?</p>
<Flex gap="s">
<Popup.CloseButton>Cancel</Popup.CloseButton>
<Popup.CloseButton
as={DeleteButton}
onClick={event => {
Expand All @@ -51,7 +52,6 @@ export const ModalWithPopup = () => {
>
Yes, Really Delete
</Popup.CloseButton>
<Popup.CloseButton>Cancel</Popup.CloseButton>
</Flex>
</Popup.Body>
</Popup.Card>
Expand Down
2 changes: 1 addition & 1 deletion modules/react/modal/stories/examples/ReturnFocus.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,10 @@ export const ReturnFocus = () => {
</Box>
</Modal.Body>
<Flex gap="s" padding="xxs" marginTop="xxs">
<Modal.CloseButton>Cancel</Modal.CloseButton>
<Modal.CloseButton as={DeleteButton} onClick={handleDelete}>
Delete
</Modal.CloseButton>
<Modal.CloseButton>Cancel</Modal.CloseButton>
</Flex>
</Modal.Card>
</Modal.Overlay>
Expand Down
2 changes: 1 addition & 1 deletion modules/react/modal/stories/examples/StackedModals.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ export const StackedModals = () => {
Are you <em>really</em> sure you want to delete the item?
</p>
<Flex gap="s">
<Modal.CloseButton>Cancel</Modal.CloseButton>
<Modal.CloseButton
as={DeleteButton}
onClick={event => {
Expand All @@ -40,7 +41,6 @@ export const StackedModals = () => {
>
Yes, Really Delete
</Modal.CloseButton>
<Modal.CloseButton>Cancel</Modal.CloseButton>
</Flex>
</Modal.Body>
</Modal.Card>
Expand Down
Loading