onSurveyInstanceCreated API doc - Update options.reason values, add a code sample

surveyjs / survey-creator

Scalable open-source survey software to generate dynamic JSON-driven forms within your JavaScript application. The form builder features a drag-and-drop UI, CSS Theme Editor, and GUI for conditional logic and form branching.

https://surveyjs.io/open-source

Other

896 stars 370 forks source link

onSurveyInstanceCreated API doc - Update options.reason values, add a code sample #4172

Open JaneSjs opened 1 year ago

JaneSjs commented 1 year ago

Suggestions:

[ ] Clarify possible values for the options.reason parameter https://github.com/surveyjs/survey-creator/blob/69ee8412c01e157419e00a0a3758b668971e2183/packages/survey-creator-core/src/creator-base.ts#L402

options.reason === 'logic-items' is for Logic tab

[ ] Add a code snippet showing how to access a previewed survey

creator.onSurveyInstanceCreated.add((sender, options) => {
if (options.reason === "test") {
  let survey = options.survey;
  ...
}
});

RomanTsukanov commented 1 year ago

Survey Creator has many events that include options.reason. We need to sort out options.reason values in all of them. We're going to do it in the process of overall API review. Moving this to backlog.