Skip to content

Commit

Permalink
fix(docs): Convert example to fullscreen (#20)
Browse files Browse the repository at this point in the history
  • Loading branch information
wise-king-sullyman authored Feb 22, 2023
1 parent d750268 commit 2e8e066
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 5 deletions.
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@
"lint": "yarn lint:js && yarn lint:md",
"test": "TZ=EST jest packages",
"test:a11y": "yarn workspace @patternfly/react-console test:a11y",
"serve:a11y": "yarn workspace @patternfly/react-console serve:a11y"
"serve:a11y": "yarn workspace @patternfly/react-console serve:a11y",
"screenshots": "yarn workspace @patternfly/react-console docs:screenshots"
},
"devDependencies": {
"@babel/core": "^7.19.6",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ import '@patternfly/react-styles/src/css/components/Consoles/xterm.css';
## Examples

### Basic Usage
```js
```js isFullscreen
import React from 'react';
import { AccessConsoles, SerialConsole, VncConsole, DesktopViewer } from '@patternfly/react-console';
import { SerialConsoleCustom } from './SerialConsoleCustom.jsx';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@ import { AutoLinkHeader, Example, Link as PatternflyThemeLink } from '@patternfl
import { AccessConsoles, SerialConsole, VncConsole, DesktopViewer } from '@patternfly/react-console';
import { SerialConsoleCustom } from '../../../content/extensions/react-console/examples/./SerialConsoleCustom.jsx';
import { debounce } from '@patternfly/react-core';
import '@patternfly/react-styles/src/css/components/Consoles/AccessConsoles.css';
import '@patternfly/react-styles/src/css/components/Consoles/DesktopViewer.css';
import '@patternfly/react-styles/src/css/components/Consoles/SerialConsole.css';
import '@patternfly/react-styles/src/css/components/Consoles/VncConsole.css';
import '@patternfly/react-styles/src/css/components/Consoles/xterm.css';
import srcImportbasicusage from './react/basic-usage.png';
const pageData = {
"id": "React console",
"section": "extensions",
Expand Down Expand Up @@ -339,7 +345,7 @@ const pageData = {
}
],
"beta": true,
"examples": [
"fullscreenExamples": [
"Basic Usage"
]
};
Expand All @@ -356,7 +362,7 @@ pageData.relativeImports = {
};
pageData.examples = {
'Basic Usage': props =>
<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"}}>
<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}}>

</Example>
};
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion packages/module/patternfly-docs/generated/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ module.exports = {
id: "React console",
title: "React console",
toc: [[{"text":"Note"}],{"text":"Examples"},[{"text":"Basic Usage"}]],
examples: ["Basic Usage"],
fullscreenExamples: ["Basic Usage"],
section: "extensions",
subsection: "",
source: "react",
Expand Down

0 comments on commit 2e8e066

Please sign in to comment.