File size: 1,774 Bytes
1e92f2d |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 |
# DocumentHead
`<DocumentHead />` is a React component used in assigning a title, unread count, link, or meta to the global application state. It also sets `document.title` on the client, based on those parameters.
## Usage
Render the component, passing `title`, `skipTitleFormatting`, `unreadCount`, `link` or `meta`. It does not accept any children, nor does it render any elements to the page.
```jsx
import DocumentHead from 'calypso/components/data/document-head';
export default function HomeSection() {
const count = 123;
const metas = [ { rel: 'some-rel', content: 'some-content' } ];
const links = [ { href: 'https://automattic.com', rel: 'some-rel' } ];
return (
<main>
<DocumentHead title="Home" link={ links } meta={ metas } unreadCount={ count } />
</main>
);
}
```
## Props
### `title`
The window title will be formatted using the `title` property plus some other internal application state (like the application name, or the number of unread messages). Pass `skipTitleFormatting=true` if you want to set the window title without any extra formatting.
<table>
<tr><th>Type</th><td>String</td></tr>
<tr><th>Required</th><td>No</td></tr>
<tr><th>Default</th><td>""</td></tr>
</table>
### `skipTitleFormatting`
<table>
<tr><th>Type</th><td>Boolean</td></tr>
<tr><th>Required</th><td>No</td></tr>
<tr><th>Default</th><td>false</td></tr>
</table>
### `unreadCount`
<table>
<tr><th>Type</th><td>Number</td></tr>
<tr><th>Required</th><td>No</td></tr>
<tr><th>Default</th><td>0</td></tr>
</table>
### `meta`
<table>
<tr><th>Type</th><td>Array of objects</td></tr>
<tr><th>Required</th><td>No</td></tr>
</table>
### `link`
<table>
<tr><th>Type</th><td>Array of objects</td></tr>
<tr><th>Required</th><td>No</td></tr>
</table>
|