- Basic
- Asynchronously close
- Customized Footer
- Confirmation modal dialog
- Information modal dialog
- Internationalization
- Manual to update destroy
- To customize the position of modal
- destroy confirmation modal dialog
- Customize footer buttons props
- Use hooks to get context
- Custom modal content render
- To customize the width of modal
- API
Modal
Modal dialogs.
When To Use#
When requiring users to interact with the application, but without jumping to a new page and interrupting the user's workflow, you can use Modal
to create a new floating layer over the current page to get user feedback or display information. Additionally, if you need show a simple confirmation dialog, you can use antd.Modal.confirm()
, and so on.
Examples
import React, { useState } from 'react';
import { Modal, Button } from 'antd';
const App = () => {
const [isModalVisible, setIsModalVisible] = useState(false);
const showModal = () => {
setIsModalVisible(true);
};
const handleOk = () => {
setIsModalVisible(false);
};
const handleCancel = () => {
setIsModalVisible(false);
};
return (
<>
<Button type="primary" onClick={showModal}>
Open Modal
</Button>
<Modal title="Basic Modal" visible={isModalVisible} onOk={handleOk} onCancel={handleCancel}>
<p>Some contents...</p>
<p>Some contents...</p>
<p>Some contents...</p>
</Modal>
</>
);
};
ReactDOM.render(<App />, mountNode);
import { Modal, Button, Space } from 'antd';
function info() {
Modal.info({
title: 'This is a notification message',
content: (
<div>
<p>some messages...some messages...</p>
<p>some messages...some messages...</p>
</div>
),
onOk() {},
});
}
function success() {
Modal.success({
content: 'some messages...some messages...',
});
}
function error() {
Modal.error({
title: 'This is an error message',
content: 'some messages...some messages...',
});
}
function warning() {
Modal.warning({
title: 'This is a warning message',
content: 'some messages...some messages...',
});
}
ReactDOM.render(
<Space wrap>
<Button onClick={info}>Info</Button>
<Button onClick={success}>Success</Button>
<Button onClick={error}>Error</Button>
<Button onClick={warning}>Warning</Button>
</Space>,
mountNode,
);
import { Modal, Button } from 'antd';
function countDown() {
let secondsToGo = 5;
const modal = Modal.success({
title: 'This is a notification message',
content: `This modal will be destroyed after ${secondsToGo} second.`,
});
const timer = setInterval(() => {
secondsToGo -= 1;
modal.update({
content: `This modal will be destroyed after ${secondsToGo} second.`,
});
}, 1000);
setTimeout(() => {
clearInterval(timer);
modal.destroy();
}, secondsToGo * 1000);
}
ReactDOM.render(<Button onClick={countDown}>Open modal to close in 5s</Button>, mountNode);
import { Modal, Button } from 'antd';
import { ExclamationCircleOutlined } from '@ant-design/icons';
function destroyAll() {
Modal.destroyAll();
}
const { confirm } = Modal;
function showConfirm() {
for (let i = 0; i < 3; i += 1) {
setTimeout(() => {
confirm({
icon: <ExclamationCircleOutlined />,
content: <Button onClick={destroyAll}>Click to destroy all</Button>,
onOk() {
console.log('OK');
},
onCancel() {
console.log('Cancel');
},
});
}, i * 500);
}
}
ReactDOM.render(<Button onClick={showConfirm}>Confirm</Button>, mountNode);
import { Modal, Button, Space } from 'antd';
const ReachableContext = React.createContext();
const UnreachableContext = React.createContext();
const config = {
title: 'Use Hook!',
content: (
<>
<ReachableContext.Consumer>{name => `Reachable: ${name}!`}</ReachableContext.Consumer>
<br />
<UnreachableContext.Consumer>{name => `Unreachable: ${name}!`}</UnreachableContext.Consumer>
</>
),
};
const App = () => {
const [modal, contextHolder] = Modal.useModal();
return (
<ReachableContext.Provider value="Light">
<Space>
<Button
onClick={() => {
modal.confirm(config);
}}
>
Confirm
</Button>
<Button
onClick={() => {
modal.warning(config);
}}
>
Warning
</Button>
<Button
onClick={() => {
modal.info(config);
}}
>
Info
</Button>
<Button
onClick={() => {
modal.error(config);
}}
>
Error
</Button>
</Space>
{/* `contextHolder` should always under the context you want to access */}
{contextHolder}
{/* Can not access this context since `contextHolder` is not in it */}
<UnreachableContext.Provider value="Bamboo" />
</ReachableContext.Provider>
);
};
ReactDOM.render(<App />, mountNode);
import React, { useState } from 'react';
import { Modal, Button } from 'antd';
const App = () => {
const [visible, setVisible] = useState(false);
return (
<>
<Button type="primary" onClick={() => setVisible(true)}>
Open Modal of 1000px width
</Button>
<Modal
title="Modal 1000px width"
centered
visible={visible}
onOk={() => setVisible(false)}
onCancel={() => setVisible(false)}
width={1000}
>
<p>some contents...</p>
<p>some contents...</p>
<p>some contents...</p>
</Modal>
</>
);
};
ReactDOM.render(<App />, mountNode);
import { Modal, Button } from 'antd';
const App = () => {
const [visible, setVisible] = React.useState(false);
const [confirmLoading, setConfirmLoading] = React.useState(false);
const [modalText, setModalText] = React.useState('Content of the modal');
const showModal = () => {
setVisible(true);
};
const handleOk = () => {
setModalText('The modal will be closed after two seconds');
setConfirmLoading(true);
setTimeout(() => {
setVisible(false);
setConfirmLoading(false);
}, 2000);
};
const handleCancel = () => {
console.log('Clicked cancel button');
setVisible(false);
};
return (
<>
<Button type="primary" onClick={showModal}>
Open Modal with async logic
</Button>
<Modal
title="Title"
visible={visible}
onOk={handleOk}
confirmLoading={confirmLoading}
onCancel={handleCancel}
>
<p>{modalText}</p>
</Modal>
</>
);
};
ReactDOM.render(<App />, mountNode);
import { Modal, Button, Space } from 'antd';
import { ExclamationCircleOutlined } from '@ant-design/icons';
const { confirm } = Modal;
function showConfirm() {
confirm({
title: 'Do you Want to delete these items?',
icon: <ExclamationCircleOutlined />,
content: 'Some descriptions',
onOk() {
console.log('OK');
},
onCancel() {
console.log('Cancel');
},
});
}
function showPromiseConfirm() {
confirm({
title: 'Do you want to delete these items?',
icon: <ExclamationCircleOutlined />,
content: 'When clicked the OK button, this dialog will be closed after 1 second',
onOk() {
return new Promise((resolve, reject) => {
setTimeout(Math.random() > 0.5 ? resolve : reject, 1000);
}).catch(() => console.log('Oops errors!'));
},
onCancel() {},
});
}
function showDeleteConfirm() {
confirm({
title: 'Are you sure delete this task?',
icon: <ExclamationCircleOutlined />,
content: 'Some descriptions',
okText: 'Yes',
okType: 'danger',
cancelText: 'No',
onOk() {
console.log('OK');
},
onCancel() {
console.log('Cancel');
},
});
}
function showPropsConfirm() {
confirm({
title: 'Are you sure delete this task?',
icon: <ExclamationCircleOutlined />,
content: 'Some descriptions',
okText: 'Yes',
okType: 'danger',
okButtonProps: {
disabled: true,
},
cancelText: 'No',
onOk() {
console.log('OK');
},
onCancel() {
console.log('Cancel');
},
});
}
ReactDOM.render(
<Space wrap>
<Button onClick={showConfirm}>Confirm</Button>
<Button onClick={showPromiseConfirm}>With promise</Button>
<Button onClick={showDeleteConfirm} type="dashed">
Delete
</Button>
<Button onClick={showPropsConfirm} type="dashed">
With extra props
</Button>
</Space>,
mountNode,
);
import { Modal, Button, Space } from 'antd';
import { ExclamationCircleOutlined } from '@ant-design/icons';
class LocalizedModal extends React.Component {
state = { visible: false };
showModal = () => {
this.setState({
visible: true,
});
};
hideModal = () => {
this.setState({
visible: false,
});
};
render() {
return (
<>
<Button type="primary" onClick={this.showModal}>
Modal
</Button>
<Modal
title="Modal"
visible={this.state.visible}
onOk={this.hideModal}
onCancel={this.hideModal}
okText="确认"
cancelText="取消"
>
<p>Bla bla ...</p>
<p>Bla bla ...</p>
<p>Bla bla ...</p>
</Modal>
</>
);
}
}
function confirm() {
Modal.confirm({
title: 'Confirm',
icon: <ExclamationCircleOutlined />,
content: 'Bla bla ...',
okText: '确认',
cancelText: '取消',
});
}
ReactDOM.render(
<Space>
<LocalizedModal />
<Button onClick={confirm}>Confirm</Button>
</Space>,
mountNode,
);
import { Modal, Button } from 'antd';
class App extends React.Component {
state = {
modal1Visible: false,
modal2Visible: false,
};
setModal1Visible(modal1Visible) {
this.setState({ modal1Visible });
}
setModal2Visible(modal2Visible) {
this.setState({ modal2Visible });
}
render() {
return (
<>
<Button type="primary" onClick={() => this.setModal1Visible(true)}>
Display a modal dialog at 20px to Top
</Button>
<Modal
title="20px to Top"
style={{ top: 20 }}
visible={this.state.modal1Visible}
onOk={() => this.setModal1Visible(false)}
onCancel={() => this.setModal1Visible(false)}
>
<p>some contents...</p>
<p>some contents...</p>
<p>some contents...</p>
</Modal>
<br />
<br />
<Button type="primary" onClick={() => this.setModal2Visible(true)}>
Vertically centered modal dialog
</Button>
<Modal
title="Vertically centered modal dialog"
centered
visible={this.state.modal2Visible}
onOk={() => this.setModal2Visible(false)}
onCancel={() => this.setModal2Visible(false)}
>
<p>some contents...</p>
<p>some contents...</p>
<p>some contents...</p>
</Modal>
</>
);
}
}
ReactDOM.render(<App />, mountNode);
import { Modal, Button } from 'antd';
class App extends React.Component {
state = { visible: false };
showModal = () => {
this.setState({
visible: true,
});
};
handleOk = e => {
console.log(e);
this.setState({
visible: false,
});
};
handleCancel = e => {
console.log(e);
this.setState({
visible: false,
});
};
render() {
return (
<>
<Button type="primary" onClick={this.showModal}>
Open Modal with customized button props
</Button>
<Modal
title="Basic Modal"
visible={this.state.visible}
onOk={this.handleOk}
onCancel={this.handleCancel}
okButtonProps={{ disabled: true }}
cancelButtonProps={{ disabled: true }}
>
<p>Some contents...</p>
<p>Some contents...</p>
<p>Some contents...</p>
</Modal>
</>
);
}
}
ReactDOM.render(<App />, mountNode);
import { Modal, Button } from 'antd';
import Draggable from 'react-draggable';
class App extends React.Component {
state = {
visible: false,
disabled: true,
bounds: { left: 0, top: 0, bottom: 0, right: 0 },
};
draggleRef = React.createRef();
showModal = () => {
this.setState({
visible: true,
});
};
handleOk = e => {
console.log(e);
this.setState({
visible: false,
});
};
handleCancel = e => {
console.log(e);
this.setState({
visible: false,
});
};
onStart = (event, uiData) => {
const { clientWidth, clientHeight } = window.document.documentElement;
const targetRect = this.draggleRef.current?.getBoundingClientRect();
if (!targetRect) {
return;
}
this.setState({
bounds: {
left: -targetRect.left + uiData.x,
right: clientWidth - (targetRect.right - uiData.x),
top: -targetRect.top + uiData.y,
bottom: clientHeight - (targetRect.bottom - uiData.y),
},
});
};
render() {
const { bounds, disabled, visible } = this.state;
return (
<>
<Button onClick={this.showModal}>Open Draggable Modal</Button>
<Modal
title={
<div
style={{
width: '100%',
cursor: 'move',
}}
onMouseOver={() => {
if (disabled) {
this.setState({
disabled: false,
});
}
}}
onMouseOut={() => {
this.setState({
disabled: true,
});
}}
// fix eslintjsx-a11y/mouse-events-have-key-events
// https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/master/docs/rules/mouse-events-have-key-events.md
onFocus={() => {}}
onBlur={() => {}}
// end
>
Draggable Modal
</div>
}
visible={visible}
onOk={this.handleOk}
onCancel={this.handleCancel}
modalRender={modal => (
<Draggable
disabled={disabled}
bounds={bounds}
onStart={(event, uiData) => this.onStart(event, uiData)}
>
<div ref={this.draggleRef}>{modal}</div>
</Draggable>
)}
>
<p>
Just don't learn physics at school and your life will be full of magic and
miracles.
</p>
<br />
<p>Day before yesterday I saw a rabbit, and yesterday a deer, and today, you.</p>
</Modal>
</>
);
}
}
ReactDOM.render(<App />, mountNode);
API#
Property | Description | Type | Default | Version |
---|---|---|---|---|
afterClose | Specify a function that will be called when modal is closed completely | function | - | |
bodyStyle | Body style for modal body element. Such as height, padding etc | CSSProperties | ||
cancelButtonProps | The cancel button props | ButtonProps | - | |
cancelText | Text of the Cancel button | ReactNode | Cancel | |
centered | Centered Modal | boolean | false | |
closable | Whether a close (x) button is visible on top right of the modal dialog or not | boolean | true | |
closeIcon | Custom close icon | ReactNode | <CloseOutlined /> | |
confirmLoading | Whether to apply loading visual effect for OK button or not | boolean | false | |
destroyOnClose | Whether to unmount child components on onClose | boolean | false | |
focusTriggerAfterClose | Whether need to focus trigger element after dialog is closed | boolean | true | 4.9.0 |
footer | Footer content, set as footer={null} when you don't need default buttons | ReactNode | (OK and Cancel buttons) | |
forceRender | Force render Modal | boolean | false | |
getContainer | Return the mount node for Modal | HTMLElement | () => HTMLElement | Selectors | false | document.body | |
keyboard | Whether support press esc to close | boolean | true | |
mask | Whether show mask or not | boolean | true | |
maskClosable | Whether to close the modal dialog when the mask (area outside the modal) is clicked | boolean | true | |
maskStyle | Style for modal's mask element | CSSProperties | ||
modalRender | Custom modal content render | (node: ReactNode) => ReactNode | - | 4.7.0 |
okButtonProps | The ok button props | ButtonProps | - | |
okText | Text of the OK button | ReactNode | OK | |
okType | Button type of the OK button | string | primary | |
style | Style of floating layer, typically used at least for adjusting the position | CSSProperties | - | |
title | The modal dialog's title | ReactNode | - | |
visible | Whether the modal dialog is visible or not | boolean | false | |
width | Width of the modal dialog | string | number | 520 | |
wrapClassName | The class name of the container of the modal dialog | string | - | |
zIndex | The z-index of the Modal | number | 1000 | |
onCancel | Specify a function that will be called when a user clicks mask, close button on top right or Cancel button | function(e) | - | |
onOk | Specify a function that will be called when a user clicks the OK button | function(e) | - |
Note#
The state of Modal will be preserved at it's component lifecycle by default, if you wish to open it with a brand new state everytime, set
destroyOnClose
on it.There is a situation that using
<Modal />
with Form, which won't clear fields value when closing Modal even you have setdestroyOnClose
. You need<Form preserve={false} />
in this case.Modal.method()
RTL mode only supports hooks.
Modal.method()#
There are five ways to display the information based on the content's nature:
Modal.info
Modal.success
Modal.error
Modal.warning
Modal.confirm
The items listed above are all functions, expecting a settings object as parameter. The properties of the object are follows:
Property | Description | Type | Default | Version |
---|---|---|---|---|
afterClose | Specify a function that will be called when modal is closed completely | function | - | 4.9.0 |
autoFocusButton | Specify which button to autofocus | null | ok | cancel | ok | |
bodyStyle | Body style for modal body element. Such as height, padding etc | CSSProperties | 4.8.0 | |
cancelButtonProps | The cancel button props | ButtonProps | - | |
cancelText | Text of the Cancel button with Modal.confirm | string | Cancel | |
centered | Centered Modal | boolean | false | |
className | The className of container | string | - | |
closable | Whether a close (x) button is visible on top right of the confirm dialog or not | boolean | false | 4.9.0 |
closeIcon | Custom close icon | ReactNode | undefined | 4.9.0 |
content | Content | ReactNode | - | |
getContainer | Return the mount node for Modal | HTMLElement | () => HTMLElement | Selectors | false | document.body | |
icon | Custom icon | ReactNode | <QuestionCircle /> | |
keyboard | Whether support press esc to close | boolean | true | |
mask | Whether show mask or not. | boolean | true | |
maskClosable | Whether to close the modal dialog when the mask (area outside the modal) is clicked | boolean | false | |
maskStyle | Style for modal's mask element | object | {} | |
okButtonProps | The ok button props | ButtonProps | - | |
okText | Text of the OK button | string | OK | |
okType | Button type of the OK button | string | primary | |
style | Style of floating layer, typically used at least for adjusting the position | CSSProperties | - | |
title | Title | ReactNode | - | |
width | Width of the modal dialog | string | number | 416 | |
wrapClassName | The class name of the container of the modal dialog | string | - | 4.18.0 |
zIndex | The z-index of the Modal | number | 1000 | |
onCancel | Specify a function that will be called when the user clicks the Cancel button. The parameter of this function is a function whose execution should include closing the dialog. If the function does not take any parameter (!onCancel.length ) then modal dialog will be closed unless returned value is true (!!onCancel() ). You can also just return a promise and when the promise is resolved, the modal dialog will also be closed | function(close) | - | |
onOk | Specify a function that will be called when the user clicks the OK button. The parameter of this function is a function whose execution should include closing the dialog. If the function does not take any parameter (!onOk.length ) then modal dialog will be closed unless returned value is true (!!onOk() ). You can also just return a promise and when the promise is resolved, the modal dialog will also be closed | function(close) | - |
All the Modal.method
s will return a reference, and then we can update and close the modal dialog by the reference.
const modal = Modal.info();
modal.update({
title: 'Updated title',
content: 'Updated content',
});
// on 4.8.0 or above, you can pass a function to update modal
modal.update(prevConfig => ({
...prevConfig,
title: `${prevConfig.title} (New)`,
}));
modal.destroy();
Modal.destroyAll
Modal.destroyAll()
could destroy all confirmation modal dialogs(Modal.confirm|success|info|error|warning
). Usually, you can use it in router change event to destroy confirm modal dialog automatically without use modal reference to close( it's too complex to use for all modal dialogs)
import { browserHistory } from 'react-router';
// router change
browserHistory.listen(() => {
Modal.destroyAll();
});
Modal.useModal()#
When you need using Context, you can use contextHolder
which created by Modal.useModal
to insert into children. Modal created by hooks will get all the context where contextHolder
are. Created modal
has the same creating function with Modal.method
.
const [modal, contextHolder] = Modal.useModal();
React.useEffect(() => {
modal.confirm({
// ...
});
}, []);
return <div>{contextHolder}</div>;
FAQ#
Why I can not access context, redux, ConfigProvider locale/prefixCls
in Modal.xxx?#
antd will dynamic create React instance by ReactDOM.render
when call Modal methods. Whose context is different with origin code located context.
When you need context info (like ConfigProvider context), you can use Modal.useModal
to get modal
instance and contextHolder
node. And put it in your children:
const [modal, contextHolder] = Modal.useModal();
// then call modal.confirm instead of Modal.confirm
return (
<Context1.Provider value="Ant">
{/* contextHolder is in Context1, which means modal will get context of Context1 */}
{contextHolder}
<Context2.Provider value="Design">
{/* contextHolder is out of Context2, which means modal will not get context of Context2 */}
</Context2.Provider>
</Context1.Provider>
);
Note: You must insert contextHolder
into your children with hooks. You can use origin method if you do not need context connection.
How to disable motion?#
You can config transitionName=""
and maskTransitionName=""
to remove motion class. But you should note that these prop is internal usage which we don't promise exist in next major version.
How to set static methods prefixCls ?#
You can config with ConfigProvider.config