0.0.2 • Published 10 months ago

@congritta-ui/modal-window v0.0.2

Weekly downloads
-
License
-
Repository
github
Last release
10 months ago

@congritta-ui/modal-window

This is modal window React component and part of Congritta UI

How to install

  1. Install @congritta-ui/base if you didn't it yet. (More info at: http://ui.congritta.com/docs/base);
  2. Install @congritta-ui/loading-wheel;

Add

import ModalWindow from '@congritta-ui/modal-window';

into your code

How to use

Example:

export default function MyComponentWithModalWindow() {
  const [isModalWindow, setIsModalWindow] = useState(false);

  return (
    <ModalWindow
      isActive={isModalWindow}
      onClose={() => setIsModalWindow(false)}
      title="My modal window title"
    >
      Hello World
    </ModalWindow>
  )
}

Props

Prop nameDescriptionIs RequiredDefault value
isActiveShould modal window be showntrue
titleModal window title. May be string or JSXtrue
onCloseFunction that executes when user wants to close modal windowfalse
animationDurationHow many milliseconds is modal window revealing or hidingfalse210
closeButtonContentsJSX contents in close button. Recommended to be an svg elementfalse<inserted svg icon>
containerClassNameClassname for providing your styles to window containerfalse
backgroundClassNameWindow background classNamefalse
headerClassNameClassname for providing your styles to window headerfalse
headerTitleClassNameClassname for providing your styles to window titlefalse
closeButtonClassNameClassname for providing your styles to close buttonfalse
contentsClassNameClassname for providing your styles to window contents wrapperfalse