React Orcus

React library for creating an app with a windowed desktop interface.

• Installation/Setup
• Examples
• API

Installation/Setup

Run:

npm install react-orcus

and then import it in your app:

import Orcus from 'react-orcus';

-- OR --

Include it in your HTML header:

<script type="text/javascript" src="./react-orcus/dist/react-orcus.min.js"></script>

Then, in your React component:

var Desktop = (
    
    <Orcus.Desktop>
        <Orcus.App
            slug="file-manager"
            name="File Manager"
            icon="fa:folder"
            initialOpened={true}
            initialPosition={[150, 200, 500, 300]}    // [x, y, w, h]
        >
            <h1>Welcome to my File Manager</h1>

            <p>Yeah so.... building a file manager is really hard.
            But please enjoy this complimentary welcome paragraph!</p>
        </Orcus.App>

        <Orcus.App
            slug="tetris"
            name="Tetris"
            icon="fa:th-large"
            initialPosition={[550, 200, 280, 450]}    // [x, y, w, h]
        >
            <p>Does anyone know how to build a tetris game?</p>
        </Orcus.App>
    </Orcus.Desktop>
    
);

Examples

API