Note
React console lives in its own package at @patternfly/react-console
Examples
Props
AccessConsoles
Name | Type | Default | Description |
---|---|---|---|
preselectedType | No type info | null | |
textDesktopViewerConsole | No type info | 'Desktop viewer' | |
textSelectConsoleType | No type info | 'Select console type' | |
textSerialConsole | No type info | 'Serial console' | |
textVncConsole | No type info | 'VNC console' |
SerialConsole
Name | Type | Default | Description |
---|---|---|---|
onConnectrequired | () => void | Initiate connection to backend. In other words, the calling components manages connection state. | |
onDatarequired | (e: string) => void | Terminal produced data, like key-press | |
onDisconnectrequired | () => void | Close connection to backend | |
cols | number | The number of columns to resize to | |
fontFamily | string | ||
fontSize | number | ||
innerRef | React.RefObject<any> | A reference object to attach to the SerialConsole. | |
onTitleChanged | () => void | Terminal title has been changed | |
rows | number | The number of rows to resize to | |
status | string | ||
textConnect | string | Text content rendered inside the Connect button | |
textDisconnect | string | Text content rendered inside the Disconnect button | |
textDisconnected | string | ||
textLoading | string | ||
textReset | string | Text content rendered inside the Reset button |
VncConsole
Name | Type | Default | Description |
---|---|---|---|
additionalButtons | No type info | [] | |
clipViewport | No type info | false | |
dragViewport | No type info | false | |
encrypt | No type info | false | |
onDisconnected | No type info | () => {} | |
path | No type info | '' | |
port | No type info | '80' | |
repeaterID | No type info | '' | |
resizeSession | No type info | true | |
scaleViewport | No type info | false | |
shared | No type info | false | |
textConnect | No type info | 'Connect' | |
textConnecting | No type info | 'Connecting' | |
textDisconnect | No type info | 'Disconnect' | |
textDisconnected | No type info | 'Click Connect to open the VNC console.' | |
viewOnly | No type info | false | |
vncLogging | No type info | 'warn' |
DesktopViewer
Name | Type | Default | Description |
---|---|---|---|
children | React.ReactNode | null | Custom content of more-info section |
rdp | ConsoleDetailPropType | null | Connection details for RDP |
spice | ConsoleDetailPropType | null | Connection details for Spice |
textAddress | string | ||
textConnectWith | string | ||
textConnectWithRDP | string | ||
textConnectWithRemoteViewer | string | ||
textManualConnection | string | ||
textMoreInfo | string | Text that appears in the toggle | |
textMoreInfoContent | string | React.ReactNode | The information content appearing above the description list for guidelines to install virt-viewer | |
textMoreRDPInfo | string | Text that appears in the toggle | |
textMoreRDPInfoContent | string | React.ReactNode | The information content appearing above the description list for guidelines to install virt-viewer | |
textNoProtocol | string | ||
textRdpAddress | string | ||
textRDPPort | string | ||
textSpiceAddress | string | ||
textSpicePort | string | ||
textSpiceTlsPort | string | ||
textVNCAddress | string | ||
textVNCPort | string | ||
textVNCTlsPort | string | ||
vnc | ConsoleDetailPropType | null | Connection details for VNC |