К содержимому

SusTutorialModal

SusTutorialModal

Туториальная модалка — SusModal + SusDialogueBox с шагами Next/Skip; мягкая передача в SusSpotlightTour при наличии тура, без тура работает автономно.

Пакет

SusKit · Молекулы (коммерческий)

Открыть в песочнице

SusKit · Molecules

Свойства

ИмяТипПо умолчанию
ModelProp<bool>falsev-model
CurrentIndexProp<int>-1
NextLabelProp<string>"Next"
FinishLabelProp<string>"Done"
SkipLabelProp<string>"Skip"
RevealProp<string>"Instant"
WidthProp<float>480f
PersistentProp<bool>truev-model

Слоты

Слотов нет.

События

ИмяПолеPayload
OpenedOnOpened
ClosedOnClosed

Хуки стиля

Контракт USS-классов — внешний вид переопределяется без правки C#. Состояния переключаются этими классами:

  • sus-modal__title
  • sus-tutorial-modal
  • sus-tutorial-modal__next
  • sus-tutorial-modal__skip
  • sus-tutorial-modal__title
  • sus-tutorial-modal__title--empty

Использование

Собирает модалку вокруг SusDialogueBox с Next/Skip. Опциональный AttachSpotlight передаёт цель подсветки текущего шага в SusSpotlightTour, если тур прикреплён; без тура модалка всё равно работает.

csharp
var tutorial = new SusTutorialModal();
tutorial.NextLabel.Value = "Next";
tutorial.SkipLabel.Value = "Skip";
tutorial.Reveal.Value = "PerChar";
tutorial.AddStep("Guide", "Welcome aboard.", title: "Intro");
tutorial.AddStep("Guide", "Open the inventory with I.", title: "Inventory");
// tutorial.AttachSpotlight(myTour); // soft — omit if no tour
tutorial.Completed = () => { /* finished */ };
tutorial.Skipped = () => { /* aborted */ };
tutorial.Start();
// tutorial.Next(); tutorial.Skip(); tutorial.Close();
Prop / APIРоль
Model / CurrentIndexоткрытое состояние и индекс шага
NextLabel / SkipLabelтекст кнопок
Reveal / Width / Persistentreveal диалога + хром модалки
AddStep / ClearStepsсобрать список шагов
AttachSpotlight(tour)мягкая передача spotlight-туру
Start / Next / Skip / Closeуправление прогоном
StepChanged / Completed / Skippedсобытия хоста

Заметки

  • Storybook story Tutorial Modal (tutorial-modal).
  • Hub shot kit-tutorial-modal.png — витрина, снято в Play mode.