Skip to content

Replace dismissible with disableClose in Modal #1777

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.

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

Merged
merged 5 commits into from
Apr 16, 2019

Conversation

aswinshenoy
Copy link
Contributor

@aswinshenoy aswinshenoy commented Mar 1, 2019

Fixes #503

Additional description

Replaced instances of the prop-type dismissible with disableClose


CONTRIBUTOR checklist (do not remove)

Please complete for every pull request

  • First-time contributors should sign the Contributor License Agreement. It's a fancy way of saying that you are giving away your contribution to this project. If you haven't before, wait a few minutes and a bot will comment on this pull request with instructions.
  • npm run lint:fix has been run and linting passes.
  • Review the appropriate Storybook stories. Open http://localhost:9001/.
  • Mocha, Jest (Storyshots), and components/component-docs.json CI tests pass (npm test).
  • Tests have been added for new props to prevent regressions in the future. See readme.
  • The Accessibility panel of each Storybook story has 0 violations (aXe). Open http://localhost:9001/.
  • Review tests are passing in the browser. Open http://localhost:8001/.
  • Review markup conforms to SLDS by looking at DOM snapshot strings.

REVIEWER checklist (do not remove)

  • TravisCI tests pass. This includes linting, Mocha, Jest, Storyshots, and components/component-docs.json tests.
  • Tests have been added for new props to prevent regressions in the future. See readme.
  • Review the appropriate Storybook stories. Open http://localhost:9001/.
  • The Accessibility panel of each Storybook story has 0 violations (aXe). Open http://localhost:9001/.
  • Review tests are passing in the browser. Open http://localhost:8001/.
  • Review markup conforms to SLDS by looking at DOM snapshot strings.
Required only if there are markup / UX changes
  • Add year-first date and commit SHA to last-slds-markup-review in package.json and push.
  • Request a review of the deployed Heroku app by the Salesforce UX Accessibility Team.
  • Add year-first review date, and commit SHA, last-accessibility-review, to package.json and push.
  • While the contributor's branch is checked out, run npm run local-update within locally cloned site repo to confirm the site will function correctly at the next release.

/**
* If true, Modals can be dismissed by clicking outside of modal. If unspecified, defaults to dismissible.
* If true, Modals can be dismissed by clicking outside of modal. If unspecified, defaults to disableClose.
*/
dismissOnClickOutside: PropTypes.bool,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have another prop called dismiss.... I would think we would want to do the same to be consistent?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hey @davidlygagnon, I didn't get you on this? can you kindly clarify :)

Copy link
Contributor

@tanhengyeow tanhengyeow Mar 5, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think what @davidlygagnon means is that we keep the semantics similar, e.g. change all dismiss... to disable..., similar to the change from dismissable to disableClose.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@davidlygagnon What name would you recommend?

Copy link
Contributor

@davidlygagnon davidlygagnon Mar 7, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't that follow the same pattern as disableClose?

/**
 * If true, Modals cannot be dismissed by clicking outside of modal. If unspecified, defaults to disableClose.
 */
disableCloseOnClickOutside: PropTypes.bool,

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got it. Yes, great suggestion.

dismissOnClickOutside is a default true also, it's just not in the default props, since it defers to the dismissible if undefined.

dismissOnClickOutside should become disableCloseOnClickOutside also.

@interactivellama interactivellama self-requested a review April 16, 2019 21:44
@interactivellama
Copy link
Contributor

@davidlygagnon I've created #1916 to handle other default true prop.

@interactivellama interactivellama merged commit 55cf3a0 into salesforce:master Apr 16, 2019
@davidlygagnon
Copy link
Contributor

Cool thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Replace Modal's default true prop: dismissable
4 participants