Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add survey.onDynamicPanelCurrentIndexChanged event fix #7513 #7514

Merged
merged 2 commits into from
Dec 19, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/base-interfaces.ts
Original file line number Diff line number Diff line change
Expand Up @@ -219,6 +219,7 @@ export interface ISurvey extends ITextProcessor, ISurveyErrorOwner {
dynamicPanelRemoving(question: IQuestion, panelIndex: number, panel: IPanel): boolean;
dynamicPanelItemValueChanged(question: IQuestion, options: any): any;
dynamicPanelGetTabTitle(question: IQuestion, options: any): any;
dynamicPanelCurrentIndexChanged(question: IQuestion, options: any): void;

dragAndDropAllow(options: DragDropAllowEvent): boolean;

Expand Down
10 changes: 9 additions & 1 deletion src/question_paneldynamic.ts
Original file line number Diff line number Diff line change
Expand Up @@ -555,14 +555,22 @@ export class QuestionPanelDynamicModel extends Question
public set currentPanel(val: PanelModel) {
if(this.isRenderModeList || this.useTemplatePanel) return;
const curPanel = this.getPropertyValue("currentPanel");
if(!!val && this.visiblePanels.indexOf(val) < 0 || val === curPanel) return;
const index = !!val ? this.visiblePanels.indexOf(val) : -1;
if(!!val && index < 0 || val === curPanel) return;
if(curPanel) {
curPanel.onHidingContent();
}
this.setPropertyValue("currentPanel", val);
this.updateFooterActions();
this.updateTabToolbarItemsPressedState();
this.fireCallback(this.currentIndexChangedCallback);
if(index > -1 && this.survey) {
const options = {
panel: val,
visiblePanelIndex: index
};
this.survey.dynamicPanelCurrentIndexChanged(this, options);
}
}
public onHidingContent(): void {
super.onHidingContent();
Expand Down
6 changes: 4 additions & 2 deletions src/survey-events-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -810,15 +810,17 @@ export interface DynamicPanelItemValueChangedEvent extends PanelDynamicQuestionE
*/
panel: PanelModel;
}
export interface DynamicPanelGetTabTitleEvent extends PanelDynamicQuestionEventMixin {
export interface DynamicPanelCurrentIndexChangedEvent extends PanelDynamicQuestionEventMixin {
/**
* A panel whose tab title is being rendered.
* A panel for which the event is raised.
*/
panel: PanelModel;
/**
* The panel's index in the [`visiblePanels`](https://surveyjs.io/form-library/documentation/api-reference/dynamic-panel-model#visiblePanels) array of the Dynamic Panel.
*/
visiblePanelIndex: number;
}
export interface DynamicPanelGetTabTitleEvent extends DynamicPanelCurrentIndexChangedEvent {
/**
* A tab title. You can change this parameter's value.
*/
Expand Down
15 changes: 12 additions & 3 deletions src/survey.ts
Original file line number Diff line number Diff line change
Expand Up @@ -61,9 +61,9 @@ import {
ShowingChoiceItemEvent, ChoicesLazyLoadEvent, GetChoiceDisplayValueEvent, MatrixRowAddedEvent, MatrixBeforeRowAddedEvent, MatrixRowRemovingEvent, MatrixRowRemovedEvent,
MatrixAllowRemoveRowEvent, MatrixCellCreatingEvent, MatrixCellCreatedEvent, MatrixAfterCellRenderEvent, MatrixCellValueChangedEvent, MatrixCellValueChangingEvent,
MatrixCellValidateEvent, DynamicPanelModifiedEvent, DynamicPanelRemovingEvent, TimerPanelInfoTextEvent, DynamicPanelItemValueChangedEvent, DynamicPanelGetTabTitleEvent,
IsAnswerCorrectEvent, DragDropAllowEvent, ScrollingElementToTopEvent, GetQuestionTitleActionsEvent, GetPanelTitleActionsEvent, GetPageTitleActionsEvent,
GetPanelFooterActionsEvent, GetMatrixRowActionsEvent, ElementContentVisibilityChangedEvent, GetExpressionDisplayValueEvent, ServerValidateQuestionsEvent,
MultipleTextItemAddedEvent, MatrixColumnAddedEvent, GetQuestionDisplayValueEvent, PopupVisibleChangedEvent
DynamicPanelCurrentIndexChangedEvent, IsAnswerCorrectEvent, DragDropAllowEvent, ScrollingElementToTopEvent, GetQuestionTitleActionsEvent, GetPanelTitleActionsEvent,
GetPageTitleActionsEvent, GetPanelFooterActionsEvent, GetMatrixRowActionsEvent, ElementContentVisibilityChangedEvent, GetExpressionDisplayValueEvent,
ServerValidateQuestionsEvent, MultipleTextItemAddedEvent, MatrixColumnAddedEvent, GetQuestionDisplayValueEvent, PopupVisibleChangedEvent
} from "./survey-events-api";
import { QuestionMatrixDropdownModelBase } from "./question_matrixdropdownbase";
import { QuestionMatrixDynamicModel } from "./question_matrixdynamic";
Expand Down Expand Up @@ -745,6 +745,11 @@ export class SurveyModel extends SurveyElementCore
*/
public onGetDynamicPanelTabTitle: EventBase<SurveyModel, DynamicPanelGetTabTitleEvent> = this.addEvent<SurveyModel, DynamicPanelGetTabTitleEvent>();

/**
* An event that is raised after the current panel is changed in a [Dynamic Panel](https://surveyjs.io/form-library/examples/questiontype-paneldynamic/) question.
*/
public onDynamicPanelCurrentIndexChanged: EventBase<SurveyModel, DynamicPanelCurrentIndexChangedEvent> = this.addEvent<SurveyModel, DynamicPanelCurrentIndexChangedEvent>();

/**
* An event that is raised to define whether a question answer is correct. Applies only to [quiz surveys](https://surveyjs.io/form-library/documentation/design-survey/create-a-quiz).
*/
Expand Down Expand Up @@ -4929,6 +4934,10 @@ export class SurveyModel extends SurveyElementCore
options.question = question;
this.onGetDynamicPanelTabTitle.fire(this, options);
}
dynamicPanelCurrentIndexChanged(question: IQuestion, options: any): void {
options.question = question;
this.onDynamicPanelCurrentIndexChanged.fire(this, options);
}
dragAndDropAllow(options: DragDropAllowEvent): boolean {
this.onDragDropAllow.fire(this, options);
return options.allow;
Expand Down
38 changes: 38 additions & 0 deletions tests/question_paneldynamic_tests.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5889,6 +5889,44 @@ QUnit.test("templateVisibleIf && currentPanelIndex", function (assert) {
assert.equal(panel.visiblePanelCount, 1, "There is one panel");
assert.equal(panel.currentIndex, 0, "currentIndex #8");
});
QUnit.test("survey.onDynamicPanelCurrentIndexChanged", function (assert) {
const survey = new SurveyModel();
let questionName = "";
let panelIndex = -2;
let panelIndexOf = -2;
survey.onDynamicPanelCurrentIndexChanged.add((_, options) => {
questionName = options.question.name;
panelIndex = options.visiblePanelIndex;
panelIndexOf = !!options.panel ? options.question.visiblePanels.indexOf(options.panel) : -1;
});
survey.fromJSON({
elements: [
{ type: "paneldynamic",
name: "panel",
templateElements: [
{ type: "text", name: "q1" },
{ type: "text", name: "q2" }
],
panelCount: 3,
renderMode: "tab"
}],
});
assert.equal(questionName, "panel", "question is correct");
assert.equal(panelIndex, 0, "panelIndex #1");
assert.equal(panelIndexOf, 0, "panelIndexOf #1");
const panel = <QuestionPanelDynamicModel>survey.getQuestionByName("panel");
panel.currentIndex = 1;
assert.equal(panelIndex, 1, "panelIndex #2");
assert.equal(panelIndexOf, 1, "panelIndexOf #2");
panel.addPanel();
assert.equal(panel.currentIndex, 3, "panel.panelIndex #3");
assert.equal(panelIndex, 3, "panelIndex #3");
assert.equal(panelIndexOf, 3, "panelIndexOf #3");
panel.removePanel(3);
assert.equal(panel.currentIndex, 2, "panel.panelIndex #4");
assert.equal(panelIndex, 2, "panelIndex #4");
assert.equal(panelIndexOf, 2, "panelIndexOf #4");
});
QUnit.test("templateVisibleIf & renderMode: tab, additionalTitleToolbar&templateTabTitle in JSON", function (assert) {
const survey = new SurveyModel({
elements: [
Expand Down