Package Exports

thorium-ui

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (thorium-ui) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Thorium-UI

To read the full documentation, please visit https://thorium-ui-preview.now.sh/.

Please note, this documentation is only updated periodically and does not always represent the current state of the project

Overview

Thorium-UI is designed to be an intuitive React.js framework, with which to quickly build themed applications, without needing a ton of CSS clutter.

Getting Started

Use the following instructions to get up and running with Thorium-UI.

Installation

npm i thorium-ui

Using ThoriumRoot

Once you've successfully installed Thorium-UI, some very minimal boilerplate is needed to get up and running.

In your App.js file, begin by importing the ThoriumRoot component from Thorium-UI.
Wrap the ThoriumRoot around the rest of your App contents.
(optional) If you're using customThemes or customStyles, import them at the top of your App.js file, and pass them as corresponding props to ThoriumRoot.

Your App.js file should look like the following.

import React from "react";
import { ThoriumRoot } from "thorium-ui";
import customStyles from "customStyles.js";
import customThemes from "customThemes.js";

 export const App = (props) => {
   return (
     <ThoriumRoot customStyles={customStyles} customThemes={customThemes}>
        /* YOUR COMPONENTS HERE */
     </ThoriumRoot>
   );
 }
export default App;

Thats It!

With that finished, you're now ready to begin using Thorium-UI!