1.0.1 • Published 4 years ago

dockmodal v1.0.1

Weekly downloads
4
License
MIT
Repository
github
Last release
4 years ago

dockmodal

A Dockable Modal in React

NPM JavaScript Style Guide

Important

This Project is moved to https://www.npmjs.com/package/react-dock-modal

Install

npm install --save dockmodal

Usage

import React, { Component } from 'react'

import DockModal from 'dockmodal'
import 'dockmodal/dist/index.css'

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

Properties

Prop NameDescription
initalTypeInitial Type (dock, minim or modal). Default is dock.
headerNameHeader Name. Default is New DockModal.
bgcolorHeader Background Colour. Default is black.
fgcolorHeader Font Colour. Default is white.
fweightHeader Font Weight. Default is bold.
paramsJavascript 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