Template:Calculator codex toggle/doc

Usage

This is to create a codex-style toggle switch {{calculator}} widget.

Please see https://doc.wikimedia.org/codex/latest/components/demos/toggle-switch.html#guidelines for best practices.

Example

{{Calculator codex toggle|id=mycheck|label=My toggle|description=Additional text describing the toggle}}

produces:

My toggleAdditional text describing the toggle

If you have multiple toggle switches that should be grouped together, you should put them all in a <div> with role="group". This helps with accessibility. The group should have its own label referenced by aria-labelledby. For example:

<div role="group" aria-labelledby="mygrouplabel" id="mytogglegroup">
{{calculator label|codex=1|for=mytogglegroup|label=This is a group of toggles|id=mygrouplabel}}
{{Calculator codex toggle|id=mycheck1|label=First option|description=Additional text describing the first option}}<br>
{{Calculator codex toggle|id=mycheck2|label=Second option|description=Additional text describing the first option}}<br>
{{Calculator codex toggle|id=mycheck3|label=Thid option}}
</div>

This is a group of toggles

First optionAdditional text describing the first option

Second optionAdditional text describing the first option

Thid option

Template data

Add a toggle switch button for calculator gadget in codex style

Template parameters

Parameter		Description	Type	Status
id	id	id value of calculator widget. Can be referenced by other calculator templates	Unknown	required
formula	formula	Formula to control if button is on or off.	Unknown	optional
readonly	readonly	Make button read only. Read only buttons can be adjusted by formula but not by user interaction	Boolean	optional
class-live	class-live	extra css classes to add only if gadget is enabled	Unknown	optional
class	class	extra css class	String	optional
default	default	Whether to start in a checked or unchecked state Suggested values 1 0	String	optional
description	description	Additional description to add after the label	Content	optional
label	label	Label for toggle switch button	Unknown	required
hiddendescription	hiddendescription	Hide description label. If set, the label will be used for screen readers but not shown to users. The label field is still mandatory	Boolean	optional