Ride-components

Ride-components is a set of css and html components for your web applications and websites.

install

To install type in your console

  npm install ride-components --save

in your build file you can call ride-components this way

'use strict';

var stylus = require('stylus');
var rideComponents = require('ride-components');

stylus
  .use(rideComponents())
  .render(filecontent, (error, out) => { /* something here */ })

or with gulp

'use strict';

var gulp = require('gulp');
var gulpStylus = require('gulp-stylus');
var rideComponents = require('ride-components');

gulp.task('mystylusbuild', () => {
  gulp.src('path-to-file')
    .pipe(gulpStylus({
      use: [
        rideComponents()
      ]
    }))
    .pipe(gulp.dest('path-to-compiled-file'))
});

From your stylus sheet

@require 'ride-components/colors'
@require 'ride-components/vars'

// change vars here

@require 'ride-components/lib/bundle'

You can also decide to include separated components

@require 'ride-components/colors'
@require 'ride-components/vars'

// change vars here

@require 'ride-components/lib/ui/baloons/_baloon'
@require 'ride-components/lib/ui/cards/_cards'

docs

Read the docs online

licence

The MIT License (MIT) Copyright (c) 2016-present Paolo Roth and contributors

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.