Template:Filter/doc: Difference between revisions

Latest revision as of 15:02, 11 May 2026

This is the documentation page for Filter. It contains usage information, categories, and other content not part of the original template page.
Main	Documentation	Usage

This template uses JS found at MediaWiki:Gadget-Filter.js and MediaWiki:DataTables.js.

This template uses CSS found at MediaWiki:Gadget-Filter.css.

Template that creates a row of filters for fiterable tables. To be used in conjuction with {{Filter/Header}} and {{Filter/Footer}}.

Syntax

{{Filter
|column = 
|all = true
|mode = 
|label = 
|1 = 
|query1 = 
|2 = 
|query2 = 
|3 = 
|query3 = 
}}

column – Table column number that will be queried for the filter.
mode – Set to:
- exact for an "exact" filter.
- contains for a "contains" filter.
label – Text label for filters.
n – Text displayed on the n-th filter button.
queryn – Text that will be queried upon pressing the n-th filter button

Example

Click on the buttons or type in the provided search box below to apply a filter to the list of neighbors.

Icon	Name	Role	Galaxy	Pronouns	Birthday	Loves	Likes	Dislikes
	Mors	Curator of the Omni-Gallery		He/Him	December 8th
	Mobai	Life Coordinator		He/Him	February 19th
	Frostia	Mystic Scholar	Norvan	She/Her	September 9th	Realm of Stars Ballgown Glistening Fruit Pie Quill Pen & Astrology Book	Butterfly Bookshelf Desk Purple
	Glenn	Shopkeeper		He/Him	May 1st
	Isaki	Battle Beetle Trainer	Hexia	He/Him	July 22nd	Kabuto Beetle Rustic Dog House Golden Daikabutomaru Statue Kabuto Rice Bun	Beetle Yellow Street Decor Wood Sporty	Aquatic Creature Classic
	Medowlyn	Plushie Designer	Norvan	She/Her	July 5th	Wildgrass Sleepymoon Nightgown Cloudlet Cookies Fluffy Clouds Plushie	Plushie Blue Dress White Flower Contains Tomato	Metal Shore-Dweller Contains Seafood
	Yunguo	Cultivator	Hexia	She/Her	September 19th	Apple Bamboo Log Bamboo Apple Slushie Granny's Veggie Fried Rice	Bamboo (Material) Farm Decor Green Red Fertilizer	Black Plastic
	Elsasani	Starsea Racer		She/Her	February 14th
	Dorjelang	Hatmaker	Hexia	He/Him	May 2nd	Caterpillar Fungus Herbal Remedy Cloudherder's Hatmaking Chest Dreamy Shellfish & Seafood Platter	Red Orange Romantic Natural Fiber Grilled Dish Headwear	Beetle Metal
	Msafiri	Adventure Guide	Taffeh	He/Him	August 8th	Grainharvester's Haystacks Yellowbloom Potted Cactus Handmade Tabby Cat Plushie Sunny Orange Sneakers Golden Savanna Tumbleweed	Brown Grilled Dish Natural Fiber	Field & Orchard Salad Bathtub Drink
	Rebella	Gemsmith	Norvan	She/Her	February 9th	Goldflux Ore BBQ Meatshrooms	Green Stone (Material) Meat Dish Teal Fridge	Veggie Plastic Classic
	Nerina	Composer	Pashah	She/Her	June 8th	Tidal Wave Yogurt Seaside Serenade Music Stand Legato Concert Jacket	Broken Seashell Bathtub Blue Shower Artistic	Pepper (Type) Clock
	Harpeno	Starsea Patrol Officer	Taffeh	She/Her	December 7th	Harborlight Signal Mood Light Carapulcra Stew Harborlight Charging Bookcase EV Charging Station	Stew Wood Glasses Multicolor	Laptop Glass
	Trixie			She/Her
	Manna	Action Actor	Hexia	She/Her	February 22nd	Peach Grove Master Wooden Dummy Peach Grove Master Plum Blossom Poles Professional Projector	Black White Contains Fruit Slippers	Cream Recycling Bin Pepper (Type)
	Tika	Agriculture Student	Taffeh	She/Her	August 16th	Avocado Chic Black Cat-Eye Sunglasses Fruit Fiesta Donut Avocuddle Experimental Planter Box	Yarn (Material) Wood Green Tree Fruit Farm Decor Contains Fruit	Wildgrass Study Supplies
	Heyu	Hot Spring Innkeeper	Hexia	He/Him	February 15th	Crane of Longevity Calligraphy Set Di San Xian Leisurely Pause Tea Stove	White Black Dessert Bathtub Water Feature	Contains Fish Contains Seafood
Petit Planet Wiki:Petit Planet:Sandbox/Infobox	Petit Planet Wiki:Petit Planet:Sandbox/Infobox	Village Resident	Milky Way Milky Way	He/Him	March 15	Apple Strawberry Cake Flower Bouquet Flower Bouquet	Orange Milk Wood	Broken Wood Stone

@@ Line 1: / Line 1: @@
 {{Documentation/Header}}
-{{Lua|FilterBuilder}}
+{{JS|Gadget-Filter|DataTables}}
-{{See also|Template:Search}}
+{{CSS|Gadget-Filter}}
-Template that creates filters for fiterable tables. To be used in conjuction with {{T|Filter/Header}} and {{T|Filter/Footer}}.
+Template that creates a row of filters for fiterable tables. To be used in conjuction with {{T|Filter/Header}} and {{T|Filter/Footer}}.
-==Usage==
+==Syntax==
-<pre>{{Filter|<1>|<2>|<3>|<4>}}</pre>
+<syntaxhighlight lang="wikitext" copy>
-This template has up to 4 unnamed parameters:
+{{Filter
-* <code>1</code> &mdash; Name of data group being filtered. '''''{{Color|New|Required}}'''''
+|column =
-* <code>2</code> / <code>value</code> &mdash; Comma separated list of possible values for the data group
+|all = true
-* <code>3</code> / <code>display</code> &mdash; Comma separated list of corresponding displays for the values (e.g., an icon)
+|mode =
-* <code>4</code> / <code>default</code> &mdash; Comma separated list of default applied filters
+|label =
+|1 =
+|query1 =
+|2 =
+|query2 =
+|3 =
+|query3 =
+}}
+</syntaxhighlight>
+* {{F|column}} &ndash; Table column number that will be queried for the filter.
+* {{F|mode}} &ndash; Set to:
+** {{F|exact}} for an "exact" filter.
+** {{F|contains}} for a "contains" filter.
+* {{F|label}} &ndash; Text label for filters.
+* {{F|((n))}} &ndash; Text displayed on the ''n''-th filter button.
+* {{F|query((n))}} &ndash; Text that will be queried upon pressing the ''n''-th filter button
 ==Example==
-<pre>
+{{Filter/Header|id=neighbor-list|type=neighbors}}
-{{Filter/Header|message=Click on the buttons to apply a filter to the list of [[creature]]s.}}
+{{Filter
-{{Filter|category|Fish,Insects,Shore-Dwellers|Fish,Insects,Shore-Dwellers}}
+|column = 4
-{{Search|dataKey=name|placeholder=Search by creature}}
+|all = true
-{{Filter|reset}}
+|mode = contains
-{{Filter/Footer}}
+|label = Galaxy:
-{| class="wikitable sortable"
+|1 = [[File:Hexia Icon.png|30px|link=|class=day-invert-image]]
-|-
+|query1 = Hexia
-! Icon
+|2 = [[File:Taffeh Icon.png|30px|link=|class=day-invert-image]]
-! Creature
+|query2 = Taffeh
-! Category
+|3 = [[File:Norvan Icon.png|30px|link=|class=day-invert-image]]
-{{#DPL:
+|query3 = Norvan
-|namespace =
+}}
-|uses = Template:Creature Infobox
+{{Filter
-|category = Creatures
+|column = 5
-|include = {Creature Infobox}:name,{Creature Infobox}:category,{Creature Infobox}:name,{Creature Infobox}:category
+|all = true
-|format = ,,,
+|label = Pronouns:
-|secseparators = <tr class="filter-element" data-name=",," data-category=",,"><td>[[File:%PAGE% Icon.png|x30px|link=%PAGE%]]</td><td>[[,,]]</td><td>,,</td></tr>
+|1 = He/Him
-|ordermethod = sortkey
+|2 = She/Her
-|count = 40
 }}
-|}
-</pre>
-{{Filter/Header|message=Click on the buttons to apply a filter to the list of [[creature]]s.}}
-{{Filter|category|Fish,Insects,Shore-Dwellers|Fish,Insects,Shore-Dwellers}}
-{{Search|dataKey=name|placeholder=Search by creature}}
-{{Filter|reset}}
 {{Filter/Footer}}
-{| class="wikitable sortable"
+{{#invoke:Bucket|get|neighbors
-|-
+|select = page_name, birthday, role, galaxy, pronouns, loves, likes, dislikes
-! Icon
+|where = {{{where|}}}
-! Creature
+|filter = {{{filter|}}}
-! Category
+|order by = page_name
-{{#DPL:
-|namespace =
+|format = userformat
-|uses = Template:Creature Infobox
+|show resultsHeader = false
-|category = Creatures
+|header = <!--
-|include = {Creature Infobox}:name,{Creature Infobox}:category,{Creature Infobox}:name,{Creature Infobox}:category
+--><table id="neighbor-list" class="wikitable sortable"><!--
-|format = ,,,
+--><tr><!--
-|secseparators = <tr class="filter-element" data-name=",," data-category=",,"><td>[[File:%PAGE% Icon.png|x30px|link=%PAGE%]]</td><td>[[,,]]</td><td>,,</td></tr>
+--><th class="unsortable">Icon</th><!--
-|ordermethod = sortkey
+--><th>Name</th><!--
-|count = 40
+--><th>Role</th><!--
+--><th>Galaxy</th><!--
+--><th>Pronouns</th><!--
+--><th>Birthday</th><!--
+--><th>Loves</th><!--
+--><th>Likes</th><!--
+--><th>Dislikes</th><!--
+--></tr>
+|userformat = <!--
+--><tr><!--
+--><td>{{Item|size=50|%page_name%|notext=1}}</td><!--
+--><td>[[%page_name%]]</td><!--
+--><td>%role%</td><!--
+--><td><nowiki>{{#if:%galaxy%|{{Item|%galaxy%|invert=Day}}}}</nowiki></td><!--
+--><td>%pronouns%</td><!--
+--><td>%birthday%</td><!--
+--><td><nowiki>{{Item List|%loves%}}</nowiki></td><!--
+--><td><nowiki>{{List|%likes%}}</nowiki></td><!--
+--><td><nowiki>{{List|%dislikes%}}</nowiki></td><!--
+--></tr>
+|footer = </table>
 }}
-|}

SteviumBot (talk | contribs)

Latest revision as of 15:02, 11 May 2026

Syntax

Example