Skip to content

[Dialog] Add deprecation warning for withMobileDialog #23570

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

Merged
merged 5 commits into from
Nov 19, 2020
Merged

[Dialog] Add deprecation warning for withMobileDialog #23570

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a4a8f82
Add deprecation warning for withMobileDialog
RDIL Nov 16, 2020
1a2f761
Improper use of shallow
RDIL Nov 18, 2020
96d009a
only warn once
oliviertassinari Nov 18, 2020
6da2b68
link docs
oliviertassinari Nov 18, 2020
9b15d00
Sebastian's review
oliviertassinari Nov 18, 2020
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
1 change: 1 addition & 0 deletions docs/public/_redirects
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ https://material-ui.dev/* https://material-ui.com/:splat 301!
/r/ts-issue-template https://www.typescriptlang.org/play/#code/JYWwDg9gTgLgBAKjgQwM5wEoFNkGN4BmUEIcA5FDvmQNwBQokscA3nXHAPSdwwAWWOLhKQAdllEx0ATwgBXOHNRYAJnQC+cIiXIABEMhhYowZABsAtHOCdhlMnToE5o-MAii4AESwgIACgBKVnYuHgBNeSghCBUsDSA 302
/r/custom-component-variants /customization/components/#adding-new-component-variants
/r/x-license https://material-ui.com/store/items/material-ui-x/
/r/migration-v4 https://next.material-ui.com/guides/migration-v4/

# Legacy redirection
# Added in chronological order
Expand Down
13 changes: 13 additions & 0 deletions packages/material-ui/src/withMobileDialog/withMobileDialog.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,25 @@ import * as React from 'react';
import PropTypes from 'prop-types';
import withWidth, { isWidthDown } from '../withWidth';

let warnedOnce = false;

/**
* Dialog will responsively be full screen *at or below* the given breakpoint
* (defaults to 'sm' for mobile devices).
* Notice that this Higher-order Component is incompatible with server-side rendering.
*/
const withMobileDialog = (options = {}) => (Component) => {
if (process.env.NODE_ENV !== 'production') {
if (!warnedOnce) {
console.warn(
[
'Material-UI: The `withMobileDialog` function is deprecated.',
'Head to https://material-ui.com/r/migration-v4/#dialog for a migration path.',
].join('\n'),
);
warnedOnce = true;
}
}
const { breakpoint = 'sm' } = options;

function WithMobileDialog(props) {
Expand Down
6 changes: 6 additions & 0 deletions packages/material-ui/src/withMobileDialog/withMobileDialog.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import { expect } from 'chai';
import { createShallow } from '@material-ui/core/test-utils';
import Dialog from '../Dialog';
import withMobileDialog from './withMobileDialog';
import { consoleWarnMock } from 'test/utils/consoleErrorMock';

describe('withMobileDialog', () => {
let shallow;
Expand All @@ -12,6 +13,11 @@ describe('withMobileDialog', () => {

before(() => {
shallow = createShallow({ dive: true });
consoleWarnMock.spy();
});

after(() => {
consoleWarnMock.reset();
});

function isFullScreen(breakpoints, width) {
Expand Down