Skip to content
Ashley Neaves edited this page Sep 6, 2023 · 2 revisions

Welcome to the odin-react wiki!

Odin React is a React package designed to make the development of GUIs for Odin Control interfaces easier, faster, and more uniform. In the past, any and all GUIs developed alongside Odin Control software have been bespoke HTML and javascript, with several hundred lines for each file, and complicated means of linking html elements with corresponding javascript functionality, with long lists of document.getElementByID methods to access the html elements.

Using React, creating functionality is now much more simple, and with some of the Odin React components created, a lot of the hard work of connecting components to an Odin Control Adapter is done for you.

The components within Odin Control are built upon the Bootstrap React library, which provides access to the modern style components, as well as many means of controlling the layout of the page. This also means Odin React Apps are automatically responsive, and will be viewable on multiple screen sizes, reorganising the page so that everything fits properly.

Within this wiki are descriptions of each component, and a list of their properties. Additionally, some basic tutorial style pages have been created to demonstrate some of the ways these components might come together to create a GUI.

These tutorials will expect a basic understanding of how React works, and so it is recommended you complete the tutorial available on the react website, here

Within the Odin React repo, there is also an Example Project that can be run alongside the example Odin Control Adapter, to see how a fully functional React App GUI might look and work.

Clone this wiki locally