tuxx
Version:
Framework built on React and Flux
24 lines (17 loc) • 1.54 kB
Markdown
# Tuxx Modularity
## Table of Contents
<ol>
<li><a href="#Premise">Premise</a></li>
<li><a href="#Implementation">Implementation</a></li>
</ol>
## <a id="Premise"></a>Premise [#](#Premise)
>Tuxx is a completely modular framework. This means that you can use as much or as little of Tuxx as you want in your own development projects. Whereas, most other frameworks have your require the whole framework every time you want to use a feature of it, with Tuxx you only have to require the Tuxx module you need and not the entire framework.
***
## <a id="Implementation"></a>Implementation [#](#Implementation)
Tuxx's modular nature allows you to only require specifics modules you need. For example, if you wanted to require React and the default Fade animation component in your particular project, you need only:
```javascript
var React = require('tuxx/React');
var Fade = require('tuxx/Animations/Fade');
```
Requiring specific Tuxx modules is simple. All you need to do is follow a basic folder hierarchy path in your require statements. Every Tuxx require statement starts with a **lowercase** `tuxx` followed by a `/`, the **capitalized** sub directory you want to require and another `/` and **capitalized** module name for each level of specificity within that folder.
**Note:** When requiring a module like `('tuxx/Animations')`, it will look at the index.js file within that module by default. In this case, the index.js within Animations exposes the `createAnimation` function by requiring TuxxAnimations from Tuxx.