@fenderdigital/react-modal

1.2.1 • Public • Published

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.
propName propType defaultValue isRequired
children node null -
contentStyles string mw6 -
isVisible boolean false -
onClose func () => {} -
styles string pt6-ns ph0 ph3-ns -
theme string white -
zIndex string 9999 -
backgroundClickable boolean true -

Development

Check the Monorepo README for development documentation.

Package Sidebar

Install

npm i @fenderdigital/react-modal

Weekly Downloads

1

Version

1.2.1

License

UNLICENSED

Unpacked Size

34.2 kB

Total Files

19

Last publish

Collaborators

  • stevenhuynh
  • markv242
  • coopercodecomposer
  • sherbert
  • jcuanan
  • derduher
  • philipyun
  • theloopla
  • jemnon