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

feat(docs&api&ts): Add new top-level section 'fields' #14243

Conversation

yusufkandemir
Copy link
Member

What kind of change does this PR introduce?

  • Feature
  • Documentation

Does this PR introduce a breaking change?

  • No

The PR fulfills these requirements:

  • It's submitted to the dev branch (or v[X] branch)

Other information:
Closes #11510, #13217

Depends on #14241 because QUploader isn't exposing the fields.

This adds a top-level property called "fields" to our JSON API system. I analyzed all components that have public instance fields and added JSON API content for them. The docs API cards now have a section called "fields" at the end if applicable. We are also generating the types for fields in the instance type interfaces, e.g. QUploader

@@ -152,5 +152,53 @@
}
}
}
},

"fields": {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we don't merge in #14241 as I suggested to avoid, these definitions need to be moved into scoped slots params

@rstoenescu rstoenescu merged commit b472fc1 into quasarframework:dev Sep 14, 2022
@rstoenescu
Copy link
Member

Excellent work @yusufkandemir !
Will make a few changes and push them today. I'm aware this PR depends on the QUploader one. Will try to make some tweaks to that one as well.

rstoenescu added a commit that referenced this pull request Sep 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

The prop 'hasError' generates a TS error, types that are generated based on the docs are incorrect
3 participants