1.2.1 • Published 5 years ago

@fenderdigital/react-modal v1.2.1

Weekly downloads
1
License
UNLICENSED
Repository
-
Last release
5 years ago

Modal for Fender React UI Kit

Description

Modal functionality for showing and hiding content.

Installation and Usage

yarn add @fenderdigital/react-modal --save
import Modal from '@fenderdigital/react-modal';

Props

  • children - renders any child elements.
  • contentStyles - configurable tachyon classes for the modal content.
  • isVisible - controls thie expanded and collapsed state.
  • onClose - close callback.
  • styles - configurable tachyon classes for the modal.
  • theme - dark / light theme.
  • zIndex - option to specify a z-index value.
  • backgroundClickable - adds a close click event listener to the background.
propNamepropTypedefaultValueisRequired
childrennodenull-
contentStylesstringmw6-
isVisiblebooleanfalse-
onClosefunc() => {}-
stylesstringpt6-ns ph0 ph3-ns-
themestringwhite-
zIndexstring9999-
backgroundClickablebooleantrue-

Development

Check the Monorepo README for development documentation.