blob: e323abccef117f01e1d77d44f62814a8d603e9dd (
plain)
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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
|
# Components
## Injection
Plugins can inject components by registering React components to some roles.
#### Register a components
During the initialization phase of your plugin, dispatch the `GitBook.registerComponent` action:
```js
dispatch(GitBook.registerComponent(MyCustomButton, { role: 'toolbar:buttons:left' }));
```
#### Roles
Custom roles can be use for interopability with other plugins, but GitBook and the default theme set a convention for common roles:
| Role | Description | Props |
| ---- | ----------- | ----- |
| `page:container` | DIV container for the page's content | `{ page: Page }` |
| `summary:container` | DIV container for the whole summary | `{ summary: Summary }` |
| `summary:parts` | DIV container for summary's parts | `{ parts: List<SummaryPart> }` |
| `summary:part` | DIV for a specific part | `{ part: SummaryPart }` |
| `summary:articles` | UL container for a part's articles | `{ articles: List<SummaryArticle> }` |
| `summary:article` | LI for a specific article | `{ article: SummaryArticle }` |
## Default Components
#### `GitBook.Head`
Extends the meta tags of the page. This is an alias for [react-helmet](https://github.com/nfl/react-helmet).
```js
<GitBook.Head
title="My page"
/>
```
#### `GitBook.ImportCSS`
Import a CSS file by resolving the path correctly according to the current page:
```js
<GitBook.ImportCSS href="myfile.css" />
```
#### `GitBook.ImportJS`
Import a JS file by resolving the path correctly according to the current page:
```js
<GitBook.ImportJS src="mylib.js" />
```
#### `GitBook.InjectedComponent`
Inject a component matching a specific role:
```js
<GitBook.InjectedComponent matching={{ role: 'mycustomrole' }} props={{ someProp: 1 }}>
<b>Inner content</b>
</GitBook.InjectedComponent>
```
#### `GitBook.InjectedComponentSet`
Same API as `InjectedComponentSet` but render the matching components in chain instead of composed:
```js
<GitBook.InjectedComponentSet matching={{ role: 'mytoolbar' }} />
```
**Warning:** Children are discarded.
#### `GitBook.FlexLayout` and `GitBook.FlexBox`
A simple wrapper that provides a Flexbox layout with the given direction and style. Any additional props you set on the Flexbox are rendered.
```js
<GitBook.FlexLayout column>
<GitBook.FlexBox>First column</GitBook.FlexBox>
<GitBook.FlexBox>Second column</GitBook.FlexBox>
</GitBook.FlexLayout>
```
|
