A switch is used to toggle between two states, on and off, just like a light switch.
<script type="module">
import '@brightspace-ui/core/components/switch/switch.js';
import '@brightspace-ui/core/components/switch/switch-visibility.js';
</script>
<d2l-switch text="My Switch" on></d2l-switch>
<d2l-switch-visibility on></d2l-switch-visibility>
- Use a switch to toggle ON/OFF states with immediate effect
- Use a visible label near the switch to indicate its purpose
- Don't toggle the language in the label, it should remain static
- The Visibility Switch is a necessary exception to this rule
- Don't use a switch in a form, use a checkbox or radio options in stead
The d2l-switch
element is a generic switch with on/off semantics.
<script type="module">
import '@brightspace-ui/core/components/switch/switch.js';
</script>
<d2l-switch text="My Switch"></d2l-switch>
Property | Type | Description |
---|---|---|
text |
String, required | Accessible text for the switch |
disabled |
Boolean | Disables the switch |
on |
Boolean | Whether the switch is "on" or "off" |
text-position |
String | Valid values are: start , end (default), and hidden |
change
: dispatched when theon
property is updated
To make your usage of d2l-switch
accessible, use the following property:
Attribute | Description |
---|---|
text |
REQUIRED Acts as a primary label on the switch. Visible unless text-position is hidden . |
The d2l-switch-visibility component is a special variant for toggling the visibility of activities. Activities can be set to "on" but still not appear for users due to availability conditions. Therefore, the d2l-switch-visibility can display as "Hidden", "Visible", or "Visible. Conditions must be met" if a description of the conditions is provided.
See also Visibility Switch with Conditions.
<script type="module">
import '@brightspace-ui/core/components/switch/switch-visibility.js';
</script>
<d2l-switch-visibility></d2l-switch-visibility>
Property | Type | Description |
---|---|---|
disabled |
Boolean | Disabled the switch |
on |
Boolean | Whether the switch is "on" or "off". If content is passed into the switch slot, the switch will be "on with conditions". |
text-position |
String | Valid values are: start , end (default), and hidden |
change
: dispatched when theon
property is updated
- Optional default slot content - Content that will be displayed within the "conditions" opener tooltip when the switch is on.
If an activity is set to Visible
but also has other conditions affecting its visibility, information about the conditions can be passed in the default slot so it will be available in a tooltip.
<script type="module">
import '@brightspace-ui/core/components/switch/switch-visibility.js';
</script>
<d2l-switch-visibility on>
These are some conditions that must be met for the activity to be visible.
<ul>
<li> Condition 1 </li>
<li> Condition 2 </li>
<li> Condition 3 </li>
</ul>
</d2l-switch-visibility>