ro_oc_14_plugin_modal v1.0.2

ro_oc_14_plugin_modal

A library to create modal with react.

See on GitHub

Instalation

npm install ro_oc_14_plugin_modal

yarn add ro_oc_14_plugin_modal

Usage

import { Modal } from 'ro_oc_14_plugin_modal';

...

const modalClassNames = {
    container: "example-modal-container",
    content: "example-modal-content",
    header: "example-modal-header",
    title: "example-modal-title",
    close: "example-modal-close",
    body: "example-modal-body",
};

<Modal title="Modal's title example" isModalOpen={showModal} onClickClose={closeModal} classNames={modalClassNames}>
    <p>A child component</p>
    <span>A span</span>
</Modal>

This is how modal's props works :

• title : a string representing the title of the modal (required)
• isModalOpen : a boolean to open or close the modal (required)
• onClickClose : a function to call when the close button of the modal is clicked (required)
• classNames : a js object to add class to nodes of modal (not required)
  • container : class for the container of the modal (not required)
  • content : class for the content of the modal (not required)
  • header : class for the header of the modal (not required)
  • title : class for the title of the modal (not required)
  • close : class for the close of the modal (not required)
  • body : class for the body of the modal (not required)
• children : not added in props but directly under modal's node, represant nodes to show in modal's body (not required)

"classNames" is only used to add style to the modal and is not mandatory. Adding children to the modal is also mandatory.

See Example on GitHub