Skip to content

crackayus09/react-dock-modal

Repository files navigation

react-dock-modal

A Dockable React Modal Like GMail Compose Window

NPM JavaScript Style Guide Known Vulnerabilities

Demo

https://crackayus09.github.io/react-dock-modal/

Install

npm install --save react-dock-modal

OR

yarn add react-dock-modal

Usage

import React, { Component } from 'react'

import DockModal from 'react-dock-modal'
import 'react-dock-modal/dist/index.css'

class Example extends Component {
  render() {
    if (children) {
      //With Children
      return (
        <DockModal>
          <Children />
        </DockModal>
      )
    } else {
      //Without Children
      return <DockModal />
    }
  }
}

Properties

Prop Name Description
initalType Initial Type (dock, minim or modal). Default is dock.
headerName Header Name. Default is New DockModal.
bgcolor Header Background Colour. Default is black.
fgcolor Header Font Colour. Default is white.
fweight Header Font Weight. Default is bold.
params Javascript Object containing following properties. dockWidth (Default 40%), dockHeight (Default 70%), minimWidth (Default 25%), minimHeight (Default 10%), modalWidth (Default 70%) and modalHeight (Default 650px). The values can be in CSS width height formats.

License

MIT © crackayus09