mirror of
https://github.com/facebook/docusaurus.git
synced 2025-08-04 01:09:20 +02:00
feat(v2): add useBaseUrlUtils() hook (#3033)
* add useBaseUrlUtils * fix code highlighted lines
This commit is contained in:
parent
e5afd1866d
commit
a8b2e59a48
3 changed files with 105 additions and 10 deletions
|
@ -169,7 +169,7 @@ type BaseUrlOptions = {
|
|||
Example usage:
|
||||
|
||||
```jsx {3,11}
|
||||
import React, {useEffect} from 'react';
|
||||
import React from 'react';
|
||||
import Link from '@docusaurus/Link';
|
||||
import useBaseUrl from '@docusaurus/useBaseUrl';
|
||||
|
||||
|
@ -186,6 +186,24 @@ function Help() {
|
|||
}
|
||||
```
|
||||
|
||||
### `useBaseUrlUtils`
|
||||
|
||||
Sometimes `useBaseUrl` is not good enough. This hook return additional utils related to your site's base url.
|
||||
|
||||
- `withBaseUrl`: useful if you need to add base urls to multiple urls at once
|
||||
|
||||
```jsx {2,5,6,7}
|
||||
import React from 'react';
|
||||
import {useBaseUrlUtils} from '@docusaurus/useBaseUrl';
|
||||
|
||||
function Component() {
|
||||
const urls = ['/a', '/b'];
|
||||
const {withBaseUrl} = useBaseUrlUtils();
|
||||
const urlsWithBaseUrl = urls.map(withBaseUrl);
|
||||
return <div className="col">{/* ... */}</div>;
|
||||
}
|
||||
```
|
||||
|
||||
## Modules
|
||||
|
||||
### `ExecutionEnvironment`
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue