terra-abstract-modal
v3.52.1
Published
The abstract modal is a structural component that provides the ability to display portal'd content in a layer above the app.
Downloads
438
Readme
Terra Abstract Modal
The abstract modal is a structural component that provides the ability to display portal'd content in a layer above the app. It consists of an overlay and an unstyled fixed position div in which content can be placed. The abstract modal is not intended to be consumed directly, but rather wrapped in a higher order component. Higher order components can provide the abstract modal with sizing, visual styles, and content (e.g; header, body, and actionable buttons). The abstract modals maximum size is constrained by the viewport size, so the content placed inside the modal needs to be responsive.
Getting Started
- Install from npmjs:
npm install terra-abstract-modal
Peer Dependencies
This component requires the following peer dependencies be installed in your app for the component to properly function.
| Peer Dependency | Version | |-|-| | react | ^16.8.5 | | react-dom | ^16.8.5 | | react-intl | ^2.9.0 |
Documentation
Documentation for this component is spilt into individual files. One file for the main component and one file for each component modifier.
See the documentation.
LICENSE
Copyright 2017 - 2020 Cerner Innovation, Inc.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.