https://github.com/patternfly/react-console
This package provides VncConsole, SerialConsole and DesktopViewer React components
https://github.com/patternfly/react-console
hacktoberfest
Last synced: 8 months ago
JSON representation
This package provides VncConsole, SerialConsole and DesktopViewer React components
- Host: GitHub
- URL: https://github.com/patternfly/react-console
- Owner: patternfly
- License: mit
- Created: 2023-01-13T12:26:30.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-14T15:18:24.000Z (10 months ago)
- Last Synced: 2025-05-01T08:24:37.177Z (8 months ago)
- Topics: hacktoberfest
- Language: TypeScript
- Homepage:
- Size: 919 KB
- Stars: 4
- Watchers: 10
- Forks: 14
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# React Console
This package provides VncConsole, SerialConsole and DesktopViewer React components
to be used alongside patternfly-react to access virtual machine or server consoles.
### Installing
```
yarn add @patternfly/react-console
```
or
```
npm install @patternfly/react-console --save
```
### Usage
It's strongly advised to use the PatternFly Base CSS in your whole project, or some components may diverge in appearance:
```js
import '@patternfly/react-core/dist/styles/base.css';
```
```js
import { VncConsole, SerialConsole } from '@patternfly/react-console';
```
### Building
```
yarn build
```
Note the build scripts for this are located in the root package.json under `yarn build`.
### Testing
Testing is done at the root of this repo.
```
yarn test
```
### Publishing
```
yarn publish
```