nilbuild / nilbuild/driver.js

[Feature Request] Lifecycle events

Open
#493 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
26.8k
Forks
1.2k
PR merge metrics
No merged PRs in 30d

Description

There are various events, e.g. for the tour: onDestroyed, and for steps: onNextClick, onPrevClick, onCloseClick.

But they're not useful for a reasonably complex page. I needed events like these:

  • onTourStarting
  • onTourStopping
  • onStepActivating
  • onStepDeactivating

Those would be more robust and cover the important cases: before/after the tour and before/after each step. That would also work well with async use cases.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing how the existing tour events such as onDestroyed and step events such as onNextClick are handled. Define the lifecycle boundaries for starting and stopping tours and activating and deactivating steps, including async use cases. Done means the new lifecycle events cover the requested before/after cases consistently.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.