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.

Sign up for GitHub

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

Fix outdated documentation of H5GroveProvider #1527

Merged
merged 1 commit into from
Nov 24, 2023
Merged

Fix outdated documentation of H5GroveProvider #1527

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions packages/app/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ Data provider for [H5Grove](https://github.com/silx-kit/h5grove).
<H5GroveProvider
url="https://h5grove.server.url"
filepath="some-file.h5"
axiosParams={{ file: 'some-file.h5' }}
axiosConfig={{ params: { file: 'some-file.h5' } }}
>
<App />
</H5GroveProvider>
Expand All @@ -201,12 +201,15 @@ The base URL of the H5Grove server.

The path and/or name of the file to display in the UI.

#### `axiosParams?: Record<string, string>` (optional)
#### `axiosConfig?: AxiosRequestConfig` (optional)

By default, `H5GroveProvider` does not make any assumption as to which query
parameters to send to the server. If you use one of H5Grove's default API
implementations, then you'll need to use this prop to pass the `file` query
parameter as shown above.
By default, `H5GroveProvider` does not make any assumption as to how to
configure its internal [axios](https://axios-http.com/docs/req_config) client.
If you use one of H5Grove's default API implementations, then you'll need to use
this prop to pass the `file` query parameter as shown above.

If your API server requires authentication or is on a different domain, you'll
need to pass the necessary request headers and configuration as well.

#### `getExportURL?: (...args) => URL | (() => Promise<URL | Blob>) | undefined` (optional)

Expand Down