-
-
Notifications
You must be signed in to change notification settings - Fork 31.7k
/
MarkdownDocs.js
245 lines (227 loc) · 8.12 KB
/
MarkdownDocs.js
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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
import * as React from 'react';
import * as PropTypes from 'prop-types';
import clsx from 'clsx';
import { useSelector } from 'react-redux';
import { withStyles } from '@material-ui/core/styles';
import ChevronRightIcon from '@material-ui/icons/ChevronRight';
import ChevronLeftIcon from '@material-ui/icons/ChevronLeft';
import Button from '@material-ui/core/Button';
import Divider from '@material-ui/core/Divider';
import Head from 'docs/src/modules/components/Head';
import AppFrame from 'docs/src/modules/components/AppFrame';
import EditPage from 'docs/src/modules/components/EditPage';
import AppContainer from 'docs/src/modules/components/AppContainer';
import PageContext from 'docs/src/modules/components/PageContext';
import { pageToTitleI18n } from 'docs/src/modules/utils/helpers';
import Link from 'docs/src/modules/components/Link';
import { exactProp } from '@material-ui/utils';
import { SOURCE_CODE_ROOT_URL } from 'docs/src/modules/constants';
import Demo from 'docs/src/modules/components/Demo';
import AppTableOfContents from 'docs/src/modules/components/AppTableOfContents';
import MarkdownElement from 'docs/src/modules/components/MarkdownElement';
import Ad from 'docs/src/modules/components/Ad';
import AdManager from 'docs/src/modules/components/AdManager';
import AdGuest from 'docs/src/modules/components/AdGuest';
import ComponentLinkHeader from 'docs/src/modules/components/ComponentLinkHeader';
const markdownComponents = {
'modules/components/ComponentLinkHeader.js': ComponentLinkHeader,
};
function flattenPages(pages, current = []) {
return pages.reduce((items, item) => {
if (item.children && item.children.length > 1) {
items = flattenPages(item.children, items);
} else {
items.push(item.children && item.children.length === 1 ? item.children[0] : item);
}
return items;
}, current);
}
// To replace with .findIndex() once we stop IE 11 support.
function findIndex(array, comp) {
for (let i = 0; i < array.length; i += 1) {
if (comp(array[i])) {
return i;
}
}
return -1;
}
const styles = (theme) => ({
root: {
width: '100%',
},
container: {
position: 'relative',
},
actions: {
position: 'absolute',
right: 16,
display: 'flex',
flexDirection: 'column',
alignItems: 'flex-end',
},
ad: {
'& .description': {
marginBottom: 198,
},
'& .description.ad': {
marginBottom: 40,
},
},
toc: {
[theme.breakpoints.up('sm')]: {
width: 'calc(100% - 175px)',
},
[theme.breakpoints.up('lg')]: {
width: 'calc(100% - 175px - 240px)',
},
},
footer: {
marginTop: theme.spacing(12),
},
pagination: {
margin: theme.spacing(3, 0, 4),
display: 'flex',
justifyContent: 'space-between',
},
pageLinkButton: {
textTransform: 'none',
fontWeight: theme.typography.fontWeightRegular,
},
});
function MarkdownDocs(props) {
const { classes, disableAd = false, disableToc = false, demos = {}, docs, requireDemo } = props;
const t = useSelector((state) => state.options.t);
const userLanguage = useSelector((state) => state.options.userLanguage);
const { description, location, rendered, title, toc, headers } = docs[userLanguage] || docs.en;
if (description === undefined) {
throw new Error('Missing description in the page');
}
const { activePage, pages } = React.useContext(PageContext);
const pageList = flattenPages(pages);
const currentPageNum = findIndex(pageList, (page) => page.pathname === activePage?.pathname);
const currentPage = pageList[currentPageNum];
const prevPage = pageList[currentPageNum - 1];
const nextPage = pageList[currentPageNum + 1];
return (
<AppFrame>
<AdManager>
<Head title={`${title} - Material-UI`} description={description} />
{disableAd ? null : (
<AdGuest>
<Ad placement="body" />
</AdGuest>
)}
<div
className={clsx(classes.root, {
[classes.ad]: !disableAd,
[classes.toc]: !disableToc,
})}
>
<AppContainer className={classes.container}>
<div className={classes.actions}>
<EditPage markdownLocation={location} />
</div>
{rendered.map((renderedMarkdownOrDemo, index) => {
if (typeof renderedMarkdownOrDemo === 'string') {
return <MarkdownElement key={index} renderedMarkdown={renderedMarkdownOrDemo} />;
}
if (renderedMarkdownOrDemo.component) {
const Component = markdownComponents[renderedMarkdownOrDemo.component];
return <Component key={index} headers={headers} options={renderedMarkdownOrDemo} />;
}
const name = renderedMarkdownOrDemo.demo;
const demo = demos?.[name];
if (demo === undefined) {
const errorMessage = [
`Missing demo: ${name}. You can use one of the following:`,
Object.keys(demos),
].join('\n');
if (userLanguage === 'en') {
throw new Error(errorMessage);
}
if (process.env.NODE_ENV !== 'production') {
console.error(errorMessage);
}
const warnIcon = (
<span role="img" aria-label={t('emojiWarning')}>
⚠️
</span>
);
return (
<div key={index}>
{/* eslint-disable-next-line material-ui/no-hardcoded-labels */}
{warnIcon} Missing demo `{name}` {warnIcon}
</div>
);
}
return (
<Demo
key={index}
demo={{
raw: demo.raw,
js: requireDemo(demo.module).default,
rawTS: demo.rawTS,
tsx: demo.moduleTS ? requireDemo(demo.moduleTS).default : null,
}}
disableAd={disableAd}
demoOptions={renderedMarkdownOrDemo}
githubLocation={`${SOURCE_CODE_ROOT_URL}/docs/src/${name}`}
/>
);
})}
<footer className={classes.footer}>
{!currentPage ||
currentPage.displayNav === false ||
(nextPage.displayNav === false && !prevPage) ? null : (
<React.Fragment>
<Divider />
<div className={classes.pagination}>
{prevPage ? (
<Button
component={Link}
naked
href={prevPage.pathname}
size="large"
className={classes.pageLinkButton}
startIcon={<ChevronLeftIcon />}
>
{pageToTitleI18n(prevPage, t)}
</Button>
) : (
<div />
)}
{nextPage.displayNav === false ? null : (
<Button
component={Link}
naked
href={nextPage.pathname}
size="large"
className={classes.pageLinkButton}
endIcon={<ChevronRightIcon />}
>
{pageToTitleI18n(nextPage, t)}
</Button>
)}
</div>
</React.Fragment>
)}
</footer>
</AppContainer>
</div>
{disableToc ? null : <AppTableOfContents items={toc} />}
</AdManager>
</AppFrame>
);
}
MarkdownDocs.propTypes = {
classes: PropTypes.object.isRequired,
demos: PropTypes.object,
disableAd: PropTypes.bool,
disableToc: PropTypes.bool,
docs: PropTypes.object.isRequired,
requireDemo: PropTypes.func,
};
if (process.env.NODE_ENV !== 'production') {
MarkdownDocs.propTypes = exactProp(MarkdownDocs.propTypes);
}
export default withStyles(styles)(MarkdownDocs);