Skip to content

Commit f4dd546

Browse files
committed
Create Readme file with logo and demo gifs and with links to docs
1 parent 1e63589 commit f4dd546

File tree

5 files changed

+65
-0
lines changed

5 files changed

+65
-0
lines changed

README.md

+65
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# TreeView
2+
3+
<p align="center">
4+
<img src="media/tv-logo.png" width="128px" height="128px"/>
5+
</p>
6+
7+
Multi Roots TreeView implementation for Android Platform with a lot of options and customization
8+
9+
## Demo
10+
<p align="center">
11+
<img src="media/treeview_files_demo.gif" alt="animated" width="23%"/>
12+
<img src="media/treeview_todo_demo.gif" alt="animated" width="23%"/>
13+
<img src="media/treeview_chat_demo.gif" alt="animated" width="23%"/>
14+
</p>
15+
16+
### Features:
17+
- No Custom Views.
18+
- Easy use, customize and extend.
19+
- Support any number of roots.
20+
- Can use a different design for each node.
21+
- Selection mode for nodes.
22+
- Dynamic adding and removing nodes.
23+
- Don't save a reference for the view holder in each node.
24+
- Can handle a large number of nodes without problems.
25+
- Providing on click and on long click listener nodes.
26+
- Easy to override any operations by override `TreeNodeManager`.
27+
- Collapse and Extend node and node branch.
28+
- Collapse and extend nodes by level.
29+
- Collapse and expand all nodes.
30+
- Can perform 2D scrolling without custom layout.
31+
32+
### Documentations:
33+
- [Full Documentation](https://amrdeveloper.github.io/treeview/)
34+
- [Install Documentation](docs/install.md)
35+
- [Add to XML Documentation](docs/add-to-xml.md)
36+
- [ViewHolders Documentation](docs/view-holders.md)
37+
- [Tree Node Documentation](docs/treenode.md)
38+
- [TreeView Adapter Documentation](docs/treeview-adapter.md)
39+
- [TreeNode Manager Documentation](docs/treenode-manager.md)
40+
- [Full Example Documentation](docs/full-example.md)
41+
42+
### License
43+
```
44+
MIT License
45+
46+
Copyright (c) 2022 Amr Hesham
47+
48+
Permission is hereby granted, free of charge, to any person obtaining a copy
49+
of this software and associated documentation files (the "Software"), to deal
50+
in the Software without restriction, including without limitation the rights
51+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
52+
copies of the Software, and to permit persons to whom the Software is
53+
furnished to do so, subject to the following conditions:
54+
55+
The above copyright notice and this permission notice shall be included in all
56+
copies or substantial portions of the Software.
57+
58+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
59+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
60+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
61+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
62+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
63+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
64+
SOFTWARE.
65+
```

media/treeview_chat_demo.gif

230 KB
Loading

media/treeview_files_demo.gif

772 KB
Loading

media/treeview_todo_demo.gif

628 KB
Loading

media/tv-logo.png

11.8 KB
Loading

0 commit comments

Comments
 (0)