dockmodal
v1.0.1
Published
A Dockable Modal in React
Downloads
2
Readme
dockmodal
A Dockable Modal in React
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 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