Skip to content

Commit b360482

Browse files
committed
Update readme and bump version.
1 parent 4d3867f commit b360482

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,13 +58,15 @@ dock.addWidget(area);
5858
dock.addWidget(new Widget(), { mode: 'split-left', ref: area });
5959
dock.addWidget(new Widget(), { mode: 'split-right', ref: area });
6060

61+
area.addWidget(new Widget(), { placement: 'backdrop' });
62+
6163
Widget.attach(dock, document.body);
6264
```
6365

6466
The `addWidget` method of `FloatArea` accepts an options object as the second argument,
6567
with the following optional members:
6668

67-
- `placement`: string, `"float"` by default. Passing `"main"` adds the widget as a non-floating backdrop,
69+
- `placement`: string, `float` by default. Passing `backdrop` adds the widget as a non-floating backdrop,
6870
behind any floating dialogs.
6971
- `left`, `top`, `width`, `height`: number. Initial pixel size and placement of the floating dialog to add.
7072

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "phosphor-float-area",
3-
"version": "0.1.0",
3+
"version": "0.1.1",
44
"description": "Floating dialog container with DockPanel drag support for PhosphorJS",
55
"main": "dist/index.js",
66
"typings": "dist/index.d.ts",

0 commit comments

Comments
 (0)