Socket
Socket
Sign inDemoInstall

react-window-modal

Package Overview
Dependencies
8
Maintainers
1
Versions
3
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    react-window-modal

A React wrapper for the window-modal package


Version published
Maintainers
1
Install size
33.8 kB
Created

Readme

Source

react-window-modal Build Status npm version

A React wrapper for the window-modal package;
A modal window element designed to be smooth, clean and user friendly.
Includes many features and options!
Demo

Feature and improvement suggestions welcome!

Features

  • Supports TypeScript
  • Highly tested
  • Movable
  • Resizable
  • Titles (with icons)
  • Minimize
  • Close
  • Scrollable
  • Customizable style (override styles with classnames, may have to use !important)
  • Many options!

Setup

npm install react-window-modal

then

const WindowModal = require("react-window-modal");

or

import WindowModal from "react-window-modal";

Usage

render() {
    return <WindowModal>contents</WindowModal>
}

Props

* All props are optional

NameTypeDescription
titlestringThe title for the window
iconIWindowIconAn icon to use for the window
posIPointThe starting position for the window
sizeIPointThe starting size for the (must be greater than 200!)
resizablebooleanIf false, the window cannot be resized by the user
movablebooleanIf false, the window cannot be moved by the user
compactbooleanIf true, the style for the window's title bar will have less spacing
hideClosebooleanIf true, no close button will be added to the window
hideMinimizebooleanIf true, no minimize button will be added to the window

Events

NameTypeDescription
onCloseFunctionCalled when the window is closed
onMinimizeFunctionCalled when the window is minimized
onUnminimizeFunctionCalled when the window is unminimized
onResizeFunctionCalled when the window is resized
onMoveFunctionCalled when the window is moved
onFocusFunctionCalled when the window is focused
onBlurFunctionCalled when the window is blurred

Keywords

FAQs

Last updated on 24 May 2019

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc