バージョン: 2021.3 以降
この例では、“スイッチのような” トグルを作成する方法を説明します。
この例では、マウス、キーボード、ゲームパッド、その他のデバイスでユーザーが切り替えできるトグルというカスタムコントロールを作成します。このコントロールには、トグルが何を表しているかを説明するラベルも設定します。
この例で作成するすべてのファイルは、GitHub リポジトリ にあります。
このガイドは、Unity エディター、UI Toolkit、および C# スクリプトに精通している開発者を対象としています。始める前に、以下をよく理解してください。
C# スクリプトでスライドトグルのクラスを作成し、USS ファイルでスタイルを設定します。
3D テンプレートで Unity プロジェクトを作成します。この例では、3D テンプレートの方が高い視覚効果を得られます。ただし、どのテンプレートを使っても構いません。
ファイルを保存するために slide-toggle
という名前のフォルダーを作成します。
slide-toggle
フォルダーに、SlideToggle.cs
という名前の C# スクリプトを作成します。
テキストエディターで SlideToggle.cs
スクリプトを開き、そのコンテンツを下のコードに置き換えます。
using UnityEngine;
using UnityEngine.UIElements;
namespace MyUILibrary
{
// Derives from BaseField<bool> base class. Represents a container for its input part.
public class SlideToggle : BaseField<bool>
{
public new class UxmlFactory : UxmlFactory<SlideToggle, UxmlTraits> { }
public new class UxmlTraits : BaseFieldTraits<bool, UxmlBoolAttributeDescription> { }
// In the spirit of the BEM standard, the SlideToggle has its own block class and two element classes. It also
// has a class that represents the enabled state of the toggle.
public static readonly new string ussClassName = "slide-toggle";
public static readonly new string inputUssClassName = "slide-toggle__input";
public static readonly string inputKnobUssClassName = "slide-toggle__input-knob";
public static readonly string inputCheckedUssClassName = "slide-toggle__input--checked";
VisualElement m_Input;
VisualElement m_Knob;
// Custom controls need a default constructor. This default constructor calls the other constructor in this
// class.
public SlideToggle() : this(null) { }
// This constructor allows users to set the contents of the label.
public SlideToggle(string label) : base(label, null)
{
// Style the control overall.
AddToClassList(ussClassName);
// Get the BaseField's visual input element and use it as the background of the slide.
m_Input = this.Q(className: BaseField<bool>.inputUssClassName);
m_Input.AddToClassList(inputUssClassName);
Add(m_Input);
// Create a "knob" child element for the background to represent the actual slide of the toggle.
m_Knob = new();
m_Knob.AddToClassList(inputKnobUssClassName);
m_Input.Add(m_Knob);
// There are three main ways to activate or deactivate the SlideToggle. All three event handlers use the
// static function pattern described in the Custom control best practices.
// ClickEvent fires when a sequence of pointer down and pointer up actions occurs.
RegisterCallback<ClickEvent>(evt => OnClick(evt));
// KeydownEvent fires when the field has focus and a user presses a key.
RegisterCallback<KeyDownEvent>(evt => OnKeydownEvent(evt));
// NavigationSubmitEvent detects input from keyboards, gamepads, or other devices at runtime.
RegisterCallback<NavigationSubmitEvent>(evt => OnSubmit(evt));
}
static void OnClick(ClickEvent evt)
{
var slideToggle = evt.currentTarget as SlideToggle;
slideToggle.ToggleValue();
evt.StopPropagation();
}
static void OnSubmit(NavigationSubmitEvent evt)
{
var slideToggle = evt.currentTarget as SlideToggle;
slideToggle.ToggleValue();
evt.StopPropagation();
}
static void OnKeydownEvent(KeyDownEvent evt)
{
var slideToggle = evt.currentTarget as SlideToggle;
// NavigationSubmitEvent event already covers keydown events at runtime, so this method shouldn't handle
// them.
if (slideToggle.panel?.contextType == ContextType.Player)
return;
// Toggle the value only when the user presses Enter, Return, or Space.
if (evt.keyCode == KeyCode.KeypadEnter || evt.keyCode == KeyCode.Return || evt.keyCode == KeyCode.Space)
{
slideToggle.ToggleValue();
evt.StopPropagation();
}
}
// All three callbacks call this method.
void ToggleValue()
{
value = !value;
}
// Because ToggleValue() sets the value property, the BaseField class dispatches a ChangeEvent. This results in a
// call to SetValueWithoutNotify(). This example uses it to style the toggle based on whether it's currently
// enabled.
public override void SetValueWithoutNotify(bool newValue)
{
base.SetValueWithoutNotify(newValue);
//This line of code styles the input element to look enabled or disabled.
m_Input.EnableInClassList(inputCheckedUssClassName, newValue);
}
}
}
slide-toggle
フォルダーに、SlideToggle.uss
という名の USS ファイルを作成します。
SlideToggle.uss
をテキストエディターで開き、そのコンテンツを以下のように置き換えます。`
.slide-toggle__input {
background-color: var(--unity-colors-slider_groove-background);
max-width: 25px;
border-top-left-radius: 8px;
border-bottom-left-radius: 8px;
border-top-right-radius: 8px;
border-bottom-right-radius: 8px;
overflow: visible;
border-left-width: 1px;
border-right-width: 1px;
border-top-width: 1px;
border-bottom-width: 1px;
border-right-color: var(--unity-colors-slider_thumb-border);
border-top-color: var(--unity-colors-slider_thumb-border);
border-bottom-color: var(--unity-colors-slider_thumb-border);
max-height: 16px;
margin-top: 10px;
border-left-color: var(--unity-colors-slider_thumb-border);
transition-property: background-color;
transition-duration: 0.5s;
}
.slide-toggle__input-knob {
height: 16px;
width: 16px;
background-color: var(--unity-colors-slider_thumb-background);
position: absolute;
border-top-left-radius: 25px;
border-bottom-left-radius: 25px;
border-top-right-radius: 25px;
border-bottom-right-radius: 25px;
top: -1px;
transition-property: translate, background-color;
transition-duration: 0.5s, 0.5s;
translate: -1px 0;
border-left-width: 1px;
border-right-width: 1px;
border-top-width: 1px;
border-bottom-width: 1px;
border-left-color: var(--unity-colors-slider_thumb-border);
border-right-color: var(--unity-colors-slider_thumb-border);
border-top-color: var(--unity-colors-slider_thumb-border);
border-bottom-color: var(--unity-colors-slider_thumb-border);
}
.slide-toggle__input--checked {
background-color: rgb(0, 156, 10);
}
.slide-toggle__input--checked > .slide-toggle__input-knob {
translate: 8px 0;
}
.slide-toggle:focus .slide-toggle__input-knob {
border-left-width: 1px;
border-right-width: 1px;
border-top-width: 1px;
border-bottom-width: 1px;
border-left-color: var(--unity-colors-input_field-border-focus);
border-right-color: var(--unity-colors-input_field-border-focus);
border-top-color: var(--unity-colors-input_field-border-focus);
border-bottom-color: var(--unity-colors-input_field-border-focus);
}
slide-toggle
フォルダーに、SlideToggleUsage.uxml
という名前の UI ドキュメントを作成します。SlideToggleUsage.uxml
を開きます。SlideToggle.uss
を加えます。SlideToggleUsage.uxml
を Inspector の Source Asset フィールドにドラッグします。Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.