An extension for Grid.

GridLayoutLayouts.lua file contains many "Layouts" to arrange the unit buttons. Sometimes we may find it doesn't meet the needs.

This extension makes it possible to add new layouts in game. And it simplified the code to describe a layout.

Click "Grid - Layouts - Custom Layouts" to bring up a edit frame.

Each line stands for a Unit Button Group. The Grammer is:

List of the attributes


showRaid = [BOOLEAN] - true if the header should be shown while in a raid
showParty = [BOOLEAN] - true if the header should be shown while in a party and not in a raid
showPlayer = [BOOLEAN] - true if the header should show the player when not in a raid
showSolo = [BOOLEAN] - true if the header should be shown while not in a group (implies showPlayer)
nameList = [STRING] - a comma separated list of player names (not used if 'groupFilter' is set)
groupFilter = [1-8, STRING] - a comma seperated list of raid group numbers and/or uppercase class names and/or uppercase roles
strictFiltering = [BOOLEAN] - if true, then characters must match both a group and a class from the groupFilter list
sortMethod = ["INDEX", "NAME"] - defines how the group is sorted (Default: "INDEX")
sortDir = ["ASC", "DESC"] - defines the sort order (Default: "ASC")
groupBy = [nil, "GROUP", "CLASS", "ROLE"] - specifies a "grouping" type to apply before regular sorting (Default: nil)
groupingOrder = [STRING] - specifies the order of the groupings (ie. "1,2,3,4,5,6,7,8")
maxColumns = [NUMBER] - maximum number of columns the header will create (Default: 1)
unitsPerColumn = [NUMBER or nil] - maximum units that will be displayed in a singe column, nil is infinate (Default: nil)

The simplify is:
You don't need the entire class/role name, just the start part of it :

5/2 -> unitsPerColumn="5";maxColumns="2"

PET -> isPetGroup=true

INDEX or NAME -> sortMethod="INDEX" or sortMethod="NAME"

ASC or DESC -> sortDir="ASC" or sortDir="DESC"

STRICT -> strictFiltering="true"

GROUP or CLASS or ROLE -> groupBy="GROUP" or groupBy="CLASS" or groupBy="ROLE"

You don't need to write "groupFilter=", for example:
1,2,3,4,5 is just the same as groupFilter="1,2,3,4,5"
WARR,PAL,DRU is just the same as groupFilter="WARRIOR,PALADIN,DRUID"

If the group name is not group ids and not class or role names, for example:
Abcde,Xyz will be parsed to nameList="Abcde,Xyz"

That's all. A little complicated though. Advanced user only :(

Actually, I don't use this much, just put it here for sharing.

Attribute: noRepeat = true
Now you can add a NOREPEAT(NOREP,NOR and NR is just the same) attribute to non-pet group header, for example


In the above layout, the first group will contains WARRIORs and PALADINs, but not Someone or Anotherone.
And the next 5 groups will contains team 1-5 members, but not Someone or Anotherone, neither any WARRIORs or PALs.
Actually, group headers with NOREPEAT are parsed to specified nameList groups, therefore the 'groupBy' attribute will be ignore.

You must login to post a comment. Don't have an account? Register to get one!

  • Avatar of snaomi snaomi Dec 21, 2011 at 13:21 UTC - 0 likes

    How to do:

    Column 1 (left) with 5 rows: Anyone, Anyone, Anyone, Anyone, Anyone Column 2 (right) with 5 rows: Tank 1, Tank 2, Myself, Anyone, Anyone

    Last edited Dec 21, 2011 by snaomi
  • Avatar of rhozac rhozac May 30, 2011 at 01:59 UTC - 0 likes

    im retarded or something, how can i make a single horizontal row with 1 in each colum? like stacked from up to down in a single row. thought it would be easy but i was wrong ;P

  • Avatar of ebonyfaye ebonyfaye May 01, 2011 at 13:53 UTC - 0 likes

    Any update for 4.1 the UI goes nuts am sure its a easy fix

    really love the addon

  • Avatar of VaughnofCen VaughnofCen Nov 10, 2010 at 15:48 UTC - 0 likes

    First time user to the layouts...

    Seeking a single horizontal / vertical row of sleek vertical healthbars / mana bars,

    Got what I intially wanted but noticed it wasn't grouping by 1 2 3 4 5 format... after further experimenting I noticed that it will repeat (at -least- my character's frame) for each new line of text.

    Any ideas on what code I should try out?

    Thanks for you time.

  • Avatar of warbaby warbaby Dec 15, 2009 at 01:14 UTC - 0 likes

    Pets can't be together with players, they must in separate groups. By adding ";PET" to the end of a line, you will make a pets group of those players.

    For example,


    these are players.


    these are pets, the first group only shows mages and warlocks' pets, the second group shows pets whose master is in party 1/2/3/4

    FAQ is a good suggestion. But with my poor english, I can't easily describe a layout well...

    Last edited Dec 15, 2009 by warbaby
  • Avatar of coltimar coltimar Dec 14, 2009 at 21:43 UTC - 0 likes

    I have a custom layout to sort party order but I cannot figure out how to add pets to my group. Is the an FAQ that might help?

  • Avatar of Veange Veange Dec 14, 2009 at 14:45 UTC - 0 likes

    I love this addon so much!

    Could you please update for patch 3.3? ^___^

  • Avatar of warbaby warbaby Jun 12, 2009 at 18:26 UTC - 0 likes

    Thanks for your inspiring comment... I never thought this mod so helpful(shy:).

    I think your problem is an usage problem of recent Grid versions. The layout of each "party_state" is set seperately. In menu "Grid - Layout" there are "Solo Layout, Raid Layout, Heroic Layout, etc". When you save CustomLayouts, it only set your layout of CURRENT party_state. If your raid leader changes difficulty to heroic, Grid will change the layout to the former one you use in that party_state.

    If that is the situation, you just need to manually choose the layout in Grid - Layout menu. Hope this helpful.

    And I made a patch of origin GridLayout.lua, It solves dc in combat, and add a FORCE LAYOUT menu, which will be used by Grid unless it is set to NONE. I post it here: GridLayout.lua

  • Avatar of reehay reehay Jun 12, 2009 at 16:35 UTC - 0 likes

    bug report: been noticing that CustomLayouts arent being recalled by Grid. the Customlayout is still saved, but when joining a heroic raid for instance, the unit frames do not reflect the CustomLayout. usually just toggling between a default layout and then back to the CustomLayout fixes this but tonight i had to delete all custom layouts, re-log, then re-type, save, and choose my CustomLayout.

    once again, thanks very very much for your efforts. ive been promoting your addon to all my guild members.

  • Avatar of reehay reehay Jun 08, 2009 at 08:55 UTC - 0 likes

    Warbaby.... thank you sooooo much!!! these examples worked perfectly for what i wanted. and thanks for this addon. i got half my guild using it now.

    Grid is now a perfect fit for my UI.


Date created
May 31, 2009
Last update
Sep 04, 2016
Development stage
  • enUS
  • zhCN
  • zhTW
GNU Lesser General Public License version 2.1 (LGPLv2.1)
Curse link
Recent files
  • R: 2016.09.05 for 7.0.3 Sep 04, 2016
  • A: r25 for 4.1.0 May 05, 2011
  • R: 1.05.05 for 4.0.6 May 05, 2011
  • A: r23 for 4.1.0 May 05, 2011
  • R: 0.10.19 for 4.0.1 Oct 18, 2010