Skip to content

Commit 9cd4e9a

Browse files
authored
Update README.md
1 parent 08ed197 commit 9cd4e9a

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,34 @@
11
# pyqt-foldable-window
22
PyQt foldable window
3+
4+
## Requirements
5+
PyQt5 >= 5.8
6+
7+
## Setup
8+
```pip3 install git+https://github.com/yjg30737/pyqt-foldable-window.git --upgrade```
9+
10+
## Example
11+
```python
12+
from PyQt5.QtWidgets import QApplication, QTextEdit
13+
from pyqt_foldable_window import FoldableWindow
14+
15+
16+
if __name__ == "__main__":
17+
import sys
18+
19+
app = QApplication(sys.argv)
20+
window = FoldableWindow()
21+
window.layout().addWidget(QTextEdit()) # QTextEdit is center widget in this example.
22+
window.show()
23+
app.exec_()
24+
```
25+
26+
Result
27+
28+
Unfolded state
29+
30+
![image](https://user-images.githubusercontent.com/55078043/148364015-c8b7ae03-4004-4940-a8d3-655e32e0bbd5.png)
31+
32+
Folded state
33+
34+
![image](https://user-images.githubusercontent.com/55078043/148364439-3ffeaad8-5a6f-4e80-bd03-8bd498255b03.png)

0 commit comments

Comments
 (0)