You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Firstly, thank you, react-awesome-query-builder developers, for your product. It is allowing us to build queries awesomely in our work (and allow our users to build awesome queries). However, I think you really need to improve the documentation when it comes to the query-builder-container and query-builder classes.
This is what the existing documentation is:
<Builder />
Render this component only inside Query.renderBuilder() like in example above:
Wrapping <Builder /> in div.query-builder is necessary.
Optionally you can add class .qb-lite to it for showing action buttons (like delete rule/group, add, etc.) only on hover, which will look cleaner.
Wrapping in div.query-builder-container is necessary if you put query builder inside scrollable block.
My feature request is to add notes explaining that these classes are necessary for the "Reordering (drag-n-drop) support for rules and groups of rules" behavior of react-awesome-query-builder.
Why do I think this feature request is necessary? The issue here is that developers can remove query-builder-container and query-builder, from their renderBuilder method, find that people can build queries fine, combining them using "AND", "OR" and "NOT", with no obvious issues. Then they discover a month later that dragging and dropping is broken, no-one knows why, and there's nothing in the docs to indicate the reason. And in case you are wondering, this is exactly what happened to our team.
Yes, we diagnosed the problem, by the tried-and-true method of "doing a search of commits to find the commit which broke things; then doing a search of files in that commit to find the file that broke things; then doing a search of lines in that file to find the line that broke things". It's not something terribly pleasant, and I'd rather spare other people the stress. So please, add some extra documentation to these classes, so that everyone can be happy, and nobody has to go though the pain we did.
The text was updated successfully, but these errors were encountered:
Firstly, thank you, react-awesome-query-builder developers, for your product. It is allowing us to build queries awesomely in our work (and allow our users to build awesome queries). However, I think you really need to improve the documentation when it comes to the
query-builder-container
andquery-builder
classes.This is what the existing documentation is:
My feature request is to add notes explaining that these classes are necessary for the "Reordering (drag-n-drop) support for rules and groups of rules" behavior of react-awesome-query-builder.
Why do I think this feature request is necessary? The issue here is that developers can remove
query-builder-container
andquery-builder
, from theirrenderBuilder
method, find that people can build queries fine, combining them using "AND", "OR" and "NOT", with no obvious issues. Then they discover a month later that dragging and dropping is broken, no-one knows why, and there's nothing in the docs to indicate the reason. And in case you are wondering, this is exactly what happened to our team.Yes, we diagnosed the problem, by the tried-and-true method of "doing a search of commits to find the commit which broke things; then doing a search of files in that commit to find the file that broke things; then doing a search of lines in that file to find the line that broke things". It's not something terribly pleasant, and I'd rather spare other people the stress. So please, add some extra documentation to these classes, so that everyone can be happy, and nobody has to go though the pain we did.
The text was updated successfully, but these errors were encountered: