Skip to content

Commit 2e8e066

Browse files
fix(docs): Convert example to fullscreen (#20)
1 parent d750268 commit 2e8e066

File tree

5 files changed

+12
-5
lines changed

5 files changed

+12
-5
lines changed

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@
1818
"lint": "yarn lint:js && yarn lint:md",
1919
"test": "TZ=EST jest packages",
2020
"test:a11y": "yarn workspace @patternfly/react-console test:a11y",
21-
"serve:a11y": "yarn workspace @patternfly/react-console serve:a11y"
21+
"serve:a11y": "yarn workspace @patternfly/react-console serve:a11y",
22+
"screenshots": "yarn workspace @patternfly/react-console docs:screenshots"
2223
},
2324
"devDependencies": {
2425
"@babel/core": "^7.19.6",

packages/module/patternfly-docs/content/extensions/react-console/examples/ReactConsole.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ import '@patternfly/react-styles/src/css/components/Consoles/xterm.css';
2323
## Examples
2424

2525
### Basic Usage
26-
```js
26+
```js isFullscreen
2727
import React from 'react';
2828
import { AccessConsoles, SerialConsole, VncConsole, DesktopViewer } from '@patternfly/react-console';
2929
import { SerialConsoleCustom } from './SerialConsoleCustom.jsx';

packages/module/patternfly-docs/generated/extensions/react-console/react.js

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,12 @@ import { AutoLinkHeader, Example, Link as PatternflyThemeLink } from '@patternfl
33
import { AccessConsoles, SerialConsole, VncConsole, DesktopViewer } from '@patternfly/react-console';
44
import { SerialConsoleCustom } from '../../../content/extensions/react-console/examples/./SerialConsoleCustom.jsx';
55
import { debounce } from '@patternfly/react-core';
6+
import '@patternfly/react-styles/src/css/components/Consoles/AccessConsoles.css';
7+
import '@patternfly/react-styles/src/css/components/Consoles/DesktopViewer.css';
8+
import '@patternfly/react-styles/src/css/components/Consoles/SerialConsole.css';
9+
import '@patternfly/react-styles/src/css/components/Consoles/VncConsole.css';
10+
import '@patternfly/react-styles/src/css/components/Consoles/xterm.css';
11+
import srcImportbasicusage from './react/basic-usage.png';
612
const pageData = {
713
"id": "React console",
814
"section": "extensions",
@@ -339,7 +345,7 @@ const pageData = {
339345
}
340346
],
341347
"beta": true,
342-
"examples": [
348+
"fullscreenExamples": [
343349
"Basic Usage"
344350
]
345351
};
@@ -356,7 +362,7 @@ pageData.relativeImports = {
356362
};
357363
pageData.examples = {
358364
'Basic Usage': props =>
359-
<Example {...pageData} {...props} {...{"code":"import React from 'react';\nimport { AccessConsoles, SerialConsole, VncConsole, DesktopViewer } from '@patternfly/react-console';\nimport { SerialConsoleCustom } from './SerialConsoleCustom.jsx';\nimport { debounce } from '@patternfly/react-core';\n\nAccessConsolesVariants = () => {\n const [status, setStatus] = React.useState('disconnected');\n const setConnected = React.useRef(debounce(() => setStatus('connected'), 3000)).current;\n const onConnect = React.useCallback(() => {\n setStatus('loading');\n setConnected();\n }, [setConnected])\n const onDisconnect = React.useCallback(() => setStatus('disconnected'), [])\n const ref = React.createRef();\n\n return (\n <AccessConsoles preselectedType=\"SerialConsole\">\n <VncConsole host=\"localhost\" port=\"9090\" encrypt shared />\n <SerialConsole\n onConnect={onConnect}\n status={status}\n onDisconnect={onDisconnect}\n onData={data => {\n ref.current.onDataReceived(data);\n }}\n ref={ref}\n />\n <SerialConsoleCustom type='Serial Console pty2' />\n <DesktopViewer spice={{ address: '127.0.0.1', port: '5900' }} vnc={{ address: '127.0.0.1', port: '5901' }} />\n </AccessConsoles>\n );\n};","title":"Basic Usage","lang":"js"}}>
365+
<Example {...pageData} {...props} thumbnail={srcImportbasicusage} {...{"code":"import React from 'react';\nimport { AccessConsoles, SerialConsole, VncConsole, DesktopViewer } from '@patternfly/react-console';\nimport { SerialConsoleCustom } from './SerialConsoleCustom.jsx';\nimport { debounce } from '@patternfly/react-core';\n\nAccessConsolesVariants = () => {\n const [status, setStatus] = React.useState('disconnected');\n const setConnected = React.useRef(debounce(() => setStatus('connected'), 3000)).current;\n const onConnect = React.useCallback(() => {\n setStatus('loading');\n setConnected();\n }, [setConnected])\n const onDisconnect = React.useCallback(() => setStatus('disconnected'), [])\n const ref = React.createRef();\n\n return (\n <AccessConsoles preselectedType=\"SerialConsole\">\n <VncConsole host=\"localhost\" port=\"9090\" encrypt shared />\n <SerialConsole\n onConnect={onConnect}\n status={status}\n onDisconnect={onDisconnect}\n onData={data => {\n ref.current.onDataReceived(data);\n }}\n ref={ref}\n />\n <SerialConsoleCustom type='Serial Console pty2' />\n <DesktopViewer spice={{ address: '127.0.0.1', port: '5900' }} vnc={{ address: '127.0.0.1', port: '5901' }} />\n </AccessConsoles>\n );\n};","title":"Basic Usage","lang":"js","isFullscreen":true}}>
360366

361367
</Example>
362368
};
5.97 KB
Loading

packages/module/patternfly-docs/generated/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ module.exports = {
33
id: "React console",
44
title: "React console",
55
toc: [[{"text":"Note"}],{"text":"Examples"},[{"text":"Basic Usage"}]],
6-
examples: ["Basic Usage"],
6+
fullscreenExamples: ["Basic Usage"],
77
section: "extensions",
88
subsection: "",
99
source: "react",

0 commit comments

Comments
 (0)