feat(@mongodb-js/compass-query-bar): Add props to toggle visibility of "query history" and "export to language" buttons CLOUDP-96456 #2374
Conversation
…ton and showExportToLanguageButton props so that the user of the component can choose to show or hide these buttons. Update the tests to make sure these props work
…ss plugins locally
README.md
Outdated
|
|
||
| - `npm run compile-changed` will compile all plugins and their dependants changed since `origin/HEAD` | ||
| - `npm run test-changed` will run tests in all packages and their dependants changed since `origin/HEAD` | ||
| - `npm run test-changed` will run tests in all packages and their dependants changed since `origin/HEAD`. To run all tests in one plugin that you are working on such as the `compass-connect` plugin, you can run `npm run test` from the top of the `compass/packages/compass-connect` directory. |
There was a problem hiding this comment.
How about we move this additional note to the section above where all the instructions for different way of running a script already present?
gribnoysup
changed the title
Update README.md to have more concise directions for running compass locally Co-authored-by: Sergey <sergey.petushkov@protonmail.com>
Rework a paragraph to create a better organization of the documentation as the comment suggested.
| store={store} | ||
| actions={actions} | ||
| layout={layout} | ||
| showQueryHistoryButton |
There was a problem hiding this comment.
If this is false by default do we also need to enable it where is used in Compass?
There was a problem hiding this comment.
I think it's true by default (see previous test and defaultProps in the component), so this test is just a bit redundant (also a bit confusing because of that 😅 )
There was a problem hiding this comment.
@mcasimir Sorry I missed your comment earlier. showQueryHistoryButton and showExportToLanguageButton props are true by default as @gribnoysup commented. I did that so that I would not change the appearance of the compass query bar out of the box, but that we would also have the option to disable it when we want to. The redundant test you are referring to is present just make sure that those buttons are present when these two props are not explicitly set. I am happy to remove them if you think that would be better.
There was a problem hiding this comment.
I think even thought it's a bit redundant, it's okay to keep it there 😊
4 participants
Description
In this PR, two props (
showQueryHistoryButtonandshowExportToLanguageButton) were added to enable hiding the two respective buttons from the compass-query-bar as it is being used. Also, documentation was updated to make it more clear how to run the compass application after cloning the repository.Checklist
Motivation and Context
The data explorer feature in the MongoDB DataExplorerFindView is starting to use the compass-query-bar plugin instead of the previous regular html input element for users to input their queries so as to support more options for queries. Currently, we are not supporting the query history and export to language features that are present in the compass-query-bar. As a result, we wanted to disable and hide the two buttons corresponding to these features from the compass-query-bar as we use it. This PR does exactly that.
Open Questions
Dependents
Types of changes