Skip to content

Commit 1f08d2c

Browse files
committed
chore(docs): fix console warnings, codesandbox builds
1 parent b44d817 commit 1f08d2c

12 files changed

+83
-99
lines changed

packages/module/patternfly-docs/content/extensions/react-log-viewer/demos/ComplexToolbarLogViewer.jsx

+2-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import React from 'react';
2-
import { data } from '../examples/realTestData';
2+
import { data } from '@patternfly/react-log-viewer/patternfly-docs/content/extensions/react-log-viewer/examples/realTestData.js';
33
import { LogViewer, LogViewerSearch } from '@patternfly/react-log-viewer';
44
import {
55
Badge,
@@ -22,7 +22,7 @@ import PlayIcon from '@patternfly/react-icons/dist/esm/icons/play-icon';
2222
import EllipsisVIcon from '@patternfly/react-icons/dist/esm/icons/ellipsis-v-icon';
2323
import DownloadIcon from '@patternfly/react-icons/dist/esm/icons/download-icon';
2424

25-
const ComplexToolbarLogViewer = () => {
25+
export const ComplexToolbarLogViewer = () => {
2626
const dataSources = {
2727
'container-1': { type: 'C', id: 'data1' },
2828
'container-2': { type: 'D', id: 'data2' },
@@ -273,5 +273,3 @@ const ComplexToolbarLogViewer = () => {
273273
/>
274274
);
275275
};
276-
277-
export default ComplexToolbarLogViewer;

packages/module/patternfly-docs/content/extensions/react-log-viewer/demos/LogViewer.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ section: extensions
44
source: react-demos
55
---
66

7-
import { data } from '../examples/realTestData';
7+
import { data } from '@patternfly/react-log-viewer/patternfly-docs/content/extensions/react-log-viewer/examples/realTestData.js';
88
import { LogViewer, LogViewerSearch } from '@patternfly/react-log-viewer';
99
import {
1010
Badge,
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,12 @@
11
import React from 'react';
2-
import { data } from './realTestData.js';
2+
import { data } from '@patternfly/react-log-viewer/patternfly-docs/content/extensions/react-log-viewer/examples/realTestData.js';
33
import { LogViewer } from '@patternfly/react-log-viewer';
44

5-
const ANSIColorLogViewer = () => (
6-
<LogViewer
7-
hasLineNumbers={false}
8-
height={300}
9-
data={data.data4}
10-
theme="dark"
11-
/>
12-
);
13-
14-
export default ANSIColorLogViewer;
5+
export const ANSIColorLogViewer = () => (
6+
<LogViewer
7+
hasLineNumbers={false}
8+
height={300}
9+
data={data.data4}
10+
theme="dark"
11+
/>
12+
);

packages/module/patternfly-docs/content/extensions/react-log-viewer/examples/BasicLogViewer.jsx

+2-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
import React from 'react';
2-
import { data } from './realTestData';
2+
import { data } from '@patternfly/react-log-viewer/patternfly-docs/content/extensions/react-log-viewer/examples/realTestData.js';
33
import { LogViewer } from '@patternfly/react-log-viewer';
44
import { Checkbox } from '@patternfly/react-core';
55

6-
const BasicLogViewer = () => {
6+
export const BasicLogViewer = () => {
77
const [isDarkTheme, setIsDarkTheme] = React.useState(false);
88

99
return (
@@ -20,5 +20,3 @@ const BasicLogViewer = () => {
2020
</React.Fragment>
2121
);
2222
};
23-
24-
export default BasicLogViewer;
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,19 @@
11
import React from 'react';
2-
import { data } from './realTestData';
2+
import { data } from '@patternfly/react-log-viewer/patternfly-docs/content/extensions/react-log-viewer/examples/realTestData.js';
33
import { LogViewer, LogViewerSearch } from '@patternfly/react-log-viewer';
44
import { Toolbar, ToolbarContent, ToolbarItem } from '@patternfly/react-core';
55

6-
const BasicSearchLogViewer = () => (
7-
<LogViewer
8-
data={data.data}
9-
toolbar={
10-
<Toolbar>
11-
<ToolbarContent>
12-
<ToolbarItem>
13-
<LogViewerSearch placeholder="Search value" />
14-
</ToolbarItem>
15-
</ToolbarContent>
16-
</Toolbar>
17-
}
18-
/>
19-
);
20-
21-
export default BasicSearchLogViewer;
6+
export const BasicSearchLogViewer = () => (
7+
<LogViewer
8+
data={data.data}
9+
toolbar={
10+
<Toolbar>
11+
<ToolbarContent>
12+
<ToolbarItem>
13+
<LogViewerSearch placeholder="Search value" />
14+
</ToolbarItem>
15+
</ToolbarContent>
16+
</Toolbar>
17+
}
18+
/>
19+
);

packages/module/patternfly-docs/content/extensions/react-log-viewer/examples/CustomControlLogViewer.jsx

+2-4
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
/* eslint-disable no-console */
22
import React from 'react';
3-
import { data } from './realTestData';
3+
import { data } from '@patternfly/react-log-viewer/patternfly-docs/content/extensions/react-log-viewer/examples/realTestData.js';
44
import { LogViewer, LogViewerSearch } from '@patternfly/react-log-viewer';
55
import { Toolbar, ToolbarContent, ToolbarItem, Button, Checkbox } from '@patternfly/react-core';
66

7-
const CustomControlLogViewer = () => {
7+
export const CustomControlLogViewer = () => {
88
const [isTextWrapped, setIsTextWrapped] = React.useState(false);
99
const onActionClick = () => {
1010
console.log('clicked test action button');
@@ -43,5 +43,3 @@ const CustomControlLogViewer = () => {
4343
/>
4444
);
4545
};
46-
47-
export default CustomControlLogViewer;

packages/module/patternfly-docs/content/extensions/react-log-viewer/examples/FooterComponentLogViewer.jsx

+2-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
import React from 'react';
2-
import { data } from './realTestData';
2+
import { data } from '@patternfly/react-log-viewer/patternfly-docs/content/extensions/react-log-viewer/examples/realTestData.js';
33
import { LogViewer } from '@patternfly/react-log-viewer';
44
import { Button } from '@patternfly/react-core';
55

6-
const FooterComponentLogViewer = () => {
6+
export const FooterComponentLogViewer = () => {
77
const logViewerRef = React.useRef();
88
const FooterButton = () => {
99
const handleClick = () => {
@@ -23,5 +23,3 @@ const FooterComponentLogViewer = () => {
2323
/>
2424
);
2525
};
26-
27-
export default FooterComponentLogViewer;
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,14 @@
11
import React from 'react';
2-
import { data } from './realTestData';
2+
import { data } from '@patternfly/react-log-viewer/patternfly-docs/content/extensions/react-log-viewer/examples/realTestData.js';
33
import { LogViewer } from '@patternfly/react-log-viewer';
44
import { Banner } from '@patternfly/react-core';
55

6-
const HeaderComponentLogViewer = () => (
7-
<LogViewer
8-
hasLineNumbers={false}
9-
height={300}
10-
data={data.data}
11-
theme="dark"
12-
header={<Banner>5019 lines</Banner>}
13-
/>
14-
);
15-
16-
export default HeaderComponentLogViewer;
6+
export const HeaderComponentLogViewer = () => (
7+
<LogViewer
8+
hasLineNumbers={false}
9+
height={300}
10+
data={data.data}
11+
theme="dark"
12+
header={<Banner>5019 lines</Banner>}
13+
/>
14+
);

packages/module/patternfly-docs/content/extensions/react-log-viewer/examples/basic.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ propComponents: [LogViewer, LogViewerSearch]
1616

1717
import { LogViewer, LogViewerSearch, LogViewerContext } from '@patternfly/react-log-viewer';
1818
import { Button, Checkbox, Toolbar, ToolbarContent, ToolbarItem } from '@patternfly/react-core';
19-
import { data } from './realTestData';
19+
import { data } from '@patternfly/react-log-viewer/patternfly-docs/content/extensions/react-log-viewer/examples/realTestData.js';
2020

2121
## Examples
2222

packages/module/patternfly-docs/generated/extensions/log-viewer/design-guidelines.js

+30-30
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
import React from 'react';
22
import { AutoLinkHeader, Example, Link as PatternflyThemeLink } from '@patternfly/documentation-framework/components';
3-
import srcImport0 from '../../../content/extensions/react-log-viewer/design-guidelines/./img/logviewer.png';
4-
import srcImport1 from '../../../content/extensions/react-log-viewer/design-guidelines/./img/logviewerdark.png';
5-
import srcImport2 from '../../../content/extensions/react-log-viewer/design-guidelines/./img/logviewerclear.png';
6-
import srcImport3 from '../../../content/extensions/react-log-viewer/design-guidelines/./img/logviewercog.png';
7-
import srcImport4 from '../../../content/extensions/react-log-viewer/design-guidelines/./img/logviewersearch.png';
3+
import srcImport5 from '../../../content/extensions/react-log-viewer/design-guidelines/./img/logviewer.png';
4+
import srcImport6 from '../../../content/extensions/react-log-viewer/design-guidelines/./img/logviewerdark.png';
5+
import srcImport7 from '../../../content/extensions/react-log-viewer/design-guidelines/./img/logviewerclear.png';
6+
import srcImport8 from '../../../content/extensions/react-log-viewer/design-guidelines/./img/logviewercog.png';
7+
import srcImport9 from '../../../content/extensions/react-log-viewer/design-guidelines/./img/logviewersearch.png';
88
const pageData = {
99
"id": "Log viewer",
1010
"section": "extensions",
@@ -26,7 +26,7 @@ pageData.examples = {
2626

2727
const Component = () => (
2828
<React.Fragment>
29-
<p {...{"className":"pf-v6-c-content--p ws-p "}}>
29+
<p {...{"className":"pf-v6-c-content--p pf-m-editorial ws-p "}}>
3030
{`A `}
3131
<strong {...{"className":""}}>
3232
{`log viewer`}
@@ -36,52 +36,52 @@ const Component = () => (
3636
<AutoLinkHeader {...{"id":"light-theme-log-viewer","headingLevel":"h2","className":"ws-title ws-h2"}}>
3737
{`Light theme log viewer`}
3838
</AutoLinkHeader>
39-
<img src={srcImport0} width={srcImport0.width} height={srcImport0.height} {...{"alt":"Log Viewer","className":"ws-img "}}>
39+
<img src={srcImport5} width={srcImport5.width} height={srcImport5.height} {...{"alt":"Log Viewer","className":"ws-img "}}>
4040
</img>
41-
<ol {...{"className":"pf-v6-c-content--ol ws-ol "}}>
42-
<li {...{"className":"pf-v6-c-content--li ws-li "}}>
41+
<ol {...{"className":"pf-v6-c-content--ol pf-m-editorial ws-ol "}}>
42+
<li {...{"className":"pf-v6-c-content--li pf-m-editorial ws-li "}}>
4343
<strong {...{"className":""}}>
4444
{`Type of log dropdown menu:`}
4545
</strong>
4646
{` Allow users to switch between different types of logs.`}
4747
</li>
48-
<li {...{"className":"pf-v6-c-content--li ws-li "}}>
48+
<li {...{"className":"pf-v6-c-content--li pf-m-editorial ws-li "}}>
4949
<strong {...{"className":""}}>
5050
{`Search bar:`}
5151
</strong>
5252
{` Use to look up historical logs. The results will be highlighted in the log.`}
5353
</li>
54-
<li {...{"className":"pf-v6-c-content--li ws-li "}}>
54+
<li {...{"className":"pf-v6-c-content--li pf-m-editorial ws-li "}}>
5555
<strong {...{"className":""}}>
5656
{`Pause button:`}
5757
</strong>
5858
{` Play and stop your log content viewing, instead of scrolling through.`}
5959
</li>
60-
<li {...{"className":"pf-v6-c-content--li ws-li "}}>
60+
<li {...{"className":"pf-v6-c-content--li pf-m-editorial ws-li "}}>
6161
<strong {...{"className":""}}>
6262
{`Clear log:`}
6363
</strong>
6464
{` Clear the displayed log output.`}
6565
</li>
66-
<li {...{"className":"pf-v6-c-content--li ws-li "}}>
66+
<li {...{"className":"pf-v6-c-content--li pf-m-editorial ws-li "}}>
6767
<strong {...{"className":""}}>
6868
{`Cog:`}
6969
</strong>
7070
{` House settings such as wrapping lines, showing timestamps, and displaying line numbers.`}
7171
</li>
72-
<li {...{"className":"pf-v6-c-content--li ws-li "}}>
72+
<li {...{"className":"pf-v6-c-content--li pf-m-editorial ws-li "}}>
7373
<strong {...{"className":""}}>
7474
{`Export:`}
7575
</strong>
7676
{` Export log content.`}
7777
</li>
78-
<li {...{"className":"pf-v6-c-content--li ws-li "}}>
78+
<li {...{"className":"pf-v6-c-content--li pf-m-editorial ws-li "}}>
7979
<strong {...{"className":""}}>
8080
{`Download:`}
8181
</strong>
8282
{` Download the log file.`}
8383
</li>
84-
<li {...{"className":"pf-v6-c-content--li ws-li "}}>
84+
<li {...{"className":"pf-v6-c-content--li pf-m-editorial ws-li "}}>
8585
<strong {...{"className":""}}>
8686
{`Fullscreen:`}
8787
</strong>
@@ -91,29 +91,29 @@ const Component = () => (
9191
<AutoLinkHeader {...{"id":"dark-theme-log-viewer","headingLevel":"h2","className":"ws-title ws-h2"}}>
9292
{`Dark theme log viewer`}
9393
</AutoLinkHeader>
94-
<p {...{"className":"pf-v6-c-content--p ws-p "}}>
94+
<p {...{"className":"pf-v6-c-content--p pf-m-editorial ws-p "}}>
9595
{`We recommend using the light theme editor by default, but there is also a dark theme log viewer
9696
available. All log viewer functionality remains the same whether a light or dark theme is used.`}
9797
</p>
98-
<img src={srcImport1} width={srcImport1.width} height={srcImport1.height} {...{"alt":"Dark theme log viewer","className":"ws-img "}}>
98+
<img src={srcImport6} width={srcImport6.width} height={srcImport6.height} {...{"alt":"Dark theme log viewer","className":"ws-img "}}>
9999
</img>
100100
<AutoLinkHeader {...{"id":"usability","headingLevel":"h2","className":"ws-title ws-h2"}}>
101101
{`Usability`}
102102
</AutoLinkHeader>
103-
<p {...{"className":"pf-v6-c-content--p ws-p "}}>
103+
<p {...{"className":"pf-v6-c-content--p pf-m-editorial ws-p "}}>
104104
{`Use a log viewer when:`}
105105
</p>
106-
<ul {...{"className":"pf-v6-c-content--ul ws-ul "}}>
107-
<li {...{"className":"pf-v6-c-content--li ws-li "}}>
106+
<ul {...{"className":"pf-v6-c-content--ul pf-m-editorial ws-ul "}}>
107+
<li {...{"className":"pf-v6-c-content--li pf-m-editorial ws-li "}}>
108108
{`The user can manipulate 1 large log file or multiple log files at the same time.`}
109109
</li>
110-
<li {...{"className":"pf-v6-c-content--li ws-li "}}>
110+
<li {...{"className":"pf-v6-c-content--li pf-m-editorial ws-li "}}>
111111
{`You want to create a more readable and accessible environment for the user.`}
112112
</li>
113-
<li {...{"className":"pf-v6-c-content--li ws-li "}}>
113+
<li {...{"className":"pf-v6-c-content--li pf-m-editorial ws-li "}}>
114114
{`The user may actively search for specific logs within a large log file.`}
115115
</li>
116-
<li {...{"className":"pf-v6-c-content--li ws-li "}}>
116+
<li {...{"className":"pf-v6-c-content--li pf-m-editorial ws-li "}}>
117117
{`The user shares files frequently with other users or teams.`}
118118
</li>
119119
</ul>
@@ -123,26 +123,26 @@ available. All log viewer functionality remains the same whether a light or dark
123123
<AutoLinkHeader {...{"id":"with-popover","headingLevel":"h3","className":"ws-title ws-h3"}}>
124124
{`With popover`}
125125
</AutoLinkHeader>
126-
<p {...{"className":"pf-v6-c-content--p ws-p "}}>
126+
<p {...{"className":"pf-v6-c-content--p pf-m-editorial ws-p "}}>
127127
{`The clear log button opens up a popover with further options, to prevent a user from accidentally clearing their log content.`}
128128
</p>
129-
<img src={srcImport2} width={srcImport2.width} height={srcImport2.height} {...{"alt":"Clear this log popover open on a Log viewer","className":"ws-img "}}>
129+
<img src={srcImport7} width={srcImport7.width} height={srcImport7.height} {...{"alt":"Clear this log popover open on a Log viewer","className":"ws-img "}}>
130130
</img>
131131
<AutoLinkHeader {...{"id":"with-dropdown-drilldown-and-search-expanded","headingLevel":"h3","className":"ws-title ws-h3"}}>
132132
{`With dropdown, drilldown, and search expanded`}
133133
</AutoLinkHeader>
134-
<p {...{"className":"pf-v6-c-content--p ws-p "}}>
134+
<p {...{"className":"pf-v6-c-content--p pf-m-editorial ws-p "}}>
135135
{`The cog icon in the log viewer toolbar allows you to store content options such as timestamps or line numbers for better orientation within the log viewer.`}
136136
</p>
137-
<img src={srcImport3} width={srcImport3.width} height={srcImport3.height} {...{"alt":"Cog options open on a Log viewer","className":"ws-img "}}>
137+
<img src={srcImport8} width={srcImport8.width} height={srcImport8.height} {...{"alt":"Cog options open on a Log viewer","className":"ws-img "}}>
138138
</img>
139139
<AutoLinkHeader {...{"id":"with-search-results","headingLevel":"h3","className":"ws-title ws-h3"}}>
140140
{`With search results`}
141141
</AutoLinkHeader>
142-
<p {...{"className":"pf-v6-c-content--p ws-p "}}>
142+
<p {...{"className":"pf-v6-c-content--p pf-m-editorial ws-p "}}>
143143
{`The search bar provides highlighted search results for better findability within a log viewer’s content.`}
144144
</p>
145-
<img src={srcImport4} width={srcImport4.width} height={srcImport4.height} {...{"alt":"Log Viewer with highlighted search results","className":"ws-img "}}>
145+
<img src={srcImport9} width={srcImport9.width} height={srcImport9.height} {...{"alt":"Log Viewer with highlighted search results","className":"ws-img "}}>
146146
</img>
147147
</React.Fragment>
148148
);

0 commit comments

Comments
 (0)