Metadata-Version: 2.1
Name: kivy-garden.modernmenu
Version: 0.1.0.dev0
Summary: A modern contextmenu for Kivy
Home-page: https://github.com/kivy-garden/modernmenu
Author: Kivy
Author-email: kivy@kivy.org
License: UNKNOWN
Project-URL: Bug Reports, https://github.com/kivy-garden/modernmenu/issues
Project-URL: Source, https://github.com/kivy-garden/modernmenu
Keywords: Kivy kivy-garden
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Description-Content-Type: text/markdown
Provides-Extra: dev
Requires-Dist: pytest (>=3.6) ; extra == 'dev'
Requires-Dist: wheel ; extra == 'dev'
Requires-Dist: pytest-cov ; extra == 'dev'
Requires-Dist: pycodestyle ; extra == 'dev'
Provides-Extra: travis
Requires-Dist: coveralls ; extra == 'travis'

Kivy ModernMenu
===============

A context menu for Kivy with modern look and feel.

Please see the garden [instructions](https://kivy-garden.github.io) for how to use kivy garden flowers.

Flower information
-------------------

<img src="https://github.com/kivy-garden/garden.modernmenu/blob/master/screenshot.png" align="right" width="256" />

This set of widgets allows you to build a flexible set of modern looking
menus. 3 widgets are provided, conceived in a way to allow both tweaking
and subclassing for maximum flexibility in representation.

The MenuSpawner is a very simple widget allowing you to create a widget
for a long touch (arbitrary time) staying in a short distance of its
origin point, i.e: "long press" actions.

The ModernMenu widget is a configurable menu based on a circle with the
arious options appearing around. It animates the transitions to
submenus and provides a nice "back/close" button in the center.

The ModernMenuLabel is the default class used to display the elements of
the menu.

A simple mecanism allow passing options from each widget to the one it
builds, making customization for each instance of the menu easy if
needed.

An example of usage is provided in the module (run the module as a
python program), you can see a result of this example
[here](http://youtu.be/zzMTpcUGG0Q).

Install
---------

```sh
pip install kivy_garden.modernmenu
```

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.


