import splittergrid as a flower

kivy-garden · Feb 17, 2020 · 35468e5 · 35468e5
1 parent 2f59f94
commit 35468e5
Show file tree

Hide file tree

Showing 17 changed files with 435 additions and 49 deletions.
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,4 +1,4 @@
-v0.1.0 Initial release
+v1.0.0 Initial release
 ======================
 
-Added the demo flower project.
+Extracted the widget from ncis, and fixed some orientation values.
diff --git a/README.md b/README.md
@@ -1,39 +1,69 @@
-kivy-garden demo flower
-========================
+SplitterGrid
+============
 
-[![Github Build Status](https://github.com/kivy-garden/flower/workflows/Garden%20flower/badge.svg)](https://github.com/kivy-garden/flower/actions)
+[![Github Build Status](https://github.com/kivy-garden/splittergrid/workflows/Garden%20flower/badge.svg)](https://github.com/kivy-garden/flower/actions)
 
-A kivy garden flower that shows how to add flowers.
+A GridLayout-like widget, that allows the user to manually change the relative
+sizes of each collumn and row. If the widget is resized, the preferences will
+be conserved relalively (a column resized to 10% of the total width will stay
+10% of the total width). As with GridLayout, either a number column or a number
+of rows must be set, if both are set, then `cols` is used.
 
-See https://kivy-garden.github.io/flower/ for the rendered flower docs.
+It also allows setting the order of filling through the `orientation` property,
+all the modes you could hope for are implemented:
 
-Please see the garden [instructions](https://kivy-garden.github.io) for how to use kivy garden flowers.
+tb-lr, top to bottom, left to right, which means the first column 
+will be filled from top to bottom, then the second column, etc.
+![tb-lr](captures/tb-lr.png)
 
-CI
---
+bt-lr: bottom to top, left to right
+![bt-lr](captures/bt-lr.png)
 
-Every push or pull request run the [GitHub Action](https://github.com/kivy-garden/flower/actions) CI.
-It tests the code on various OS and also generates wheels that can be released on PyPI upon a
-tag. Docs are also generated and uploaded to the repo as well as artifacts of the CI.
+tb-rl: top to bottom, right to left
+![tb-rl](captures/tb-rl.png)
 
+bt-rl, bottom to top, right to left
+![bt-rl](captures/bt-rl.png)
 
-TODO
--------
+lr-tb: left to right, top to bottom
+![lr-tb](captures/lr-tb.png)
+
+lr-bt: left to right, top to bottom
+![lr-bt](captures/lr-bt.png)
+
+rl-tb: right to left, top to bottom
+![rl-tb](captures/rl-tb.png)
+
+rl-bt: rigth to left, bottom to top
+![rl-bt](captures/rl-bt.png)
+
+The margin between each cell can be dragged by the user, resizing the
+corresponding row or column (or both, if you drag from an intersection).
+`min_col_width` and `min_row_height` allowing to set constraints on user
+interaction. On desktop, the mouse cursor is set to arrows indicating the
+possibility of resizing when hovering a margin.
+
+![resizing](captures/resize.png)
+
+This layout doesn't use `size_hint` or `size_hint_min` and `size_hint_max`
+properties of its children.
+
+The module can be ran standalone and will display a basic demonstration of the
+layout.
 
-* add your code
 
 Contributing
---------------
+------------
 
 Check out our [contribution guide](CONTRIBUTING.md) and feel free to improve the flower.
 
 License
----------
+-------
 
 This software is released under the terms of the MIT License.
 Please see the [LICENSE.txt](LICENSE.txt) file.
 
 How to release
-===============
+==============
 
 See the garden [instructions](https://kivy-garden.github.io/#makingareleaseforyourflower) for how to make a new release.
diff --git a/captures/bt-lr.png b/captures/bt-lr.png
diff --git a/captures/bt-rl.png b/captures/bt-rl.png
diff --git a/captures/lr-bt.png b/captures/lr-bt.png
diff --git a/captures/lr-tb.png b/captures/lr-tb.png
diff --git a/captures/resize.png b/captures/resize.png
diff --git a/captures/rl-bt.png b/captures/rl-bt.png
diff --git a/captures/rl-tb.png b/captures/rl-tb.png
diff --git a/captures/tb-lr.png b/captures/tb-lr.png
diff --git a/captures/tb-rl.png b/captures/tb-rl.png
diff --git a/kivy_garden/flower/__init__.py b/kivy_garden/flower/__init__.py
diff --git a/kivy_garden/flower/_version.py b/kivy_garden/flower/_version.py
diff --git a/kivy_garden/flower/tests/test_import.py b/kivy_garden/flower/tests/test_import.py