More doc
This commit is contained in:
Emmanuel Lepage Vallee
parent
90154d83ab
commit
1985084227
95
README.md
95
README.md
|
|
@ -1,5 +1,5 @@
|
|||
# Radical - A menu system for Awesome WM
|
||||
========================================
|
||||
# Radical menu system for AwesomeWM
|
||||
=======================================
|
||||
|
||||
This is Radical, one of the largest Awesome extension module. It provide un
|
||||
unified interface to generate multiple types of menus.
|
||||
|
|
@ -61,6 +61,12 @@ be created by beautiful themes. The current ones are:
|
|||
* **Arrow:** Gnome3 and Mac OSX like menus with border radius and an arrow
|
||||
* **Classic:** Replicate awful.menu look
|
||||
|
||||
Arrow also have a few types:
|
||||
|
||||
* radical.base.NONE
|
||||
* radical.base.PRETTY
|
||||
* radical.base.CENTERED
|
||||
|
||||
### Item style
|
||||
|
||||
Like menus, items can have their own style. Valid values:
|
||||
|
|
@ -87,4 +93,87 @@ On top of each styles, menu can also have different layouts to display items:
|
|||
item_style = radical.item_style.classic ,
|
||||
layout = radical.layout.vertical })
|
||||
|
||||
```
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
Radical offer a (very, very) wide range of options to allow the creation of rich
|
||||
and novel menus. The options are available in 2 formats: menu wide and item
|
||||
specific. Menu wide options will take effect on all items and on the way the
|
||||
menu itself is being displayed while items ones apply only to a specific item.
|
||||
Multiple items can have multiple sets of options.
|
||||
|
||||
### Menu options
|
||||
|
||||
| Name | Description | Type |
|
||||
| --------------- | -------------------------------------------------- | ----------------------------- |
|
||||
| bg | Background color | String/gradient/pattern |
|
||||
| fg | Foreground (text) color | String/gradient/pattern |
|
||||
| bg_focus | Background of focussed items | String/gradient/pattern |
|
||||
| fg_forcus | Foreground of focussed items | String/gradient/pattern |
|
||||
| bg_alternate | Alternate background color | String/gradient/pattern |
|
||||
| bg_highlight | Highlight background color | String/gradient/pattern |
|
||||
| bg_header | Header (see widgets section) color | String/gradient/pattern |
|
||||
| border_color | Border color | String/gradient/pattern |
|
||||
| border_width | Border width | number |
|
||||
| item_height | Default height of items | number |
|
||||
| item_width | Default width of items | number |
|
||||
| width | Original width | number |
|
||||
| default_width | Default menu width | number |
|
||||
| icon_size | Icon size | number |
|
||||
| auto_resize | Resize menu if items are too large | boolean |
|
||||
| parent_geometry | Set the menu parent | geometry array |
|
||||
| arrow_type | Set the arrow type when use arrow style | see "arrow_type" |
|
||||
| visible | Show or hide the menu | boolean |
|
||||
| direction | The direction from which the arrow will point | "left","right","top","bottom" |
|
||||
| row | Number of row (in grid layout) | number |
|
||||
| column | Number of columns (in grid layout) | number |
|
||||
| layout | The menu layout (default:vertical) | see "Menu layouts" section |
|
||||
| style | The menu style (default:arrow) | see "Menu style" |
|
||||
| item_style | The item style (default:basic) | see "Item style" |
|
||||
| filter | Filter the menu when the user type | boolean |
|
||||
| show_filter | Show a filter widget at the bottom | boolean |
|
||||
| filter_string | Default filter string | string |
|
||||
| fkeys_prefix | Display F1-F12 indicators for easy navigation | boolean |
|
||||
| underlay_alpha | Underlay (see item options) opacity | 0-1 |
|
||||
| filter_prefix | Text to be shown at begenning of the filter string | string |
|
||||
| max_items | Maximum number of items before showing scrollbar | number |
|
||||
|
||||
###Item options
|
||||
|
||||
| Name | Description | Type |
|
||||
| -------------- | -------------------------------------------- | ----------------- |
|
||||
| text | The item text | string |
|
||||
| height | The item height | number |
|
||||
| icon | The item icon | string or pattern |
|
||||
| bg | See menu options | see menu options |
|
||||
| fg | See menu options | see menu options |
|
||||
| fg_focus | See menu options | see menu options |
|
||||
| bg_focus | See menu options | see menu options |
|
||||
| sub_menu | Add a submenu to this item | menu or function |
|
||||
| selected | Select this item | boolean |
|
||||
| checkable | Is the item dual state (a checkbox) | boolean |
|
||||
| checked | Is the item checked or not | boolean |
|
||||
| underlay | Text to render at the far-right of the item | string |
|
||||
| prefix_widget | Widget to append at the begenning of the item| widget |
|
||||
| suffix_widget | Widget to append at the end of the item | widget |
|
||||
| button1 | Left mouse button action | function |
|
||||
| button2 | Mid mouse button action | function |
|
||||
| button3 | Right mouse button action | function |
|
||||
| button4 | Scroll up action | function |
|
||||
| button5 | Scroll down action | function |
|
||||
|
||||
###Beautiful options
|
||||
|
||||
Radical also use the some of the same theme options as awful.menu, plus some:
|
||||
|
||||
* menu_height
|
||||
* menu_width
|
||||
* menu_border_width
|
||||
* border_width
|
||||
* border_color
|
||||
* menu_fg_normal
|
||||
* menu_bg_focus
|
||||
* menu_bg_header
|
||||
* menu_bg_normal
|
||||
* menu_bg_highlight
|
||||
|
|
|
|||
Loading…
Reference in New Issue