OpenWetWare:Toggle

From OpenWetWare

Revision as of 10:45, 6 June 2007 by Austin J. Che (Talk | contribs)
(diff) ←Older revision | Current revision (diff) | Newer revision→ (diff)
Jump to: navigation, search

This feature allows for toggling the visibility of any part of the page.

Contents

Fun Examples

Probably the best way to learn how the toggle code works is to look at some examples (look at the source of this page).

Simple hiding

hello world

bye world

Multiple

  • item1
  • item2
  • toggle item1
  • toggle item2
  • toggle both items

Show hide all

[show all] [hide all] (only shows/hides items that use the Template:Hide template)

Mutual toggling

  1. Toggle #2
  2. Toggle #1

Toggling table rows/cols

Row 1, Column 1 Row 1, Column 2
Row 2, Column 1 Row 2, Column 2
  • Toggle row 1
  • Toggle row 2
  • Toggle column1
  • Toggle column2

Remote action

toggle headers/footers/navigation

Nesting

[open level 1]

Tabs

  • tab1
  • tab2
  • tab3
Tab 1

Usage

Toggling is based on the CSS class. You can specify the class of any element with the class attribute. For wiki text, it is usually the most convenient to add a span or div and assign a class to that, e.g. <div class="class1 class2 class3">'''wiki text here'''</div>. Notice that multiple classes are separated by spaces. Some classes have special meaning and all of these special classes begin with "_toggle". For elements that should be initially hidden, set their CSS display property to none, e.g. <div class="class1" style="display:none;"...</div>

Togglers

To define a basic toggler, add a class of the form _toggler-CLASS to an element. For example, <span class="_toggler-foo">foo toggler</span> produces foo toggler. Note that a link is automatically created but nothing happens when the link is clicked. That's because there are no elements of class "foo" on this page. If there were any such elements, all of their visibility would be toggled (i.e. if they are currently hidden, they are shown, and vice versa).

Some different type of togglers can also be created. The more general form for toggler classes are _toggler_OPERATION-CLASS, e.g. _toggler_show-foo. The default operation is the TOGGLE operation above. Other valid operations are:

  • reset: all elements of the given class are reset to their original value (when the page was originally shown)
  • show: all elements of the given class are made visible
  • hide: all elements of the given class are hidden

Some things to note:

  • togglers can toggle other togglers or even themselves
  • togglers can have multiple toggle operations, e.g. "_toggler_hide-foo _toggler_show-bar" will hide all foo elements and show all bar elements
  • You can toggle based on element ID rather than a class. A similar syntax is used except use double hyphens after the toggler operation. For example, "_toggler--myelement" toggles only the element with ID myelement (e.g. defined as <div id="myelement>...</div>. Note that IDs are technically required to be unique on a page so in this form, you should expect to be toggling at most one element.

Toggle groups

To make it easier to use without having to explicitly define classes to toggle, there is a notion of a toggle group. A new toggle group is created when the class "_togglegroup" is seen in some element. This special class serves no other purpose than to delimit the boundary of a toggle group. Within a toggle group, togglers can be defined without a class to refer to all toggles within the toggle group, e.g. "_toggler" or "_toggler_reset". Toggles within a toggle group are defined using the class "_toggle".

Handling non-Javascript

If Javascript is not enabled, usually you will want all of the content (or the important parts) to be shown. There are two special classes "_toggle_initshow" and "_toggle_inithide" which set the initial value of a toggle. This has a similar effect of setting the CSS display property. However, there are a couple differences. If you set the CSS display property, then when Javascript is not enabled, the object will be permanently set with that value. For example, an object hidden with display=none can never be shown if Javascript is turned off. Alternatively, if you do not set the CSS property and instead set _toggle_inithide, then if Javascript is on, the object will be hidden (and presumably will be toggleable), but if Javascript is off, the object will shown. The main disadvantage to using Javascript to initially hide an object is that the objects may briefly appear on the browser's screen before being hidden (doesn't look too nice). However, for accessibility reasons, it is probably preferable to allow non-Javascript browsers to view all the content.

Templates

Templates can make this much easier to use. Some existing templates are:

Technical Details

See MediaWiki:Common.js for the javascript code.

Personal tools