@redocly/theme 0.9.0-beta.1 → 0.9.0-beta.3
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/Cards/Card.d.ts +0 -1
- package/lib/Catalog/Catalog.d.ts +0 -1
- package/lib/Catalog/CatalogCard.d.ts +0 -1
- package/lib/Catalog/Filter.d.ts +0 -1
- package/lib/Catalog/Tags.d.ts +0 -1
- package/lib/ColorModeSwitcher/ColorModeSwitcher.d.ts +0 -1
- package/lib/CopyButton/CopyButton.d.ts +0 -1
- package/lib/EditPageButton/EditPageButton.d.ts +0 -1
- package/lib/Feedback/Comment.d.ts +0 -1
- package/lib/Feedback/Rating.d.ts +0 -1
- package/lib/Feedback/Reasons.d.ts +0 -1
- package/lib/Feedback/ReportDialog.d.ts +0 -1
- package/lib/Feedback/Sentiment.d.ts +0 -1
- package/lib/Feedback/Thumbs.d.ts +0 -1
- package/lib/Footer/CustomFooter.d.ts +0 -1
- package/lib/Footer/CustomFooterNavItem.d.ts +0 -1
- package/lib/Footer/Footer.d.ts +0 -1
- package/lib/Footer/FooterColumn.d.ts +0 -1
- package/lib/Footer/FooterColumns.d.ts +0 -1
- package/lib/Footer/FooterCopyright.d.ts +0 -1
- package/lib/LastUpdated/LastUpdated.d.ts +0 -1
- package/lib/Markdown/CodeSample/CodeSample.d.ts +0 -1
- package/lib/Markdown/Mermaid.d.ts +0 -1
- package/lib/Markdown/Tabs/Tab.d.ts +0 -1
- package/lib/Navbar/MobileNavbarDropdown.d.ts +0 -1
- package/lib/Navbar/MobileNavbarItem.d.ts +0 -1
- package/lib/Navbar/MobileNavbarMenuButton.d.ts +0 -1
- package/lib/Navbar/NavbarDropdown.d.ts +0 -1
- package/lib/Navbar/NavbarItem.d.ts +0 -1
- package/lib/Navbar/NavbarMenu.d.ts +0 -1
- package/lib/NavbarLogo/NavbarLogo.d.ts +0 -1
- package/lib/PageNavigation/NextButton.d.ts +0 -1
- package/lib/PageNavigation/PageNavigation.d.ts +0 -1
- package/lib/PageNavigation/PreviousButton.d.ts +0 -1
- package/lib/Pages/Forbidden.d.ts +0 -1
- package/lib/Pages/NotFound.d.ts +0 -1
- package/lib/Profile/LoginLink.d.ts +0 -1
- package/lib/Profile/UserProfile.d.ts +0 -1
- package/lib/ReferenceDocs/TryItSecurity.d.ts +2 -0
- package/lib/ReferenceDocs/TryItSecurity.js +5 -0
- package/lib/Search/Parameters.d.ts +0 -1
- package/lib/Search/Search.d.ts +0 -1
- package/lib/Search/SearchItem.d.ts +0 -1
- package/lib/Search/ShortcutKey.d.ts +0 -1
- package/lib/Search/utils.d.ts +0 -1
- package/lib/Sidebar/ApiCallItem.d.ts +0 -1
- package/lib/Sidebar/ArrowBack.d.ts +0 -1
- package/lib/Sidebar/DrilldownMenuItem.d.ts +0 -1
- package/lib/Sidebar/ExternalIcon.d.ts +0 -1
- package/lib/Sidebar/MenuContainer.d.ts +5 -3
- package/lib/Sidebar/MenuContainer.js +3 -2
- package/lib/Sidebar/MenuItem.d.ts +0 -1
- package/lib/Sidebar/Separator.d.ts +0 -1
- package/lib/Sidebar/SidebarLayout.d.ts +3 -1
- package/lib/Sidebar/SidebarLayout.js +7 -2
- package/lib/SidebarLogo/SidebarLogo.d.ts +0 -1
- package/lib/SourceCode/SourceCode.d.ts +3 -3
- package/lib/SourceCode/SourceCode.js +5 -5
- package/lib/TableOfContent/TableOfContent.d.ts +0 -1
- package/lib/globalStyle.js +1 -0
- package/lib/icons/AlertIcon/AlertIcon.d.ts +0 -1
- package/lib/icons/ArrowIcon/ArrowIcon.d.ts +0 -1
- package/lib/icons/ColorModeIcon/ColorModeIcon.d.ts +0 -1
- package/lib/mocks/Link.d.ts +0 -1
- package/lib/ui/Dropdown.d.ts +0 -1
- package/package.json +1 -1
- package/src/ReferenceDocs/TryItSecurity.tsx +4 -0
- package/src/Sidebar/MenuContainer.tsx +8 -3
- package/src/Sidebar/SidebarLayout.tsx +11 -1
- package/src/SourceCode/SourceCode.tsx +6 -0
- package/src/globalStyle.ts +1 -0
package/lib/Cards/Card.d.ts
CHANGED
package/lib/Catalog/Catalog.d.ts
CHANGED
package/lib/Catalog/Filter.d.ts
CHANGED
package/lib/Catalog/Tags.d.ts
CHANGED
package/lib/Feedback/Rating.d.ts
CHANGED
package/lib/Feedback/Thumbs.d.ts
CHANGED
package/lib/Footer/Footer.d.ts
CHANGED
package/lib/Pages/Forbidden.d.ts
CHANGED
package/lib/Pages/NotFound.d.ts
CHANGED
package/lib/Search/Search.d.ts
CHANGED
package/lib/Search/utils.d.ts
CHANGED
|
@@ -1,3 +1,5 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
}
|
|
1
|
+
interface MenuContainerProps {
|
|
2
|
+
growContent?: boolean;
|
|
3
|
+
}
|
|
4
|
+
export declare const MenuContainer: import("styled-components").StyledComponent<"div", any, MenuContainerProps, never>;
|
|
5
|
+
export {};
|
|
@@ -5,12 +5,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
5
5
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
6
|
exports.MenuContainer = void 0;
|
|
7
7
|
const styled_components_1 = __importDefault(require("styled-components"));
|
|
8
|
-
exports.MenuContainer = styled_components_1.default.div.attrs(() => ({
|
|
8
|
+
exports.MenuContainer = styled_components_1.default.div.attrs(({ growContent }) => ({
|
|
9
9
|
'data-component-name': 'Sidebar/MenuContainer',
|
|
10
|
+
growContent: growContent === undefined ? true : growContent,
|
|
10
11
|
})) `
|
|
11
12
|
position: relative;
|
|
12
13
|
overflow-y: auto;
|
|
13
|
-
flex-grow: 1;
|
|
14
|
+
flex-grow: ${({ growContent }) => (growContent ? 1 : 0)};
|
|
14
15
|
padding-top: var(--sidebar-offset-top);
|
|
15
16
|
`;
|
|
16
17
|
//# sourceMappingURL=MenuContainer.js.map
|
|
@@ -7,7 +7,9 @@ interface SidebarLayoutProps {
|
|
|
7
7
|
slug: string;
|
|
8
8
|
};
|
|
9
9
|
footer?: React.ReactNode;
|
|
10
|
+
header?: React.ReactNode;
|
|
11
|
+
growContent?: boolean;
|
|
10
12
|
hasNavbar: boolean;
|
|
11
13
|
}
|
|
12
|
-
export declare function SidebarLayout({ versions, menu, backLink, footer, hasNavbar, }: SidebarLayoutProps): JSX.Element | null;
|
|
14
|
+
export declare function SidebarLayout({ versions, menu, backLink, footer, header, growContent, hasNavbar, }: SidebarLayoutProps): JSX.Element | null;
|
|
13
15
|
export {};
|
|
@@ -15,7 +15,7 @@ const useThemeConfig_1 = require("../hooks/useThemeConfig");
|
|
|
15
15
|
const ArrowBack_1 = require("../Sidebar/ArrowBack");
|
|
16
16
|
const Link_1 = require("../mocks/Link");
|
|
17
17
|
const Button_1 = require("../Button/Button");
|
|
18
|
-
function SidebarLayout({ versions, menu, backLink, footer, hasNavbar, }) {
|
|
18
|
+
function SidebarLayout({ versions, menu, backLink, footer, header, growContent, hasNavbar, }) {
|
|
19
19
|
const [isOpen, setIsOpen] = (0, useMobileMenu_1.useMobileMenu)();
|
|
20
20
|
const toggleMenu = () => setIsOpen(!isOpen);
|
|
21
21
|
const { search, sidebar } = (0, useThemeConfig_1.useThemeConfig)();
|
|
@@ -26,6 +26,7 @@ function SidebarLayout({ versions, menu, backLink, footer, hasNavbar, }) {
|
|
|
26
26
|
react_1.default.createElement(MobileSidebarButton_1.MobileSidebarButton, { opened: isOpen, onClick: toggleMenu }),
|
|
27
27
|
!(search === null || search === void 0 ? void 0 : search.hide) && (search === null || search === void 0 ? void 0 : search.placement) === 'sidebar' ? react_1.default.createElement(SidebarSearch_1.SidebarSearch, null) : null,
|
|
28
28
|
react_1.default.createElement(Sidebar_1.Sidebar, { animate: true, opened: isOpen, hasNavbar: hasNavbar },
|
|
29
|
+
header ? react_1.default.createElement(HeaderWrapper, null, header) : null,
|
|
29
30
|
(backLink && (react_1.default.createElement(BackLinkWrapper, null,
|
|
30
31
|
react_1.default.createElement(Link_1.Link, { to: backLink.slug },
|
|
31
32
|
react_1.default.createElement(ArrowBack_1.ArrowBack, null),
|
|
@@ -33,7 +34,7 @@ function SidebarLayout({ versions, menu, backLink, footer, hasNavbar, }) {
|
|
|
33
34
|
backLink.label)))) ||
|
|
34
35
|
null,
|
|
35
36
|
versions,
|
|
36
|
-
react_1.default.createElement(MenuContainer_1.MenuContainer,
|
|
37
|
+
react_1.default.createElement(MenuContainer_1.MenuContainer, { growContent: growContent }, menu),
|
|
37
38
|
footer ? react_1.default.createElement(FooterWrapper, null, footer) : null)));
|
|
38
39
|
}
|
|
39
40
|
exports.SidebarLayout = SidebarLayout;
|
|
@@ -46,6 +47,10 @@ const FooterWrapper = styled_components_1.default.div `
|
|
|
46
47
|
margin: 0;
|
|
47
48
|
}
|
|
48
49
|
`;
|
|
50
|
+
const HeaderWrapper = styled_components_1.default.div `
|
|
51
|
+
padding: var(--sidebar-offset-top) var(--sidebar-item-padding-horizontal)
|
|
52
|
+
var(--sidebar-item-padding-horizontal) var(--sidebar-offset-left);
|
|
53
|
+
`;
|
|
49
54
|
const BackLinkWrapper = styled_components_1.default.div `
|
|
50
55
|
padding: var(--sidebar-offset-top) var(--sidebar-item-padding-horizontal)
|
|
51
56
|
var(--sidebar-item-padding-horizontal)
|
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
/// <reference types="react" />
|
|
2
1
|
interface CommonCodeProps {
|
|
3
2
|
withLineNumbers?: boolean;
|
|
4
3
|
startLineNumber?: number;
|
|
4
|
+
className?: string;
|
|
5
5
|
}
|
|
6
6
|
export interface SourceCodeProps extends CommonCodeProps {
|
|
7
7
|
lang: string;
|
|
@@ -27,6 +27,6 @@ export interface ExternalSource {
|
|
|
27
27
|
properties?: any;
|
|
28
28
|
operation?: any;
|
|
29
29
|
}
|
|
30
|
-
export declare function Code({ source, lang, dataTestId, withLineNumbers, startLineNumber, }: CodeProps): JSX.Element;
|
|
31
|
-
export declare function SourceCode({ lang, source, externalSource, onCopyClick, withCopyButton, dataTestId, withLineNumbers, startLineNumber, }: SourceCodeProps): JSX.Element;
|
|
30
|
+
export declare function Code({ source, lang, dataTestId, withLineNumbers, startLineNumber, className, }: CodeProps): JSX.Element;
|
|
31
|
+
export declare function SourceCode({ lang, source, externalSource, onCopyClick, withCopyButton, dataTestId, withLineNumbers, startLineNumber, className, }: SourceCodeProps): JSX.Element;
|
|
32
32
|
export {};
|
|
@@ -28,16 +28,16 @@ const react_1 = __importStar(require("react"));
|
|
|
28
28
|
const utils_1 = require("../utils");
|
|
29
29
|
const SamplesPanelControls_1 = require("../SamplesPanelControls");
|
|
30
30
|
const CopyButton_1 = require("../CopyButton");
|
|
31
|
-
function Code({ source, lang, dataTestId, withLineNumbers, startLineNumber, }) {
|
|
31
|
+
function Code({ source, lang, dataTestId, withLineNumbers, startLineNumber, className, }) {
|
|
32
32
|
const highlightedCode = (0, utils_1.highlight)(source, lang);
|
|
33
|
-
return (react_1.default.createElement(SamplesPanelControls_1.PreformattedCodeBlock, { dangerouslySetInnerHTML: {
|
|
33
|
+
return (react_1.default.createElement(SamplesPanelControls_1.PreformattedCodeBlock, { className: className, dangerouslySetInnerHTML: {
|
|
34
34
|
__html: withLineNumbers
|
|
35
35
|
? (0, utils_1.addLineNumbers)(highlightedCode, startLineNumber)
|
|
36
36
|
: highlightedCode,
|
|
37
37
|
}, "data-cy": dataTestId }));
|
|
38
38
|
}
|
|
39
39
|
exports.Code = Code;
|
|
40
|
-
function SourceCode({ lang, source, externalSource, onCopyClick, withCopyButton, dataTestId = 'source-code', withLineNumbers, startLineNumber, }) {
|
|
40
|
+
function SourceCode({ lang, source, externalSource, onCopyClick, withCopyButton, dataTestId = 'source-code', withLineNumbers, startLineNumber, className, }) {
|
|
41
41
|
const [sourceCode, setSourceCode] = (0, react_1.useState)(source !== null && source !== void 0 ? source : '');
|
|
42
42
|
// The same initial value should be returned for ssr and frontend to avoid issues
|
|
43
43
|
// Because we don't have session storage in ssr and can't get the security details there
|
|
@@ -52,9 +52,9 @@ function SourceCode({ lang, source, externalSource, onCopyClick, withCopyButton,
|
|
|
52
52
|
if (withCopyButton) {
|
|
53
53
|
return (react_1.default.createElement(CopyButton_1.CopyButtonWrapper, { data: sourceCode, onCopyClick: onCopyClick, "data-component-name": "SourceCode/SourceCode" }, ({ renderCopyButton }) => (react_1.default.createElement(SamplesPanelControls_1.SampleControlsWrap, null,
|
|
54
54
|
react_1.default.createElement(SamplesPanelControls_1.SampleControls, { "data-cy": "copy-button" }, renderCopyButton()),
|
|
55
|
-
react_1.default.createElement(Code, { lang: lang, source: sourceCode, withLineNumbers: withLineNumbers, startLineNumber: startLineNumber, dataTestId: dataTestId })))));
|
|
55
|
+
react_1.default.createElement(Code, { lang: lang, source: sourceCode, withLineNumbers: withLineNumbers, startLineNumber: startLineNumber, dataTestId: dataTestId, className: className })))));
|
|
56
56
|
}
|
|
57
|
-
return (react_1.default.createElement(Code, { dataTestId: dataTestId, lang: lang, source: sourceCode, withLineNumbers: withLineNumbers, startLineNumber: startLineNumber, "data-component-name": "SourceCode/SourceCode" }));
|
|
57
|
+
return (react_1.default.createElement(Code, { dataTestId: dataTestId, className: className, lang: lang, source: sourceCode, withLineNumbers: withLineNumbers, startLineNumber: startLineNumber, "data-component-name": "SourceCode/SourceCode" }));
|
|
58
58
|
}
|
|
59
59
|
exports.SourceCode = SourceCode;
|
|
60
60
|
//# sourceMappingURL=SourceCode.js.map
|
package/lib/globalStyle.js
CHANGED
package/lib/mocks/Link.d.ts
CHANGED
package/lib/ui/Dropdown.d.ts
CHANGED
package/package.json
CHANGED
|
@@ -1,10 +1,15 @@
|
|
|
1
1
|
import styled from 'styled-components';
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
interface MenuContainerProps {
|
|
4
|
+
growContent?: boolean;
|
|
5
|
+
}
|
|
6
|
+
|
|
7
|
+
export const MenuContainer = styled.div.attrs<MenuContainerProps>(({ growContent }) => ({
|
|
4
8
|
'data-component-name': 'Sidebar/MenuContainer',
|
|
5
|
-
|
|
9
|
+
growContent: growContent === undefined ? true : growContent,
|
|
10
|
+
}))<MenuContainerProps>`
|
|
6
11
|
position: relative;
|
|
7
12
|
overflow-y: auto;
|
|
8
|
-
flex-grow: 1;
|
|
13
|
+
flex-grow: ${({ growContent }) => (growContent ? 1 : 0)};
|
|
9
14
|
padding-top: var(--sidebar-offset-top);
|
|
10
15
|
`;
|
|
@@ -19,6 +19,8 @@ interface SidebarLayoutProps {
|
|
|
19
19
|
slug: string;
|
|
20
20
|
};
|
|
21
21
|
footer?: React.ReactNode;
|
|
22
|
+
header?: React.ReactNode;
|
|
23
|
+
growContent?: boolean;
|
|
22
24
|
|
|
23
25
|
hasNavbar: boolean;
|
|
24
26
|
}
|
|
@@ -28,6 +30,8 @@ export function SidebarLayout({
|
|
|
28
30
|
menu,
|
|
29
31
|
backLink,
|
|
30
32
|
footer,
|
|
33
|
+
header,
|
|
34
|
+
growContent,
|
|
31
35
|
hasNavbar,
|
|
32
36
|
}: SidebarLayoutProps): JSX.Element | null {
|
|
33
37
|
const [isOpen, setIsOpen] = useMobileMenu();
|
|
@@ -44,6 +48,7 @@ export function SidebarLayout({
|
|
|
44
48
|
|
|
45
49
|
{!search?.hide && search?.placement === 'sidebar' ? <SidebarSearch /> : null}
|
|
46
50
|
<Sidebar animate={true} opened={isOpen} hasNavbar={hasNavbar}>
|
|
51
|
+
{header ? <HeaderWrapper>{header}</HeaderWrapper> : null}
|
|
47
52
|
{(backLink && (
|
|
48
53
|
<BackLinkWrapper>
|
|
49
54
|
<Link to={backLink.slug}>
|
|
@@ -54,7 +59,7 @@ export function SidebarLayout({
|
|
|
54
59
|
)) ||
|
|
55
60
|
null}
|
|
56
61
|
{versions}
|
|
57
|
-
<MenuContainer>{menu}</MenuContainer>
|
|
62
|
+
<MenuContainer growContent={growContent}>{menu}</MenuContainer>
|
|
58
63
|
{footer ? <FooterWrapper>{footer}</FooterWrapper> : null}
|
|
59
64
|
</Sidebar>
|
|
60
65
|
</Wrapper>
|
|
@@ -71,6 +76,11 @@ const FooterWrapper = styled.div`
|
|
|
71
76
|
}
|
|
72
77
|
`;
|
|
73
78
|
|
|
79
|
+
const HeaderWrapper = styled.div`
|
|
80
|
+
padding: var(--sidebar-offset-top) var(--sidebar-item-padding-horizontal)
|
|
81
|
+
var(--sidebar-item-padding-horizontal) var(--sidebar-offset-left);
|
|
82
|
+
`;
|
|
83
|
+
|
|
74
84
|
const BackLinkWrapper = styled.div`
|
|
75
85
|
padding: var(--sidebar-offset-top) var(--sidebar-item-padding-horizontal)
|
|
76
86
|
var(--sidebar-item-padding-horizontal)
|
|
@@ -11,6 +11,7 @@ import { CopyButtonWrapper } from '@theme/CopyButton';
|
|
|
11
11
|
interface CommonCodeProps {
|
|
12
12
|
withLineNumbers?: boolean;
|
|
13
13
|
startLineNumber?: number;
|
|
14
|
+
className?: string;
|
|
14
15
|
}
|
|
15
16
|
|
|
16
17
|
export interface SourceCodeProps extends CommonCodeProps {
|
|
@@ -49,11 +50,13 @@ export function Code({
|
|
|
49
50
|
dataTestId,
|
|
50
51
|
withLineNumbers,
|
|
51
52
|
startLineNumber,
|
|
53
|
+
className,
|
|
52
54
|
}: CodeProps): JSX.Element {
|
|
53
55
|
const highlightedCode = highlight(source, lang);
|
|
54
56
|
|
|
55
57
|
return (
|
|
56
58
|
<PreformattedCodeBlock
|
|
59
|
+
className={className}
|
|
57
60
|
dangerouslySetInnerHTML={{
|
|
58
61
|
__html: withLineNumbers
|
|
59
62
|
? addLineNumbers(highlightedCode, startLineNumber)
|
|
@@ -73,6 +76,7 @@ export function SourceCode({
|
|
|
73
76
|
dataTestId = 'source-code',
|
|
74
77
|
withLineNumbers,
|
|
75
78
|
startLineNumber,
|
|
79
|
+
className,
|
|
76
80
|
}: SourceCodeProps): JSX.Element {
|
|
77
81
|
const [sourceCode, setSourceCode] = useState<string>(source ?? '');
|
|
78
82
|
|
|
@@ -102,6 +106,7 @@ export function SourceCode({
|
|
|
102
106
|
withLineNumbers={withLineNumbers}
|
|
103
107
|
startLineNumber={startLineNumber}
|
|
104
108
|
dataTestId={dataTestId}
|
|
109
|
+
className={className}
|
|
105
110
|
/>
|
|
106
111
|
</SampleControlsWrap>
|
|
107
112
|
)}
|
|
@@ -112,6 +117,7 @@ export function SourceCode({
|
|
|
112
117
|
return (
|
|
113
118
|
<Code
|
|
114
119
|
dataTestId={dataTestId}
|
|
120
|
+
className={className}
|
|
115
121
|
lang={lang}
|
|
116
122
|
source={sourceCode}
|
|
117
123
|
withLineNumbers={withLineNumbers}
|