Uix Kit

Getting Started
Description
Installation And Test
How To Use？
Contributing
Changelog
Browser Support
Licensing
Buy Me a Coffee

Getting Started

Description

Make over 100+ components to wear again and again!

An underlying front-end system that makes it easy to extend and modify core files. This spec is a living document that will be updated as we continue to develop the tenets and specifics of Uix Kit. Support JS and CSS component( Sass Format ) development with Gulp & Webpack together.

Enjoy the fluid grid system based on Bootstrap and self-expansion. Uix Kit is built over Bootstrap and has all the benefits that the framework comes with. Regardless of the screen size, the website content will naturally fit the given resolution. Using the Uix Kit will save you large amount of time to build your projects. It supports 3D and 2D rendering with three.js and pixi.js. More typically, automatically generate core files with Gulp & Webpack for each module (contains .js, .scss, .html files).

Supports 3D and 2D rendering with three.js and pixi.js.
Using Sass to Control Scope With BEM Naming
Automatically generate table of contents with Gulp for each module comment of name.
Simple custom CSS and JS core files
100% Responsive & Mobile Ready
Prepare some generic plug-ins in advance
Core style sheet compatible with Bootstrap 3.x (Optimized reference to Bootstrap 4.x)
Provides a common web page components and layouts
W3C Standard Support
Support PJAX no refresh method for loading pages
Support JS and CSS component( Sass Format ) development with Gulp & Webpack together

Installation And Test

Step 1. Use NPM (Locate your current directory of project, and enter the following command.) or download the latest version from Github. For nodejs you have to install some dependencies.

$ npm install uix-kit

Or clone the repo to get all source files including build scripts:

$ git clone git://github.com/xizon/uix-kit.git
$ cd uix-kit

Step 2. Before doing all dev stuff make sure you have node installed. After that, run the following code in the main directory to install the node module dependencies.

$ npm install --dev

Step 3. Run the following code to enter development mode.

$ gulp default

Step 4. When you done, please open the browser and enter the following URL to check out.

http://localhost:8080/examples/

Step 5. Directly edit the entries in the components folder in order to modify the core files. (E.g. examples/assets/css/uix-kit.css, examples/assets/css/uix-kit.min.css, examples/assets/css/rtl/uix-kit-rtl.css, examples/assets/js/uix-kit.js, examples/assets/js/uix-kit.min.js ).

Components:

HTML/JS/CSS Components: _components/*
00.global and 01.index are required components.

How To Use

1. HTML Structure

<!DOCTYPE html>
<html dir="ltr" lang="en-US">
	<head>
		<meta charset="utf-8" />
		<title></title>	
        
		<!-- Mobile Settings
		============================================= -->
        <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1" />
        <!-- Mobile Settings end -->
        
		<!-- Core library
		============================================= -->
		<script src="assets/js/wp-jquery/jquery.min.js?ver=2.1.3"></script>
		<script src="assets/js/wp-jquery/jquery.migrate.min.js?ver=1.4.1"></script>
		<script src="assets/js/min/prefixfree.min.js?ver=1.0.7"></script>
		<!-- Core library  end -->
		
		
		<!-- Compatibility
		============================================= -->
        <meta http-equiv="X-UA-Compatible" content="IE=edge">
        
        <script src="assets/js/min/modernizr.min.js?ver=3.5.0"></script>
        
        <!--[if lt IE 9]>
            <script src="assets/js/min/respond.min.js?ver=1.4.2"></script>
        <![endif]-->
        
        <!-- Compatibility  end -->



		<!-- Core & Theme CSS
		============================================= -->
        
        <!-- Basic  -->
        <link rel="stylesheet" href="assets/css/bootstrap.min.css?ver=3.3.7" media="all"/>
		<link rel="stylesheet" href="assets/css/video.min.css?ver=5.19" media="all"/>
		
        <!-- Icons  -->
        <link rel="stylesheet" href="assets/fonts/fontawesome/font-awesome.min.css?ver=4.5" media="all" />  
        
        <!-- Theme  -->
        <link rel="stylesheet" href="assets/css/uix-kit.min.css?ver=1.0.0" media="all"/>
        
     
         <!--[if lt IE 10]>
           <link rel="stylesheet" href="assets/css/uix-kit.IE.css?ver=1.0.0" media="all" />
        <![endif]-->
        
        
        <!-- Core & Theme CSS  end -->
        
     
  </head>     
  <body>
  
  
          
    ...

  

    <!-- Basic Script -->
	<script src="assets/js/min/jquery.easing.min.js?ver=1.3"></script>
    <script src="assets/js/min/jquery.waitforimages.min.js?ver=1.0"></script>
    <script src="assets/js/min/video.min.js?ver=5.19"></script> 
	<script src="assets/js/min/jquery.waypoints.min.js?ver=4.0.1"></script> 
    <script src="assets/js/min/template7.min.js?ver=1.2.5"></script>
    <script src="assets/js/min/TweenMax.min.js?ver=1.20.4"></script>
    <script src="assets/js/min/pixi.min.js?ver=4.7.1"></script>
    <script src="assets/js/min/three.min.js?ver=r92"></script>
    <script src="assets/js/min/anime.min.js?ver=2.2.0"></script>
	<script src="assets/js/min/jquery.pjax.new.min.js?ver=20180704"></script>
    
    <!-- Masonry -->
    <script src="assets/js/wp-jquery/masonry.min.js?ver=3.3.2"></script>
    <script src="assets/js/wp-jquery/imagesloaded.min.js?ver=4.1.0"></script>

    <!-- Filterable  -->
    <script src="assets/js/min/jquery.shuffle.min.js?ver=3.1.1"></script> 
    
    
	
	<!-- Your Plugins & Theme Scripts
	============================================= -->

	<script>
		var REVISION     = "1.0.0",
			APP_ROOTPATH = {
				"templateUrl" : "", //If the file is in the root directory, you can leave it empty. If in another directory, you can write: "/blog"
				"homeUrl"     : "",  //Eg. https://uiux.cc
				"ajaxUrl"     : ""   //Eg. https://uiux.cc/wp-admin/admin-ajax.php
			};
    </script>  
    <script src="assets/js/uix-kit.min.js?ver=1.0.0"></script>


  </body>
</html>

2. File Structures

uix-kit/
├── README.md
├── gulpfile.js
├── main.js
├── LICENSE
├── package-lock.json
├── package.json
├── docs/
├── _grid/
├── _screenshots/
├── _components/
│   ├── 00.global/
│   ├── 01.*/
│   └── 02.*/
├── examples/
│   ├── assets/
│   │       ├── css/
│   │       ├── fonts/
│   │       ├── images/
│   │       ├── videos/
│   │       ├── models/
│   │       ├── json/
│   │       └── js/
└──

HTML/JS/CSS Components:

_components/*

Custom Core Files:

You can customize these files to meet the different needs of the site you want :-)

examples/assets/css/uix-kit.css
examples/assets/css/uix-kit.min.css
examples/assets/css/uix-kit.IE.css
examples/assets/css/rtl/uix-kit-rtl.css
examples/assets/js/uix-kit.js
examples/assets/js/uix-kit.min.js

3. PSD Grid Templates

You can download the corresponding .PSD grid files based on Bootstrap 3.x from the _grid folder.

_grid/bootstrap3_1170_grid_web.psd (Default Container: 1170px)
_grid/bootstrap3_1278_grid_web.psd (XL Container: 1278px)
_grid/bootstrap3_1410_grid_web.psd (XXL Container: 1410px)

Contributing

Finding bugs, sending pull requests or improving our docs - any contribution is welcome and highly appreciated. To get started, head over to our contribution guidelines. Thanks!