Skip to content
This repository has been archived by the owner on Jan 3, 2023. It is now read-only.

Commit

Permalink
docs: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sentialx committed Aug 9, 2019
1 parent 3cfc064 commit 33518fc
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,12 @@ $ npm install react-windows-controls

# Quick example

```typescript
```tsx
import { remote } from 'electron';
import { WindowsControls } from 'react-windows-controls';

export default () => (
<WindowsControls />
<WindowsControls isMaximized={remote.getCurrentWindow().isMaximized()} />
);
```

Expand All @@ -25,17 +26,20 @@ export default () => (

- `dark` boolean - whether to invert icons colors
- `onClose` Function - on close button click event
- `isMaximized` boolean - whether to show the restore button
- `onMaximize` Function - on maximize button click event
- `onMinimize` Function - on minimize button click event
- `onMouseUp` Function
- `onMouseDown` Function
- `style` any


## `<WindowsControl />`

- `maximize` boolean - whether the button is a maximize button
- `close` boolean - whether the button is a close button
- `minimize` boolean - whether the button is a minimize button
- `restore` boolean - whether the button is a restore button
- `whiteIcon` boolean - whether to invert icon color
- `onClick` Function
- `onMouseUp` Function
Expand Down

0 comments on commit 33518fc

Please sign in to comment.