JSPM

  • Created
  • Published
  • Downloads 1398
  • Score
    100M100P100Q108241F
  • License MIT

Package Exports

  • @linzjs/windows
  • @linzjs/windows/dist/index.ts

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@linzjs/windows) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@linzjs/windows

semantic-release: react

Reusable promise based windowing component for LINZ / Toitū te whenua.

React state based modals/windows are painful because they require:

  • shared states for open/closed.
  • callbacks/states for return values.
  • inline modal/window includes, which prevent you from closing the invoking component before the modal/window has completed.

This module gives you promise based modals/windows which don't require all the state based boilerplate / inline-components.

So you can simply do this in your react-app:

const result = await showModal(TestModal)

Features

  • Async HTML dialog based Modals.
  • Draggable and resizeable, pop-in/out Panels/Windows.

Install

npm install @linzjs/windows

or with Yarn

yarn add @linzjs/windows

Debug log

To enable debug logs set:

localStorage.setItem("@linzjs/windows.debugEnabled", "true");

Demo

npm run storybook

See Chromatic storybook for documentation.