Modal
A modal overlay component for displaying content above the main interface.
Installation
npm install @cleartrip/ct-design-modal
# or
pnpm add @cleartrip/ct-design-modal
Peer dependencies
# Required for all targets
npm install react
# Web only
npm install react-dom
# React Native only
npm install react-native
Usage
Basic
import { Modal } from '@cleartrip/ct-design-modal';
function Example() {
return (
<Modal>
{/* Basic usage */}
</Modal>
);
}
ModalSize
SMALL— SMALLMEDIUM— MEDIUMLARGE— LARGEFULL_SCREEN— FULL_SCREENNONE— NONEREGULAR— REGULARBIG— BIG
ModalVariant
DARK— darkNEUTRAL— neutral
ModalPlacement
CENTER— centerBOTTOM— bottom
ActionButtonVariant
BACK— backCLOSE— closeNONE— none
ActionButtonAlignment
CENTER— centerLEFT— leftRIGHT— right
Accessibility
- The component follows accessibility best practices
- Ensure proper ARIA attributes are provided where needed
- Test with screen readers to ensure usability
Migration
If migrating from a previous version:
- import { Modal } from 'yagami/core/components';
+ import { Modal } from '@cleartrip/ct-design-modal';