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

There's no way to document the props of the <popup-survey> element #8712

Open
RomanTsukanov opened this issue Aug 20, 2024 · 0 comments
Open

Comments

@RomanTsukanov
Copy link
Contributor

Currently, we document the properties of the PopupSurveyModel class:

https://surveyjs.io/form-library/documentation/api-reference/pop-up-survey-model

In React, Angular, and Vue, a pop-up survey is configured using component props, which do not exactly map to the class properties. As of now, there's no technical capability to document these props.

What can we do:

Option 1: Ditch the props, configure pop-up surveys using a PopupSurveyModel instance created explicitly:

import { PopupSurveyModel } from "survey-core";

const popupSurvey = new PopupSurveyModel({ ... });
return (
  <PopupSurvey model={popupSurvey} />
)

Option 2: Create an interface that would describe component props and document it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant