onboarding.models.assistant

Attributes

_T

Classes

Assistant	Describes an assistant guiding a user through onboarding.
Step	Describes a step in an assistant.
DefaultAssistant

Module Contents

onboarding.models.assistant._T

class onboarding.models.assistant.Assistant(app: onegov.onboarding.app.OnboardingApp, current_step_number: int = 1)

Describes an assistant guiding a user through onboarding.

app

steps

current_step_number = 1

property current_step: Step

property progress: tuple[int, int]

property is_first_step: bool

property is_last_step: bool

for_next_step() → Self

for_prev_step() → Self

for_first_step() → Self

classmethod step(form: None = None) → Callable[[_ViewF], _ViewF]

classmethod step(form: type[_FormT]) → Callable[[_FormView[_FormT, _T]], _FormView[_FormT, _T]]

class onboarding.models.assistant.Step(view_handler: Callable[[CoreRequest], Any], order: float, form: None)

class onboarding.models.assistant.Step(view_handler: Callable[[CoreRequest, Form], Any], order: float, form: onegov.form.Form)

Describes a step in an assistant.

view_handler

order

form

__lt__(other: Step) → bool

handle_view(request: onegov.core.request.CoreRequest, form: Form | None) → Any

class onboarding.models.assistant.DefaultAssistant(assistant: Assistant)

assistant