Awesome

OAM Design System

The following guide only explains how to include the oam-design-system in a new project. For usage information check the documentation website.

For information on how to develop the oam-design-system checkout the DEVELOPMENT.md

Style guide and UI components library that aims to standardize the look and feel across all OAM-related applications, while defining coding best practices and conventions.

Install it as an npm module: (module not available yet. use direct link)

npm install https://github.com/hotosm/oam-design-system#v1.0.0

For the most recent version omit the tag.

Note: This design system makes some assumptions which are described below for each of the elements.
Check the build system of OAM docs, a project that uses the oam-design-system.

Overview

The shared assets are all in the assets directory. It is organized as follows:

assets/scripts

Utility libraries and shared components.

USAGE
Use as any node module:

import { Dropdown, user } from 'oam-design-system';

If you want to minimize bundle size you can also include the components directly.
Bindings exported from oam-design-system are also available in oam-design-system/assets/scripts

assets/styles

Requires Bourbon and Jeet.

INSTALLATION
Add the module path to the includePaths of gulp-sass. Should look something like:

.pipe($.sass({
  outputStyle: 'expanded',
  precision: 10,
  includePaths: require('node-bourbon').with('node_modules/jeet/scss', require('oam-design-system/gulp-addons').scssPath)
}))

The oam-design-system uses Open Sans which is available on Google Fonts.
It needs to be included in the app:

<link rel="stylesheet" type="text/css" href="//fonts.googleapis.com/css?family=Open+Sans:300italic,400italic,700italic,400,300,700" />

USAGE
Now you can include it in the main scss file:

// Bourbon is a dependency
@import "bourbon";

@import "jeet/index";

@import "oam-design-system";

assets/icons

The oam-design-system includes svg icons that are compiled into a webfont and included in the styles.
To use them check the _oam-ds-icons.scss for the class names.

assets/graphics

Graphics that are to be shared among projects.

INSTALLATION
Add the graphicsMiddleware to browserSync. This is only to aid development.
Should look something like:

browserSync({
  port: 3000,
  server: {
    baseDir: ['.tmp', 'app'],
    routes: {
      '/node_modules': './node_modules'
    },
    middleware: require('oam-design-system/gulp-addons').graphicsMiddleware(fs) // <<< This line
  }
});

Basically every time there's a request to a path like /assets/graphics/**, browserSync will check in the oam-design-system folder first. If it doesn't find anything it will look in the normal project's asset folder.

You also need to ensure that the images are copied over on build. This ensures that the graphics are copied over when building the project.

gulp.task('images', function () {
  return gulp.src(['app/assets/graphics/**/*', require('oam-design-system/gulp-addons').graphicsPath + '/**/*'])
    .pipe($.cache($.imagemin({

USAGE
Just include the images using the path assets/graphics/[graphic-type]/[graphic-name].
All available images can be found here.

License

Oam Design System is licensed under BSD 3-Clause License, see the LICENSE file for more details.