awesomewm-mirrors
/
radical
mirror of https://github.com/Elv13/radical.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
radical/README.md

188 lines
9.3 KiB
Markdown
Raw Normal View History

More doc
2013-08-04 04:36:13 +02:00
# Radical menu system for AwesomeWM
=======================================
Add README
2013-08-03 07:03:43 +02:00
This is Radical, one of the largest Awesome extension module. It provide un
unified interface to generate multiple types of menus.
Add new screenshot
2014-01-03 07:47:28 +01:00
[![Too many menus](https://raw.github.com/Elv13/radical/master/screenshot/all.png)](https://raw.github.com/Elv13/radical/master/screenshot/all.png)
Add README
2013-08-03 07:03:43 +02:00
## Installation
Installing Radical is simple, just move to ~/.config/awesome and clone the
repository
```sh
cd ~/.config/awesome
git clone https://github.com/Elv13/radical.git
```
The require it at the top of your rc.lua:
```lua
local radical = require("radical")
```
## Usage
Unlike awful.menu, radical act like other Awesome 3.5 layouts. You need to add
items one by one. This have the benefit of letting you interact with the items
themselves programatically.
The most simple kind of menus, contexts one, can be created like this:
```lua
local menu = radical.context({})
menu:add_item({text="Screen 1",button1=function() print("Hello World! ") end})
menu:add_item({text="Screen 9",icon=beautiful.path.."Icon/layouts/tileleft.png"})
menu:add_item({text="Sub Menu",sub_menu = function()
local smenu = radical.context({})
smenu:add_item({text="item 1"})
smenu:add_item({text="item 2"})
return smenu
end})
```
In this example, a simple 3 item menu is created with a dynamically generated
submenu. Please note that generating submenus using function will generate it
every time it is being shown. For static menus, it is faster to simply create
them once and passing the submenu object to the "sub_menu" item property.
### Menu types
The current valid types are:
* **Context:** Regular context menu
* **Box:** Centered menus (think Windows alt-tab menu)
* **Embed:** Menus in menus. This can be used as subsections in large menus
### Menu style
Each menus come in various styles for various applications. New style can also
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
More doc
2013-08-04 04:36:13 +02:00
Arrow also have a few types:
* radical.base.NONE
* radical.base.PRETTY
* radical.base.CENTERED
Add README
2013-08-03 07:03:43 +02:00
### Item style
Like menus, items can have their own style. Valid values:
* **Basic:** The most simple kind of items, no borders or special shape
* **Classic:** 1px border at the end of each items
* **Rounded:** A 3px border radius at each corner
### Menu layouts
On top of each styles, menu can also have different layouts to display items:
* **Vertical:** Items are displayed on top of each other
* **Horizontal:** Items are displayed alongside each other
* **Grid:** Items are displayed as a 2D array
### Using styles and layouts
```lua
local radical = require("radical")
local m = radical.context({
style = radical.style.classic ,
item_style = radical.item_style.classic ,
layout = radical.layout.vertical })
More doc
2013-08-04 04:36:13 +02:00
```
## 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 |
Try to fix issue #3 (I sill cannot reproduce it)
2013-10-27 00:42:59 +02:00
| fg_focus | Foreground of focussed items | String/gradient/pattern |
More doc
2013-08-04 04:36:13 +02:00
| 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 |
Add sub_menu_on option
2014-01-04 07:27:52 +01:00
| arrow_type | Set the arrow type when use arrow style | see "arrow_type" enum |
More doc
2013-08-04 04:36:13 +02:00
| 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 |
Implement issue #2
2013-08-07 21:32:44 +02:00
| enable_keyboard | Enable or disable keyboard navigation / hooks | boolean |
Add 'disable_markup' option
2013-10-01 04:19:38 +02:00
| disable_markup | Disable pango markup in items text | boolean |
Add screenshot
2013-08-05 06:50:37 +02:00
| x | X position (absolute) | number |
| y | Y position (absolute) | number |
Add sub_menu_on option
2014-01-04 07:27:52 +01:00
| sub_menu_on | Show submenu on selection or when clicking | see "sub_menu_on" enum |
More doc
2013-08-04 04:36:13 +02:00
###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
Use header background for table headers (if available)
2013-08-09 09:39:56 +02:00
* menu_submenu_icon