Git Product home page Git Product logo

redsift-ui's Introduction

RedsiftUI

Circle CI

RedsiftUI is a user interface library for rapid development of Sifts and other Red Sift applications. The documentation is available at here.

This repository does not contain UI components itself. It contains logic to grab available Red Sift UI components from NPM and to bundle them into packages. Those packages are then served by our CDN as UMD modules. There are multiple bundles which you can use:

core bundle

Contains the Redsift theme in the light and dark flavour, as well as UI logic shared between components.

To use the bundle add the following HTML to your project:

<!-- in the <head> section -->
<link rel="stylesheet" href="//static.redsift.io/ui/latest/css/core/redsift-light.min.css">
<!-- or the dark theme: -->
<link rel="stylesheet" href="//static.redsift.io/ui/latest/css/core/redsift-dark.min.css">

<!-- in the <body> section -->
<script src="//static.redsift.io/ui/latest/js/core/redsift.umd.min.js"></script>
sift bundle

This is probably the most important one to start with Sift development. It contains the Redsift theme in the light and dark flavour, together with the rs-hero component.

To use the bundle add the following HTML to your project:

<!-- in the <head> section -->
<link rel="stylesheet" href="//static.redsift.io/ui/latest/css/sift/redsift-light.min.css">
<!-- or the dark theme: -->
<link rel="stylesheet" href="//static.redsift.io/ui/latest/css/sift/redsift-dark.min.css">

<!-- in the <body> section -->
<script src="//static.redsift.io/ui/latest/js/sift/redsift.umd.min.js"></script>
full bundle

To get all the functionality provided by RedsiftUI use this bundle. It contains the Redsift theme in the light and dark flavour, together with the following (data visualization) components:

  • rs-hero: A hero unit for your Sift or app
  • rs-radial-chart: A radial chart for visualizing monthly data
  • rs-schedule: A scheduling component

To use the bundle add the following HTML to your project:

<!-- in the <head> section -->
<link rel="stylesheet" href="//static.redsift.io/ui/latest/css/full/redsift-light.min.css">
<!-- or the dark theme: -->
<link rel="stylesheet" href="//static.redsift.io/ui/latest/css/full/redsift-dark.min.css">

<!-- in the <body> section -->
<script src="//static.redsift.io/ui/latest/js/full/redsift.umd.min.js"></script>

Development and Customization

The bundles are provided to start quickly with developing your Sifts or applications. To have more control on which parts to include into your project you are encouraged to use the UI components directly. The components are develop in ES2015 for the Javascript and with the Stylus CSS preprocessor. It is easy to integrate and customize these components into your projects. Have a look at the ./bundles folder to get an idea on how to integrate the functionality into your own projects. The following components are available as separate repositories and also als NPM modules:

Development Setup

For development directly within this repository run

> npm run serve

within the repository folder. It will start a web server serving the content of ./samples and supports live-reloading when a source file is changed.

redsift-ui's People

Contributors

cv711 avatar martinhecher avatar rahulpowar avatar randalpinto avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

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.