Skip to content

Commit

Permalink
Merge pull request #157 from gravity-ui/closebyuser-event
Browse files Browse the repository at this point in the history 
Add closeHintByUser event
  • Loading branch information
@vanilla-wave
vanilla-wave authored Feb 26, 2025
2 parents e1a4b28 + 486a4ee commit 778dbe6
Show file tree
Hide file tree
Showing 3 changed files with 259 additions and 30 deletions.
4 changes: 4 additions & 0 deletions src/controller.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -336,6 +336,10 @@ export class Controller<HintParams, Presets extends string, Steps extends string
step?.hooks?.onCloseHint?.();
}

if (this.hintStore.state.hint) {
this.events.emit('closeHintByUser', {hint: this.hintStore.state.hint});
}

this.hintStore.closeHint();
this.checkReachedHints();
};
Expand Down
284 changes: 254 additions & 30 deletions src/tests/event-hooks.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -221,50 +221,68 @@ describe('preset hooks', function () {
});
});
describe('event subscriptions', function () {
it('beforeShowHint', async function () {
const controller = new Controller(getOptions());
describe('beforeShowHint', () => {
it('element reached -> trigger event', async function () {
const controller = new Controller(getOptions());

const mock = jest.fn();
controller.events.subscribe('beforeShowHint', mock);
const mock = jest.fn();
controller.events.subscribe('beforeShowHint', mock);

await controller.stepElementReached({
stepSlug: 'createSprint',
element: getAnchorElement(),
await controller.stepElementReached({
stepSlug: 'createSprint',
element: getAnchorElement(),
});

expect(mock).toHaveBeenCalled();
});

expect(mock).toHaveBeenCalled();
});
it('element reached -> hint shown', async function () {
const controller = new Controller(getOptions());

it('beforeShowHint with cancel -> no hint', async function () {
const controller = new Controller(getOptions());
const mock = jest.fn();
controller.events.subscribe('beforeShowHint', mock);

const mock = jest.fn(() => false);
controller.events.subscribe('beforeShowHint', mock);
await controller.stepElementReached({
stepSlug: 'createSprint',
element: getAnchorElement(),
});

await controller.stepElementReached({
stepSlug: 'createSprint',
element: getAnchorElement(),
expect(controller.hintStore.state.open).toBe(true);
});

expect(controller.hintStore.state.open).toBe(false);
});
it('cancel hint show -> hint still not open', async function () {
const controller = new Controller(getOptions());

it('beforeShowHint with cancel -> call all hooks', async function () {
const controller = new Controller(getOptions());

const mock1 = jest.fn(() => false);
const mock2 = jest.fn();
// return false to cancel hint show
const mock = jest.fn(() => false);
controller.events.subscribe('beforeShowHint', mock);

controller.events.subscribe('beforeShowHint', mock1);
controller.events.subscribe('beforeShowHint', mock2);
await controller.stepElementReached({
stepSlug: 'createSprint',
element: getAnchorElement(),
});

await controller.stepElementReached({
stepSlug: 'createSprint',
element: getAnchorElement(),
expect(controller.hintStore.state.open).toBe(false);
});

expect(mock1).toHaveBeenCalled();
expect(mock2).toHaveBeenCalled();
it('cancel hint show -> call all hooks', async function () {
const controller = new Controller(getOptions());

// return false to cancel hint show
const mock1 = jest.fn(() => false);
const mock2 = jest.fn();

controller.events.subscribe('beforeShowHint', mock1);
controller.events.subscribe('beforeShowHint', mock2);

await controller.stepElementReached({
stepSlug: 'createSprint',
element: getAnchorElement(),
});

expect(mock1).toHaveBeenCalled();
expect(mock2).toHaveBeenCalled();
});
});

it('showHint', async function () {
Expand All @@ -287,6 +305,212 @@ describe('event subscriptions', function () {
);
});

describe('closeHint event', () => {
it('pass step -> trigger event', async function () {
const controller = new Controller(getOptions());

const mock = jest.fn();
controller.events.subscribe('closeHint', mock);

await controller.stepElementReached({
stepSlug: 'createSprint',
element: getAnchorElement(),
});
await controller.passStep('createSprint');

expect(mock).toHaveBeenCalledWith(
{
hint: {
preset: 'createProject',
step: {
slug: 'createSprint',
name: '',
description: '',
},
},
},
controller,
);
});

it('element disappeared -> trigger event', async function () {
const controller = new Controller(getOptions());

const mock = jest.fn();
controller.events.subscribe('closeHint', mock);

await controller.stepElementReached({
stepSlug: 'createSprint',
element: getAnchorElement(),
});
controller.stepElementDisappeared('createSprint');

expect(mock).toHaveBeenCalledWith(
{
hint: {
preset: 'createProject',
step: {
slug: 'createSprint',
name: '',
description: '',
},
},
},
controller,
);
});

it('user close hint -> trigger event', async function () {
const controller = new Controller(getOptions());

const mock = jest.fn();
controller.events.subscribe('closeHint', mock);

await controller.stepElementReached({
stepSlug: 'createSprint',
element: getAnchorElement(),
});
controller.closeHint('createSprint');

expect(mock).toHaveBeenCalledWith(
{
hint: {
preset: 'createProject',
step: {
slug: 'createSprint',
name: '',
description: '',
},
},
},
controller,
);
});

it('no open hint -> NOT trigger event', async function () {
const controller = new Controller(getOptions());

const mock = jest.fn();
controller.events.subscribe('closeHint', mock);

controller.closeHint();

expect(mock).not.toHaveBeenCalled();
});

it('try close other hint -> NOT trigger event', async function () {
const controller = new Controller(getOptions());

const mock = jest.fn();
controller.events.subscribe('closeHint', mock);

await controller.stepElementReached({
stepSlug: 'createSprint',
element: getAnchorElement(),
});
controller.closeHint('openBoard');

expect(mock).not.toHaveBeenCalled();
});
});

describe('closeHintByUser event', () => {
it('pass step -> trigger event', async function () {
const controller = new Controller(getOptions());

const mock = jest.fn();
controller.events.subscribe('closeHintByUser', mock);

await controller.stepElementReached({
stepSlug: 'createSprint',
element: getAnchorElement(),
});
await controller.passStep('createSprint');

expect(mock).toHaveBeenCalledWith(
{
hint: {
preset: 'createProject',
step: {
slug: 'createSprint',
name: '',
description: '',
},
},
},
controller,
);
});

it('element disappeared -> NOT trigger event', async function () {
const controller = new Controller(getOptions());

const mock = jest.fn();
controller.events.subscribe('closeHintByUser', mock);

await controller.stepElementReached({
stepSlug: 'createSprint',
element: getAnchorElement(),
});
controller.stepElementDisappeared('createSprint');

expect(mock).not.toHaveBeenCalled();
});

it('user close hint -> trigger event', async function () {
const controller = new Controller(getOptions());

const mock = jest.fn();
controller.events.subscribe('closeHintByUser', mock);

await controller.stepElementReached({
stepSlug: 'createSprint',
element: getAnchorElement(),
});
controller.closeHintByUser('createSprint');

expect(mock).toHaveBeenCalledWith(
{
hint: {
preset: 'createProject',
step: {
slug: 'createSprint',
name: '',
description: '',
},
},
},
controller,
);
});

it('no open hint -> NOT trigger event', async function () {
const controller = new Controller(getOptions());

const mock = jest.fn();
controller.events.subscribe('closeHintByUser', mock);

controller.closeHintByUser();

expect(mock).not.toHaveBeenCalled();
});

it('try close other hint -> NOT trigger event', async function () {
const controller = new Controller(getOptions());

const mock = jest.fn();
controller.events.subscribe('closeHintByUser', mock);

await controller.stepElementReached({
stepSlug: 'createSprint',
element: getAnchorElement(),
});
controller.closeHintByUser('openBoard');

expect(mock).not.toHaveBeenCalled();
});
});

it('passStep', async function () {
const controller = new Controller(getOptions());

Expand Down
1 change: 1 addition & 0 deletions src/types.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,7 @@ export type EventsMap<
stateChange: {state: Controller<any, any, any>['state']};
hintDataChanged: {state: HintState<HintParams, Presets, Steps>};
closeHint: {hint: Pick<ShowHintParams<HintParams, Presets, Steps>, 'preset' | 'step'>};
closeHintByUser: {hint: Pick<ShowHintParams<HintParams, Presets, Steps>, 'preset' | 'step'>};
init: {};
wizardStateChanged: {wizardState: BaseState['wizardState']};
};
Expand Down

0 comments on commit 778dbe6

Please sign in to comment.