silx-kit / h5web

React components for data visualization and exploration
https://h5web.panosc.eu/
MIT License
167 stars 17 forks source link

Please update documentation for H5Provider - axiosConfig vs axiosParams #1526

Closed vedina closed 7 months ago

vedina commented 7 months ago

Describe the bug

According to June 15, 2022 commit H5GroveProvider no more accepts axiosParams , but the documentation is not updated

To Reproduce

Go to https://github.com/silx-kit/h5web/blob/main/packages/app/README.md

<H5GroveProvider
  url="https://h5grove.server.url"
  filepath="some-file.h5"
  axiosParams={{ file: 'some-file.h5' }}
>
  <App />
</H5GroveProvider>

The demo app is indeed up-to-date

<H5GroveProvider
      url={URL}
      filepath={filepath}
      axiosConfig={{ params: { file: filepath } }}
    >
      <App sidebarOpen={!query.has('wide')} getFeedbackURL={getFeedbackURL} />
    </H5GroveProvider>
axelboc commented 7 months ago

Thanks for the report!