docusaurus-theme-openapi-docs 1.0.3 → 1.0.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/theme/ApiDemoPanel/Body/index.js +11 -9
- package/lib/theme/ApiDemoPanel/Body/json2xml.js +43 -0
- package/lib/theme/ApiDemoPanel/CodeTabs/index.js +188 -0
- package/lib/theme/ApiDemoPanel/CodeTabs/styles.module.css +11 -0
- package/lib/theme/ApiDemoPanel/Curl/index.js +41 -110
- package/lib/theme/ApiDemoPanel/LiveEditor/index.js +61 -0
- package/lib/theme/ApiDemoPanel/LiveEditor/styles.module.css +34 -0
- package/lib/theme/ApiItem/icons/bash-original.svg +1 -0
- package/lib/theme/ApiItem/icons/go-original-wordmark.svg +1 -0
- package/lib/theme/ApiItem/icons/javascript-original.svg +1 -0
- package/lib/theme/ApiItem/icons/linux-original.svg +1 -0
- package/lib/theme/ApiItem/icons/python-original.svg +1 -0
- package/lib/theme/ApiItem/styles.module.css +89 -0
- package/lib-next/theme/ApiDemoPanel/Body/index.js +11 -15
- package/lib-next/theme/ApiDemoPanel/Body/json2xml.js +43 -0
- package/lib-next/theme/ApiDemoPanel/CodeTabs/index.js +214 -0
- package/lib-next/theme/ApiDemoPanel/CodeTabs/styles.module.css +11 -0
- package/lib-next/theme/ApiDemoPanel/Curl/index.js +46 -135
- package/lib-next/theme/ApiDemoPanel/LiveEditor/index.js +49 -0
- package/lib-next/theme/ApiDemoPanel/LiveEditor/styles.module.css +34 -0
- package/lib-next/theme/ApiItem/icons/bash-original.svg +1 -0
- package/lib-next/theme/ApiItem/icons/go-original-wordmark.svg +1 -0
- package/lib-next/theme/ApiItem/icons/javascript-original.svg +1 -0
- package/lib-next/theme/ApiItem/icons/linux-original.svg +1 -0
- package/lib-next/theme/ApiItem/icons/python-original.svg +1 -0
- package/lib-next/theme/ApiItem/styles.module.css +89 -0
- package/package.json +4 -6
- package/src/theme/ApiDemoPanel/Body/index.tsx +9 -13
- package/src/theme/ApiDemoPanel/Body/json2xml.js +43 -0
- package/src/theme/ApiDemoPanel/CodeTabs/index.tsx +237 -0
- package/src/theme/ApiDemoPanel/CodeTabs/styles.module.css +11 -0
- package/src/theme/ApiDemoPanel/Curl/index.tsx +45 -124
- package/src/theme/ApiDemoPanel/LiveEditor/index.tsx +59 -0
- package/src/theme/ApiDemoPanel/LiveEditor/styles.module.css +34 -0
- package/src/theme/ApiItem/icons/bash-original.svg +1 -0
- package/src/theme/ApiItem/icons/go-original-wordmark.svg +1 -0
- package/src/theme/ApiItem/icons/javascript-original.svg +1 -0
- package/src/theme/ApiItem/icons/linux-original.svg +1 -0
- package/src/theme/ApiItem/icons/python-original.svg +1 -0
- package/src/theme/ApiItem/styles.module.css +89 -0
- package/lib/theme/ApiDemoPanel/VSCode/index.js +0 -252
- package/lib/theme/ApiDemoPanel/VSCode/styles.module.css +0 -19
- package/lib-next/theme/ApiDemoPanel/VSCode/index.js +0 -265
- package/lib-next/theme/ApiDemoPanel/VSCode/styles.module.css +0 -19
- package/src/theme/ApiDemoPanel/VSCode/index.tsx +0 -205
- package/src/theme/ApiDemoPanel/VSCode/styles.module.css +0 -19
|
@@ -8,17 +8,18 @@ import React from "react";
|
|
|
8
8
|
import ContentType from "../ContentType";
|
|
9
9
|
import FormSelect from "../FormSelect";
|
|
10
10
|
import { useTypedDispatch, useTypedSelector } from "../hooks";
|
|
11
|
+
import LiveApp from "../LiveEditor";
|
|
11
12
|
import FormFileUpload from "./../FormFileUpload";
|
|
12
13
|
import FormItem from "./../FormItem";
|
|
13
|
-
import FormTextInput from "./../FormTextInput";
|
|
14
|
-
|
|
14
|
+
import FormTextInput from "./../FormTextInput"; // @ts-ignore
|
|
15
|
+
|
|
16
|
+
import json2xml from "./json2xml";
|
|
15
17
|
import {
|
|
16
18
|
clearFormBodyKey,
|
|
17
19
|
clearRawBody,
|
|
18
20
|
setFileFormBody,
|
|
19
21
|
setFileRawBody,
|
|
20
22
|
setStringFormBody,
|
|
21
|
-
setStringRawBody,
|
|
22
23
|
} from "./slice";
|
|
23
24
|
|
|
24
25
|
function BodyWrap({ requestBodyMetadata, jsonRequestBodyExample }) {
|
|
@@ -186,23 +187,18 @@ function Body({ requestBodyMetadata, jsonRequestBodyExample }) {
|
|
|
186
187
|
}
|
|
187
188
|
|
|
188
189
|
if (contentType === "application/xml") {
|
|
190
|
+
if (jsonRequestBodyExample) {
|
|
191
|
+
exampleBodyString = json2xml(jsonRequestBodyExample);
|
|
192
|
+
}
|
|
193
|
+
|
|
189
194
|
language = "xml";
|
|
190
195
|
}
|
|
191
196
|
|
|
192
197
|
return (
|
|
193
198
|
<FormItem label="Body">
|
|
194
|
-
<
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
onChange={(value) => {
|
|
198
|
-
if (value.trim() === "") {
|
|
199
|
-
dispatch(clearRawBody());
|
|
200
|
-
return;
|
|
201
|
-
}
|
|
202
|
-
|
|
203
|
-
dispatch(setStringRawBody(value));
|
|
204
|
-
}}
|
|
205
|
-
/>
|
|
199
|
+
<LiveApp action={dispatch} language={language}>
|
|
200
|
+
{exampleBodyString}
|
|
201
|
+
</LiveApp>
|
|
206
202
|
</FormItem>
|
|
207
203
|
);
|
|
208
204
|
}
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
/* ============================================================================
|
|
2
|
+
* Copyright (c) Palo Alto Networks
|
|
3
|
+
*
|
|
4
|
+
* This source code is licensed under the MIT license found in the
|
|
5
|
+
* LICENSE file in the root directory of this source tree.
|
|
6
|
+
* ========================================================================== */
|
|
7
|
+
|
|
8
|
+
export default function json2xml(o, tab) {
|
|
9
|
+
var toXml = function (v, name, ind) {
|
|
10
|
+
var xml = "";
|
|
11
|
+
if (v instanceof Array) {
|
|
12
|
+
for (var i = 0, n = v.length; i < n; i++)
|
|
13
|
+
xml += ind + toXml(v[i], name, ind + "\t") + "\n";
|
|
14
|
+
} else if (typeof v == "object") {
|
|
15
|
+
var hasChild = false;
|
|
16
|
+
xml += ind + "<" + name;
|
|
17
|
+
for (var m in v) {
|
|
18
|
+
if (m.charAt(0) === "@")
|
|
19
|
+
xml += " " + m.substr(1) + '="' + v[m].toString() + '"';
|
|
20
|
+
else hasChild = true;
|
|
21
|
+
}
|
|
22
|
+
xml += hasChild ? ">" : "/>";
|
|
23
|
+
if (hasChild) {
|
|
24
|
+
for (var m2 in v) {
|
|
25
|
+
if (m2 === "#text") xml += v[m2];
|
|
26
|
+
else if (m2 === "#cdata") xml += "<![CDATA[" + v[m2] + "]]>";
|
|
27
|
+
else if (m2.charAt(0) !== "@") xml += toXml(v[m2], m2, ind + "\t");
|
|
28
|
+
}
|
|
29
|
+
xml +=
|
|
30
|
+
(xml.charAt(xml.length - 1) === "\n" ? ind : "") +
|
|
31
|
+
"</" +
|
|
32
|
+
name +
|
|
33
|
+
">";
|
|
34
|
+
}
|
|
35
|
+
} else {
|
|
36
|
+
xml += ind + "<" + name + ">" + v.toString() + "</" + name + ">";
|
|
37
|
+
}
|
|
38
|
+
return xml;
|
|
39
|
+
},
|
|
40
|
+
xml = "";
|
|
41
|
+
for (var m3 in o) xml += toXml(o[m3], m3, "");
|
|
42
|
+
return tab ? xml.replace(/\t/g, tab) : xml.replace(/\t|\n/g, "");
|
|
43
|
+
}
|
|
@@ -0,0 +1,214 @@
|
|
|
1
|
+
/* ============================================================================
|
|
2
|
+
* Copyright (c) Palo Alto Networks
|
|
3
|
+
*
|
|
4
|
+
* This source code is licensed under the MIT license found in the
|
|
5
|
+
* LICENSE file in the root directory of this source tree.
|
|
6
|
+
* ========================================================================== */
|
|
7
|
+
import React, { useState, cloneElement, isValidElement } from "react";
|
|
8
|
+
import {
|
|
9
|
+
useScrollPositionBlocker,
|
|
10
|
+
duplicates,
|
|
11
|
+
useTabGroupChoice,
|
|
12
|
+
} from "@docusaurus/theme-common";
|
|
13
|
+
import useIsBrowser from "@docusaurus/useIsBrowser";
|
|
14
|
+
import clsx from "clsx";
|
|
15
|
+
import { languageSet } from "../Curl";
|
|
16
|
+
import styles from "./styles.module.css"; // A very rough duck type, but good enough to guard against mistakes while
|
|
17
|
+
// allowing customization
|
|
18
|
+
|
|
19
|
+
function isTabItem(comp) {
|
|
20
|
+
return "value" in comp.props;
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
function TabsComponent(props) {
|
|
24
|
+
const {
|
|
25
|
+
lazy,
|
|
26
|
+
block,
|
|
27
|
+
defaultValue: defaultValueProp,
|
|
28
|
+
values: valuesProp,
|
|
29
|
+
groupId,
|
|
30
|
+
className,
|
|
31
|
+
action,
|
|
32
|
+
} = props;
|
|
33
|
+
const children = React.Children.map(props.children, (child) => {
|
|
34
|
+
if (isValidElement(child) && isTabItem(child)) {
|
|
35
|
+
return child;
|
|
36
|
+
} // child.type.name will give non-sensical values in prod because of
|
|
37
|
+
// minification, but we assume it won't throw in prod.
|
|
38
|
+
|
|
39
|
+
throw new Error(
|
|
40
|
+
`Docusaurus error: Bad <Tabs> child <${
|
|
41
|
+
// @ts-expect-error: guarding against unexpected cases
|
|
42
|
+
typeof child.type === "string" ? child.type : child.type.name
|
|
43
|
+
}>: all children of the <Tabs> component should be <TabItem>, and every <TabItem> should have a unique "value" prop.`
|
|
44
|
+
);
|
|
45
|
+
});
|
|
46
|
+
const values =
|
|
47
|
+
valuesProp ?? // Only pick keys that we recognize. MDX would inject some keys by default
|
|
48
|
+
children.map(({ props: { value, label, attributes } }) => ({
|
|
49
|
+
value,
|
|
50
|
+
label,
|
|
51
|
+
attributes,
|
|
52
|
+
}));
|
|
53
|
+
const dup = duplicates(values, (a, b) => a.value === b.value);
|
|
54
|
+
|
|
55
|
+
if (dup.length > 0) {
|
|
56
|
+
throw new Error(
|
|
57
|
+
`Docusaurus error: Duplicate values "${dup
|
|
58
|
+
.map((a) => a.value)
|
|
59
|
+
.join(", ")}" found in <Tabs>. Every value needs to be unique.`
|
|
60
|
+
);
|
|
61
|
+
} // When defaultValueProp is null, don't show a default tab
|
|
62
|
+
|
|
63
|
+
const defaultValue =
|
|
64
|
+
defaultValueProp === null
|
|
65
|
+
? defaultValueProp
|
|
66
|
+
: defaultValueProp ??
|
|
67
|
+
children.find((child) => child.props.default)?.props.value ??
|
|
68
|
+
children[0].props.value;
|
|
69
|
+
|
|
70
|
+
if (defaultValue !== null && !values.some((a) => a.value === defaultValue)) {
|
|
71
|
+
throw new Error(
|
|
72
|
+
`Docusaurus error: The <Tabs> has a defaultValue "${defaultValue}" but none of its children has the corresponding value. Available values are: ${values
|
|
73
|
+
.map((a) => a.value)
|
|
74
|
+
.join(
|
|
75
|
+
", "
|
|
76
|
+
)}. If you intend to show no default tab, use defaultValue={null} instead.`
|
|
77
|
+
);
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
const { tabGroupChoices, setTabGroupChoices } = useTabGroupChoice();
|
|
81
|
+
const [selectedValue, setSelectedValue] = useState(defaultValue);
|
|
82
|
+
const tabRefs = [];
|
|
83
|
+
const { blockElementScrollPositionUntilNextRender } =
|
|
84
|
+
useScrollPositionBlocker();
|
|
85
|
+
|
|
86
|
+
if (groupId != null) {
|
|
87
|
+
const relevantTabGroupChoice = tabGroupChoices[groupId];
|
|
88
|
+
|
|
89
|
+
if (
|
|
90
|
+
relevantTabGroupChoice != null &&
|
|
91
|
+
relevantTabGroupChoice !== selectedValue &&
|
|
92
|
+
values.some((value) => value.value === relevantTabGroupChoice)
|
|
93
|
+
) {
|
|
94
|
+
setSelectedValue(relevantTabGroupChoice);
|
|
95
|
+
}
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
const handleTabChange = (event) => {
|
|
99
|
+
const newTab = event.currentTarget;
|
|
100
|
+
const newTabIndex = tabRefs.indexOf(newTab);
|
|
101
|
+
const newTabValue = values[newTabIndex].value;
|
|
102
|
+
|
|
103
|
+
if (newTabValue !== selectedValue) {
|
|
104
|
+
blockElementScrollPositionUntilNextRender(newTab);
|
|
105
|
+
setSelectedValue(newTabValue);
|
|
106
|
+
|
|
107
|
+
if (action) {
|
|
108
|
+
const newLanguage = languageSet.filter(
|
|
109
|
+
(lang) => lang.language === newTabValue
|
|
110
|
+
);
|
|
111
|
+
action(newLanguage[0]);
|
|
112
|
+
}
|
|
113
|
+
|
|
114
|
+
if (groupId != null) {
|
|
115
|
+
setTabGroupChoices(groupId, String(newTabValue));
|
|
116
|
+
}
|
|
117
|
+
}
|
|
118
|
+
};
|
|
119
|
+
|
|
120
|
+
const handleKeydown = (event) => {
|
|
121
|
+
let focusElement = null;
|
|
122
|
+
|
|
123
|
+
switch (event.key) {
|
|
124
|
+
case "ArrowRight": {
|
|
125
|
+
const nextTab = tabRefs.indexOf(event.currentTarget) + 1;
|
|
126
|
+
focusElement = tabRefs[nextTab] ?? tabRefs[0];
|
|
127
|
+
break;
|
|
128
|
+
}
|
|
129
|
+
|
|
130
|
+
case "ArrowLeft": {
|
|
131
|
+
const prevTab = tabRefs.indexOf(event.currentTarget) - 1;
|
|
132
|
+
focusElement = tabRefs[prevTab] ?? tabRefs[tabRefs.length - 1];
|
|
133
|
+
break;
|
|
134
|
+
}
|
|
135
|
+
|
|
136
|
+
default:
|
|
137
|
+
break;
|
|
138
|
+
}
|
|
139
|
+
|
|
140
|
+
focusElement?.focus();
|
|
141
|
+
};
|
|
142
|
+
|
|
143
|
+
return (
|
|
144
|
+
<div className={clsx("tabs-container", styles.tabList)}>
|
|
145
|
+
<ul
|
|
146
|
+
role="tablist"
|
|
147
|
+
aria-orientation="horizontal"
|
|
148
|
+
className={clsx(
|
|
149
|
+
"tabs",
|
|
150
|
+
{
|
|
151
|
+
"tabs--block": block,
|
|
152
|
+
},
|
|
153
|
+
styles.code__tabs,
|
|
154
|
+
className
|
|
155
|
+
)}
|
|
156
|
+
>
|
|
157
|
+
{values.map(({ value, label, attributes }) => (
|
|
158
|
+
<li
|
|
159
|
+
role="tab"
|
|
160
|
+
tabIndex={selectedValue === value ? 0 : -1}
|
|
161
|
+
aria-selected={selectedValue === value}
|
|
162
|
+
key={value}
|
|
163
|
+
ref={(tabControl) => tabRefs.push(tabControl)}
|
|
164
|
+
onKeyDown={handleKeydown}
|
|
165
|
+
onFocus={handleTabChange}
|
|
166
|
+
onClick={handleTabChange}
|
|
167
|
+
{...attributes}
|
|
168
|
+
className={clsx(
|
|
169
|
+
"tabs__item",
|
|
170
|
+
styles.tabItem,
|
|
171
|
+
attributes?.className,
|
|
172
|
+
{
|
|
173
|
+
"tabs__item--active": selectedValue === value,
|
|
174
|
+
}
|
|
175
|
+
)}
|
|
176
|
+
>
|
|
177
|
+
{label ?? value}
|
|
178
|
+
</li>
|
|
179
|
+
))}
|
|
180
|
+
</ul>
|
|
181
|
+
|
|
182
|
+
{lazy ? (
|
|
183
|
+
cloneElement(
|
|
184
|
+
children.filter(
|
|
185
|
+
(tabItem) => tabItem.props.value === selectedValue
|
|
186
|
+
)[0],
|
|
187
|
+
{
|
|
188
|
+
className: "margin-top--md",
|
|
189
|
+
}
|
|
190
|
+
)
|
|
191
|
+
) : (
|
|
192
|
+
<div className="margin-top--md">
|
|
193
|
+
{children.map((tabItem, i) =>
|
|
194
|
+
cloneElement(tabItem, {
|
|
195
|
+
key: i,
|
|
196
|
+
hidden: tabItem.props.value !== selectedValue,
|
|
197
|
+
})
|
|
198
|
+
)}
|
|
199
|
+
</div>
|
|
200
|
+
)}
|
|
201
|
+
</div>
|
|
202
|
+
);
|
|
203
|
+
}
|
|
204
|
+
|
|
205
|
+
export default function CodeTabs(props) {
|
|
206
|
+
const isBrowser = useIsBrowser();
|
|
207
|
+
return (
|
|
208
|
+
<TabsComponent // Remount tabs after hydration
|
|
209
|
+
// Temporary fix for https://github.com/facebook/docusaurus/issues/5653
|
|
210
|
+
key={String(isBrowser)}
|
|
211
|
+
{...props}
|
|
212
|
+
/>
|
|
213
|
+
);
|
|
214
|
+
}
|
|
@@ -4,20 +4,21 @@
|
|
|
4
4
|
* This source code is licensed under the MIT license found in the
|
|
5
5
|
* LICENSE file in the root directory of this source tree.
|
|
6
6
|
* ========================================================================== */
|
|
7
|
-
import React, {
|
|
7
|
+
import React, { useState, useEffect } from "react";
|
|
8
8
|
import useDocusaurusContext from "@docusaurus/useDocusaurusContext";
|
|
9
9
|
import codegen from "@paloaltonetworks/postman-code-generators";
|
|
10
|
+
import CodeBlock from "@theme/CodeBlock";
|
|
10
11
|
import clsx from "clsx";
|
|
11
|
-
import
|
|
12
|
+
import CodeTabs from "../CodeTabs";
|
|
12
13
|
import { useTypedSelector } from "../hooks";
|
|
13
14
|
import buildPostmanRequest from "./../buildPostmanRequest";
|
|
14
|
-
import FloatingButton from "./../FloatingButton";
|
|
15
15
|
import styles from "./styles.module.css";
|
|
16
|
-
const languageSet = [
|
|
16
|
+
export const languageSet = [
|
|
17
17
|
{
|
|
18
18
|
tabName: "cURL",
|
|
19
19
|
highlight: "bash",
|
|
20
20
|
language: "curl",
|
|
21
|
+
codeLanguage: "bash",
|
|
21
22
|
variant: "curl",
|
|
22
23
|
options: {
|
|
23
24
|
longFormat: false,
|
|
@@ -26,12 +27,12 @@ const languageSet = [
|
|
|
26
27
|
},
|
|
27
28
|
},
|
|
28
29
|
{
|
|
29
|
-
tabName: "
|
|
30
|
-
highlight: "
|
|
31
|
-
language: "
|
|
32
|
-
|
|
30
|
+
tabName: "Python",
|
|
31
|
+
highlight: "python",
|
|
32
|
+
language: "python",
|
|
33
|
+
codeLanguage: "python",
|
|
34
|
+
variant: "requests",
|
|
33
35
|
options: {
|
|
34
|
-
ES6_enabled: true,
|
|
35
36
|
followRedirect: true,
|
|
36
37
|
trimRequestBody: true,
|
|
37
38
|
},
|
|
@@ -40,6 +41,7 @@ const languageSet = [
|
|
|
40
41
|
tabName: "Go",
|
|
41
42
|
highlight: "go",
|
|
42
43
|
language: "go",
|
|
44
|
+
codeLanguage: "go",
|
|
43
45
|
variant: "native",
|
|
44
46
|
options: {
|
|
45
47
|
followRedirect: true,
|
|
@@ -47,70 +49,36 @@ const languageSet = [
|
|
|
47
49
|
},
|
|
48
50
|
},
|
|
49
51
|
{
|
|
50
|
-
tabName: "
|
|
51
|
-
highlight: "
|
|
52
|
-
language: "
|
|
53
|
-
|
|
52
|
+
tabName: "Node",
|
|
53
|
+
highlight: "javascript",
|
|
54
|
+
language: "nodejs",
|
|
55
|
+
codeLanguage: "javascript",
|
|
56
|
+
variant: "axios",
|
|
54
57
|
options: {
|
|
58
|
+
ES6_enabled: true,
|
|
55
59
|
followRedirect: true,
|
|
56
60
|
trimRequestBody: true,
|
|
57
61
|
},
|
|
58
62
|
},
|
|
59
63
|
];
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
color: "var(--openapi-code-green)",
|
|
75
|
-
},
|
|
76
|
-
},
|
|
77
|
-
{
|
|
78
|
-
types: ["builtin", "char", "constant", "function"],
|
|
79
|
-
style: {
|
|
80
|
-
color: "var(--openapi-code-blue)",
|
|
81
|
-
},
|
|
82
|
-
},
|
|
83
|
-
{
|
|
84
|
-
types: ["punctuation", "operator"],
|
|
85
|
-
style: {
|
|
86
|
-
color: "var(--openapi-code-dim)",
|
|
87
|
-
},
|
|
88
|
-
},
|
|
89
|
-
{
|
|
90
|
-
types: ["class-name"],
|
|
91
|
-
style: {
|
|
92
|
-
color: "var(--openapi-code-orange)",
|
|
93
|
-
},
|
|
94
|
-
},
|
|
95
|
-
{
|
|
96
|
-
types: ["tag", "arrow", "keyword"],
|
|
97
|
-
style: {
|
|
98
|
-
color: "var(--openapi-code-purple)",
|
|
99
|
-
},
|
|
100
|
-
},
|
|
101
|
-
{
|
|
102
|
-
types: ["boolean"],
|
|
103
|
-
style: {
|
|
104
|
-
color: "var(--openapi-code-red)",
|
|
105
|
-
},
|
|
106
|
-
},
|
|
107
|
-
],
|
|
108
|
-
};
|
|
64
|
+
|
|
65
|
+
function CodeTab({ children, hidden, className, onClick }) {
|
|
66
|
+
return (
|
|
67
|
+
<div
|
|
68
|
+
role="tabpanel"
|
|
69
|
+
className={clsx(styles.tabItem, className)}
|
|
70
|
+
{...{
|
|
71
|
+
hidden,
|
|
72
|
+
}}
|
|
73
|
+
>
|
|
74
|
+
{children}
|
|
75
|
+
</div>
|
|
76
|
+
);
|
|
77
|
+
}
|
|
109
78
|
|
|
110
79
|
function Curl({ postman, codeSamples }) {
|
|
111
80
|
// TODO: match theme for vscode.
|
|
112
81
|
const { siteConfig } = useDocusaurusContext();
|
|
113
|
-
const [copyText, setCopyText] = useState("Copy");
|
|
114
82
|
const contentType = useTypedSelector((state) => state.contentType.value);
|
|
115
83
|
const accept = useTypedSelector((state) => state.accept.value);
|
|
116
84
|
const server = useTypedSelector((state) => state.server.value);
|
|
@@ -125,7 +93,11 @@ function Curl({ postman, codeSamples }) {
|
|
|
125
93
|
...(siteConfig?.themeConfig?.languageTabs ?? languageSet),
|
|
126
94
|
...codeSamples,
|
|
127
95
|
];
|
|
128
|
-
const
|
|
96
|
+
const defaultLang = languageSet.filter(
|
|
97
|
+
(lang) =>
|
|
98
|
+
lang.codeLanguage === localStorage.getItem("docusaurus.tab.code-samples")
|
|
99
|
+
);
|
|
100
|
+
const [language, setLanguage] = useState(defaultLang[0] ?? langs[0]);
|
|
129
101
|
const [codeText, setCodeText] = useState("");
|
|
130
102
|
useEffect(() => {
|
|
131
103
|
if (language && !!language.options) {
|
|
@@ -171,18 +143,6 @@ function Curl({ postman, codeSamples }) {
|
|
|
171
143
|
server,
|
|
172
144
|
auth,
|
|
173
145
|
]);
|
|
174
|
-
const ref = useRef(null);
|
|
175
|
-
|
|
176
|
-
const handleCurlCopy = () => {
|
|
177
|
-
setCopyText("Copied");
|
|
178
|
-
setTimeout(() => {
|
|
179
|
-
setCopyText("Copy");
|
|
180
|
-
}, 2000);
|
|
181
|
-
|
|
182
|
-
if (ref.current?.innerText) {
|
|
183
|
-
navigator.clipboard.writeText(ref.current.innerText);
|
|
184
|
-
}
|
|
185
|
-
};
|
|
186
146
|
|
|
187
147
|
if (language === undefined) {
|
|
188
148
|
return null;
|
|
@@ -190,71 +150,22 @@ function Curl({ postman, codeSamples }) {
|
|
|
190
150
|
|
|
191
151
|
return (
|
|
192
152
|
<>
|
|
193
|
-
<
|
|
153
|
+
<CodeTabs groupId="code-samples" action={setLanguage}>
|
|
194
154
|
{langs.map((lang) => {
|
|
195
155
|
return (
|
|
196
|
-
<
|
|
156
|
+
<CodeTab
|
|
157
|
+
value={lang.language}
|
|
158
|
+
label={""}
|
|
197
159
|
key={lang.tabName || lang.label}
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
"api-code-tab"
|
|
202
|
-
)}
|
|
203
|
-
onClick={() => setLanguage(lang)}
|
|
160
|
+
attributes={{
|
|
161
|
+
className: `code__tab--${lang.codeLanguage}`,
|
|
162
|
+
}}
|
|
204
163
|
>
|
|
205
|
-
{lang.
|
|
206
|
-
</
|
|
164
|
+
<CodeBlock language={lang.codeLanguage}>{codeText}</CodeBlock>
|
|
165
|
+
</CodeTab>
|
|
207
166
|
);
|
|
208
167
|
})}
|
|
209
|
-
</
|
|
210
|
-
|
|
211
|
-
<Highlight
|
|
212
|
-
{...defaultProps}
|
|
213
|
-
theme={languageTheme}
|
|
214
|
-
code={codeText}
|
|
215
|
-
language={language.highlight || language.lang}
|
|
216
|
-
>
|
|
217
|
-
{({ className, tokens, getLineProps, getTokenProps }) => (
|
|
218
|
-
<FloatingButton onClick={handleCurlCopy} label={copyText}>
|
|
219
|
-
<pre
|
|
220
|
-
className={className}
|
|
221
|
-
style={{
|
|
222
|
-
background: "var(--openapi-card-background-color)",
|
|
223
|
-
paddingRight: "60px",
|
|
224
|
-
borderRadius:
|
|
225
|
-
"2px 2px var(--openapi-card-border-radius) var(--openapi-card-border-radius)",
|
|
226
|
-
}}
|
|
227
|
-
>
|
|
228
|
-
<code ref={ref}>
|
|
229
|
-
{tokens.map((line, i) => (
|
|
230
|
-
<span
|
|
231
|
-
{...getLineProps({
|
|
232
|
-
line,
|
|
233
|
-
key: i,
|
|
234
|
-
})}
|
|
235
|
-
>
|
|
236
|
-
{line.map((token, key) => {
|
|
237
|
-
if (token.types.includes("arrow")) {
|
|
238
|
-
token.types = ["arrow"];
|
|
239
|
-
}
|
|
240
|
-
|
|
241
|
-
return (
|
|
242
|
-
<span
|
|
243
|
-
{...getTokenProps({
|
|
244
|
-
token,
|
|
245
|
-
key,
|
|
246
|
-
})}
|
|
247
|
-
/>
|
|
248
|
-
);
|
|
249
|
-
})}
|
|
250
|
-
{"\n"}
|
|
251
|
-
</span>
|
|
252
|
-
))}
|
|
253
|
-
</code>
|
|
254
|
-
</pre>
|
|
255
|
-
</FloatingButton>
|
|
256
|
-
)}
|
|
257
|
-
</Highlight>
|
|
168
|
+
</CodeTabs>
|
|
258
169
|
</>
|
|
259
170
|
);
|
|
260
171
|
}
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
/* ============================================================================
|
|
2
|
+
* Copyright (c) Palo Alto Networks
|
|
3
|
+
*
|
|
4
|
+
* This source code is licensed under the MIT license found in the
|
|
5
|
+
* LICENSE file in the root directory of this source tree.
|
|
6
|
+
* ========================================================================== */
|
|
7
|
+
import React from "react";
|
|
8
|
+
import { usePrismTheme } from "@docusaurus/theme-common";
|
|
9
|
+
import useIsBrowser from "@docusaurus/useIsBrowser";
|
|
10
|
+
import { LiveProvider, LiveEditor, withLive } from "react-live";
|
|
11
|
+
import { setStringRawBody } from "../Body/slice";
|
|
12
|
+
import styles from "./styles.module.css";
|
|
13
|
+
|
|
14
|
+
function Live({ onEdit }) {
|
|
15
|
+
const isBrowser = useIsBrowser();
|
|
16
|
+
return (
|
|
17
|
+
<>
|
|
18
|
+
<LiveEditor
|
|
19
|
+
key={String(isBrowser)}
|
|
20
|
+
className={styles.playgroundEditor}
|
|
21
|
+
onChange={onEdit}
|
|
22
|
+
/>
|
|
23
|
+
</>
|
|
24
|
+
);
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
const LiveComponent = withLive(Live);
|
|
28
|
+
|
|
29
|
+
function App({ children, transformCode, value, language, action, ...props }) {
|
|
30
|
+
const prismTheme = usePrismTheme();
|
|
31
|
+
const [code, setCode] = React.useState(children);
|
|
32
|
+
action(setStringRawBody(code));
|
|
33
|
+
return (
|
|
34
|
+
<div className={styles.playgroundContainer}>
|
|
35
|
+
<LiveProvider
|
|
36
|
+
code={children.replace(/\n$/, "")}
|
|
37
|
+
transformCode={transformCode ?? ((code) => `${code};`)}
|
|
38
|
+
theme={prismTheme}
|
|
39
|
+
language={language}
|
|
40
|
+
{...props}
|
|
41
|
+
>
|
|
42
|
+
<LiveComponent onEdit={setCode} />
|
|
43
|
+
</LiveProvider>
|
|
44
|
+
</div>
|
|
45
|
+
);
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
const LiveApp = withLive(App);
|
|
49
|
+
export default LiveApp;
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
.playgroundContainer {
|
|
2
|
+
margin-top: 1rem;
|
|
3
|
+
margin-bottom: var(--ifm-leading);
|
|
4
|
+
border-radius: var(--ifm-global-radius);
|
|
5
|
+
box-shadow: var(--ifm-global-shadow-lw);
|
|
6
|
+
overflow: hidden;
|
|
7
|
+
}
|
|
8
|
+
|
|
9
|
+
.playgroundHeader {
|
|
10
|
+
letter-spacing: 0.08rem;
|
|
11
|
+
padding: 0.75rem;
|
|
12
|
+
text-transform: uppercase;
|
|
13
|
+
font-weight: bold;
|
|
14
|
+
background: var(--ifm-color-emphasis-200);
|
|
15
|
+
color: var(--ifm-color-content);
|
|
16
|
+
font-size: var(--ifm-code-font-size);
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
.playgroundHeader:first-of-type {
|
|
20
|
+
background: var(--ifm-color-emphasis-600);
|
|
21
|
+
color: var(--ifm-color-content-inverse);
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
.playgroundEditor {
|
|
25
|
+
font: var(--ifm-code-font-size) / var(--ifm-pre-line-height)
|
|
26
|
+
var(--ifm-font-family-monospace) !important;
|
|
27
|
+
/* rtl:ignore */
|
|
28
|
+
direction: ltr;
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
.playgroundPreview {
|
|
32
|
+
padding: 1rem;
|
|
33
|
+
background-color: var(--ifm-pre-background);
|
|
34
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 128 128"><path fill="none" d="M4.24 4.24h119.53v119.53H4.24z"/><path fill="#293138" d="M109.01 28.64L71.28 6.24c-2.25-1.33-4.77-2-7.28-2s-5.03.67-7.28 2.01l-37.74 22.4c-4.5 2.67-7.28 7.61-7.28 12.96v44.8c0 5.35 2.77 10.29 7.28 12.96l37.73 22.4c2.25 1.34 4.76 2 7.28 2 2.51 0 5.03-.67 7.28-2l37.74-22.4c4.5-2.67 7.28-7.62 7.28-12.96V41.6c0-5.34-2.77-10.29-7.28-12.96zM79.79 98.59l.06 3.22c0 .39-.25.83-.55.99l-1.91 1.1c-.3.15-.56-.03-.56-.42l-.03-3.17c-1.63.68-3.29.84-4.34.42-.2-.08-.29-.37-.21-.71l.69-2.91c.06-.23.18-.46.34-.6.06-.06.12-.1.18-.13.11-.06.22-.07.31-.03 1.14.38 2.59.2 3.99-.5 1.78-.9 2.97-2.72 2.95-4.52-.02-1.64-.9-2.31-3.05-2.33-2.74.01-5.3-.53-5.34-4.57-.03-3.32 1.69-6.78 4.43-8.96l-.03-3.25c0-.4.24-.84.55-1l1.85-1.18c.3-.15.56.04.56.43l.03 3.25c1.36-.54 2.54-.69 3.61-.44.23.06.34.38.24.75l-.72 2.88c-.06.22-.18.44-.33.58a.77.77 0 01-.19.14c-.1.05-.19.06-.28.05-.49-.11-1.65-.36-3.48.56-1.92.97-2.59 2.64-2.58 3.88.02 1.48.77 1.93 3.39 1.97 3.49.06 4.99 1.58 5.03 5.09.05 3.44-1.79 7.15-4.61 9.41zm26.34-60.5l-35.7 22.05c-4.45 2.6-7.73 5.52-7.74 10.89v43.99c0 3.21 1.3 5.29 3.29 5.9-.65.11-1.32.19-1.98.19-2.09 0-4.15-.57-5.96-1.64l-37.73-22.4c-3.69-2.19-5.98-6.28-5.98-10.67V41.6c0-4.39 2.29-8.48 5.98-10.67l37.74-22.4c1.81-1.07 3.87-1.64 5.96-1.64s4.15.57 5.96 1.64l37.74 22.4c3.11 1.85 5.21 5.04 5.8 8.63-1.27-2.67-4.09-3.39-7.38-1.47z"/><path fill="#4FA847" d="M99.12 90.73l-9.4 5.62c-.25.15-.43.31-.43.61v2.46c0 .3.2.43.45.28l9.54-5.8c.25-.15.29-.42.29-.72v-2.17c0-.3-.2-.42-.45-.28z"/></svg>
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 128 128"><g fill="#00acd7" fill-rule="evenodd"><path d="M11.156 54.829c-.243 0-.303-.122-.182-.303l1.273-1.637c.12-.182.424-.303.666-.303H34.55c.243 0 .303.182.182.364l-1.03 1.576c-.121.181-.424.363-.606.363zM2.004 60.404c-.242 0-.303-.12-.182-.303l1.273-1.636c.121-.182.424-.303.667-.303h27.636c.242 0 .364.182.303.364l-.485 1.454c-.06.243-.303.364-.545.364zM16.67 65.98c-.242 0-.302-.182-.181-.364l.848-1.515c.122-.182.364-.363.607-.363h12.12c.243 0 .364.181.364.424l-.12 1.454c0 .243-.243.425-.425.425zM79.58 53.738c-3.819.97-6.425 1.697-10.182 2.666-.91.243-.97.303-1.758-.606-.909-1.03-1.576-1.697-2.848-2.303-3.819-1.878-7.516-1.333-10.97.91-4.121 2.666-6.242 6.605-6.182 11.514.06 4.849 3.394 8.849 8.182 9.516 4.121.545 7.576-.91 10.303-4 .545-.667 1.03-1.394 1.636-2.243H56.064c-1.272 0-1.575-.788-1.151-1.818.788-1.879 2.242-5.03 3.09-6.606.183-.364.607-.97 1.516-.97h22.06c-.12 1.637-.12 3.273-.363 4.91-.667 4.363-2.303 8.363-4.97 11.878-4.364 5.758-10.06 9.333-17.273 10.303-5.939.788-11.454-.364-16.302-4-4.485-3.394-7.03-7.879-7.697-13.454-.788-6.606 1.151-12.546 5.151-17.758 4.303-5.636 10-9.212 16.97-10.485 5.697-1.03 11.151-.363 16.06 2.97 3.212 2.121 5.515 5.03 7.03 8.545.364.546.122.849-.606 1.03z"/><path d="M99.64 87.253c-5.515-.122-10.546-1.697-14.788-5.334-3.576-3.09-5.818-7.03-6.545-11.697-1.091-6.848.787-12.909 4.909-18.302 4.424-5.819 9.757-8.849 16.97-10.122 6.181-1.09 12-.484 17.272 3.091 4.788 3.273 7.757 7.697 8.545 13.515 1.03 8.182-1.333 14.849-6.97 20.546-4 4.06-8.909 6.606-14.545 7.757-1.636.303-3.273.364-4.848.546zm14.424-24.485c-.06-.788-.06-1.394-.182-2-1.09-6-6.606-9.394-12.363-8.06-5.637 1.272-9.273 4.848-10.606 10.545-1.091 4.727 1.212 9.515 5.575 11.454 3.334 1.455 6.667 1.273 9.879-.363 4.788-2.485 7.394-6.364 7.697-11.576z" fill-rule="nonzero"/></g></svg>
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 128 128"><path fill="#F0DB4F" d="M1.408 1.408h125.184v125.185H1.408z"/><path fill="#323330" d="M116.347 96.736c-.917-5.711-4.641-10.508-15.672-14.981-3.832-1.761-8.104-3.022-9.377-5.926-.452-1.69-.512-2.642-.226-3.665.821-3.32 4.784-4.355 7.925-3.403 2.023.678 3.938 2.237 5.093 4.724 5.402-3.498 5.391-3.475 9.163-5.879-1.381-2.141-2.118-3.129-3.022-4.045-3.249-3.629-7.676-5.498-14.756-5.355l-3.688.477c-3.534.893-6.902 2.748-8.877 5.235-5.926 6.724-4.236 18.492 2.975 23.335 7.104 5.332 17.54 6.545 18.873 11.531 1.297 6.104-4.486 8.08-10.234 7.378-4.236-.881-6.592-3.034-9.139-6.949-4.688 2.713-4.688 2.713-9.508 5.485 1.143 2.499 2.344 3.63 4.26 5.795 9.068 9.198 31.76 8.746 35.83-5.176.165-.478 1.261-3.666.38-8.581zM69.462 58.943H57.753l-.048 30.272c0 6.438.333 12.34-.714 14.149-1.713 3.558-6.152 3.117-8.175 2.427-2.059-1.012-3.106-2.451-4.319-4.485-.333-.584-.583-1.036-.667-1.071l-9.52 5.83c1.583 3.249 3.915 6.069 6.902 7.901 4.462 2.678 10.459 3.499 16.731 2.059 4.082-1.189 7.604-3.652 9.448-7.401 2.666-4.915 2.094-10.864 2.07-17.444.06-10.735.001-21.468.001-32.237z"/></svg>
|