Giter Club home page Giter Club logo

thorium-ui's Introduction

thorium logo NPM

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.

Documentation

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

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.

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

Your App.jsx 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!

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.