https://github.com/rickonono3/react-winbox
The newest React component for WinBox.js. A window manager for React.
https://github.com/rickonono3/react-winbox
react react-component winbox winbox-js
Last synced: about 1 year ago
JSON representation
The newest React component for WinBox.js. A window manager for React.
- Host: GitHub
- URL: https://github.com/rickonono3/react-winbox
- Owner: RickoNoNo3
- License: mit
- Created: 2022-04-17T19:26:21.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-06-18T13:47:47.000Z (about 3 years ago)
- Last Synced: 2025-03-30T22:09:57.094Z (about 1 year ago)
- Topics: react, react-component, winbox, winbox-js
- Language: TypeScript
- Homepage: https://react-winbox.vercel.app/
- Size: 500 KB
- Stars: 148
- Watchers: 4
- Forks: 21
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# React-WinBox
A React controlled component for [WinBox.js](https://github.com/nextapps-de/winbox), with full Reactful props and state. Includes all configurations of WinBox.js by using React component props.
**Full type declaration for both JavaScript and TypeScript.**
## Play the [Demo](https://react-winbox.vercel.app)
demo:
-----
## Install
```bash
npm install --save react-winbox
# OR
yarn add react-winbox
```
## Usage
### Help for different situations
- [Use in Next.js](#use-in-next)
- [Upgrade from versions <=1.4](#upgrade)
### Examples
> Ensure the document body has an initial non-zero height, e.g. `100vh`.
```jsx
import 'winbox/dist/css/winbox.min.css'; // required
import 'winbox/dist/css/themes/modern.min.css'; // optional
import 'winbox/dist/css/themes/white.min.css'; // optional
import WinBox from 'react-winbox';
Hello, WinBox!
```
Or you can do more one step, to make a genuine 'windows manager', just like:
```tsx
// ...
// some code to maintain a list of necessary windows info...
// ...
const [windows, setWindows] = useState([]);
const handleClose = (force, id) => {
let state = [...windows];
const index = state.findIndex(info => info.id === id);
if (index === -1) return
if (state[index].onclose && state[index].onclose(force)) return true;
// window-specific onclose, returns true if it does not need the default close process.
state.splice(index, 1);
setTimeout(() => setWindows(state)); // to change winbox showing state while `onclose`, MUST wrap it within `setTimeout`
};
return (
<>
{windows.map(info => (
handleClose(force, info.id)}
{...info.neededProps} // assign any props you want to WinBox
>
Some children
))}
>
);
```
## Notice
- To use WinBox, ensure the document body has an initial non-zero height, e.g. 100vh.
- To open a winbox, just create it in your virtual DOM, that's enough.
- To close a winbox, just do not render it. It's safe.
- `onclose` is called BEFORE the winbox goes to close process. It is easy to block a closing for some unsaved data or giving a confirmation to user to close (see the doc to get more info). However, if you do not want to block the closing, but want to destroy the React WinBox component, be sure to wrap destroying actions within `setTimeout` so that they occur after the winbox.js DOM is truly closed, e.g. `setTimeout(() => setShowWindow(false))`.
- To change some properties of the winbox DOM, just change the component's properties. The properties need [official methods](https://github.com/nextapps-de/winbox#overview) support. We suggest that all states you want to control of the winbox should be listened for changes and keep controlled, such as `width` state with `onResize` callback. But if you do not have such listeners, you can call the `forceUpdate` method from refs to keep the winbox status in control as well.
- If you have to operate the pure WinBox.js object manually, you can find a `winBoxObj` in the component ref. It's needed only when you want to call `mount()` method.
## Props and Methods
### See the official document for [WinBox.js](https://github.com/nextapps-de/winbox)
### Props
> most props are one-to-one corresponding to the params of WinBox.js.
```ts
type WinBoxPropType = {
title?: string
/**
* Icon supports both native image urls and React package resources:
*
* Example:
* ```
* import icon from './icon.jpg';
*
*
* ```
*/
icon?: string
id?: string
children?: ReactElement | ReactElement[] | null
url?: string // When you use this, the children elements will be ignored.
noAnimation?: boolean,
noShadow?: boolean,
noHeader?: boolean,
noMin?: boolean,
noMax?: boolean,
noFull?: boolean,
noClose?: boolean,
noResize?: boolean,
noMove?: boolean,
modal?: boolean,
hide?: boolean,
index?: number,
border?: number,
background?: string,
max?: boolean,
min?: boolean,
fullscreen?: boolean,
x?: string | number | 'center' | 'right',
y?: string | number | 'center' | 'bottom',
top?: string | number,
bottom?: string | number,
left?: string | number,
right?: string | number,
height?: string | number,
width?: string | number,
/**
* This callback is called BEFORE the winbox goes to close process. So if you want to destroy the React WinBox component while it is triggered, be sure to wrap destroying actions within `setTimeout` so that they occur after the winbox.js DOM is truly closed，e.g. `setTimeout(() => setState({showWindow: false}))`
*
* see the following document for more detail about the argument and the return value.
* @see https://github.com/nextapps-de/winbox
* @param force Whether you should not abort the winbox to close. If this is true, you MUST return false, or some problems will happen.
* @return noDefaultClose - true if the winbox does not need the default close process, for example, when it needs a confirmation to close instead of being closed suddenly.
*/
onClose?: (force: boolean) => boolean | undefined | void,
onMove?: (x: number, y: number) => any,
onResize?: (width: number, height: number) => any,
onBlur?: () => any,
onFocus?: () => any,
/** Used for themeing. The `no-xxx` classes that winbox.js already appointed can not assign here, use special props instead, e.g. class `no-resize` to prop `noResize={true}` */
className?: string | number,
minWidth?: number | string,
minHeight?: number | string,
maxWidth?: number | string,
maxHeight?: number | string,
onCreate?: (options: any) => any,
onFullscreen?: () => any,
onMinimize?: () => any,
onMaximize?: () => any,
onRestore?: () => any,
onHide?: () => any,
onShow?: () => any,
/**
* an array of WinBoxControlInfo
* @see https://github.com/nextapps-de/winbox#custom-controls
*/
customControls?: WinBoxControlInfo[],
}
type WinBoxControlInfo = {
/** Index to jump into native controls. If no index assigned, custum controls will be arranged side-by-side automatically on the left of native controls*/
index?: number
/** a name to identify the button, can also style it by using css, may starts with `wb-` */
class: string
/** an image resource same like icon prop */
image: string
click?: () => void,
}
```
### Methods
> use React Ref to call these methods
```ts
forceUpdate (callback?: () => void) => void
focus () => void
blur () => void
getId () => string | undefined
getIndex () => number | undefined
getPosition () => { x: number, y: number } | undefined
getSize () => { width: number, height: number } | undefined
getSizeLimit () => { minWidth: number, minHeight: number, maxWidth: number, maxHeight: number } | undefined
getViewportBoundary () => { top: number, right: number, bottom: number, left: number} | undefined
isFocused () => boolean
isHidden () => boolean
isMax () => boolean
isMin () => boolean
isFullscreen () => boolean
isClosed () => boolean // REACT ONLY. Returns true if the winbox DOM element has been removed but the React component not yet.
// below methods are not suggested, as they are not state-controlled and have alternative props.
minimize () => void // prop `min`
maximize () => void // prop `max`
fullscreen () => void // prop `fullscreen`
restore () => void // prop `min`/`max`/`fullscreen`
hide () => void // prop `hide`
show () => void // prop `hide`
```
> Thanks for your reading. If any questions or problems, feel free to issue them.
-----
# Extra Helps
## Use in Next
To use `react-winbox` in Next.js, there are some special steps:
1. install `react-winbox` (must >= v1.5.0) into your project.
2. ([Source](https://github.com/RickoNoNo3/react-winbox/issues/10#issuecomment-1348653226)) install `next-transpile-modules`, and change the `next.config.js` to:
```js
const withTM = require('next-transpile-modules')([
'react-winbox',
]);
module.exports = withTM({
// additional webpack configurations
});
```
3. in `_app.js`:
```js
import 'winbox/dist/css/winbox.min.css';
import 'winbox/dist/css/themes/modern.min.css'; // optional
import 'winbox/dist/css/themes/white.min.css'; // optional
```
4. in files you want to use `react-winbox`:
```jsx
//import WinBox from 'react-winbox'; // do not use this, use below:
import dynamic from 'next/dynamic';
const WinBox = dynamic(() => import('react-winbox'), {ssr: false});
```
All is OK, start coding now!
## Upgrade
For old versions upgrading to v1.5.x, these things deserve attention:
- **All old versions have bugs in React 18+, but v1.5+ do not.**
- CSS files need to be imported manually. See [example 1](#examples).
- All props are camel-cased, use `onClose` instead of `onclose`.
- `splitscreen` has been removed, some props and methods were added.