Get Started

Overview

We recommend the following steps to start developing with LUCI:

1. Get an overview of our coding standards, including the class naming conventions used in our CSS.
2. Review the components for semantically correct and accessible markup and documentation.
3. Follow the development-environment—specific getting-started steps below.

General Installation Instructions

The LUCI zip file contains the compiled CSS and SVG sprite for the icons. Once you have downloaded it, you can link to the CSS from your index.html page and use SVG icons in your components.

Setting up LUCI With npm

The following steps will prepare you to work with LUCI in a local Node.js development environment.

We will assume you have knowledge of the following:

• Nodes.js
• npm
• Browsersync

1. Initialize your project.

   a. Once you've dowloaded and installed the prerequisites for your node environment, create a folder for your project.

     $ mkdir luci-demo
     $ cd luci-demo
   

   b. Inside your luci-demo, folder create a package.json file with defaults set.

     $ npm init --yes
   

   Figure: Example package.json file

2. Install the following npm packages as dependencies:

   a. LUCI

   $ npm install --save @netapp/luci

   b. Browsersync will allow you to run a local server and see your changes in your favorite web browser.

   $ npm install --save-dev browsersync

   Figure: Updated package.json file

3. Add LUCI to your project by linking to the compiled LUCI stylesheet in your index.html file.

   Figure: Index file with link to LUCI stylesheet

4. Copy and paste the basic form code example into your index.html file.

   Figure: Index file with LUCI form

5. Execute the following command to start a local web server:

   $ browser-sync start --server

   Figure: LUCI web page with basic form

Setting up LUCI With Sass

In order to take advantage of some of the LUCI Sass features such as tokens and mixins, you will need to set up your project to use Sass. Because Sass is a preprocessor for CSS, you will need to install additional tools to compile Sass to CSS.

We recommend the following:

• Gulp.js
• gulp-sass

We will assume you completed the steps to set up LUCI with npm.

1. npm install Gulp and gulp-sass.

   $ npm install --save-dev gulp gulp-sass

   Figure: Updated package.json

2. Create a gulpfile.js file in the root folder of your project and copy and paste the following code:

    const gulp = require('gulp');
    const sass = require('gulp-sass');
   
    gulp.task('sass', function() {
      return gulp.src('./styles/*.scss')
        .pipe(sass())
        .pipe(gulp.dest('./dist/css'));
    });
   

3. Create a scss stylesheet.

   a. In the luci-demo project, create a new styles folder.

   b. In the styles folder, create a master.scss file, for example.

   c. Import the LUCI token and typography partials at the top of your master.scss file.

   Figure: Imported LUCI partials

4. Reset the body text to match LUCI styles.

   Figure: Font reset example

5. Add an h1 to your stylesheet and use the LUCI mixin to style the h1.

   Figure: Heading mixin

6. Update your index.html file to the following:

   Figure: Updated index.html

7. Compile your stylesheet and view your changes in the browser.

    $ gulp sass
    $ browser-sync start --server
   

   Figure: Hello LUCI page

Review How to design with tokens for additional information about how to use tokens with existing HTML.

Using LUCI with Angular

Installing LUCI

Run:

 npm install @netapp/luci --save

to install LUCI in your Angular app.

Add LUCI styles

LUCI component styles are available as scss or css and can be added to your Angular app using either method. If you intend to use LUCI's components in your app, it's best to include the entire LUCI library.

If you're not using LUCI components in your application but do want to use LUCI's design tokens to style your application you can install tokens only via scss.

Install via scss

In your Angular app, add the following:

This import will give you access to component styles AND all LUCI tokens.

To install scss tokens only

In your Angular app, add the following:

Refer to the Styling With Tokens guide for more information on using Design Tokens.

Install css

In your Angular app, add the following:

Include LUCI icons

LUCI's icons are available as an SVG sprite within the LUCI npm package. To include the LUCI icon sprite in your Angular project, add it to the "assets" key in your angular.json config file:

Be sure to add the reference under both the "build" and "test" configurations in the angular.json file:

• projects.your-project-name.architect.build.options.assets
• projects.your-project-name.architect.test.options.assets

Use LUCI markup within your app

Find a component on http://luci.netapp.com that you want to use within your app and click the "Copy Code" button.

Paste the component into your Angular app.

In this example some LUCI Button markup has been copied into the default app template

You now have access to all of LUCI's styles and can weave LUCI markup into your Angular app as you see fit.

Follow Accessibility Guidelines

When using component markup in your Angular application, be sure to reference the "Accessibility" section of the component documentation on luci.netapp.com. For example: LUCI Button Accessibility Guidelines

The Accessibility Guidelines sections have been authored for each component, where relevant, and ensure we're providing the best experience for all NetApp product users.

Creating Angular Components

Angular provides a convenient means for reusing units of visual style and functionality via Angular components. These align nicely with LUCI's definition of components and LUCI's components can be ported into Angular's component model.

This portion of the guide will start with the LUCI Button component and create an Angular component called <luci-button> that can be used within the angular app.

Generate an Angular component

In your Angular app run:

ng generate component luci-button --inline-template --inline-style

This will generate two new files:

• src/app/luci-button/luci-button.component.spec.ts - a test file, leave alone for now
• src/app/luci-button/luci-button.component.ts - a file for the button component itself

Modify the selector in the component definition to be simply luci-button and update the template with Button HTML copied and pasted from the LUCI site:

Next, call the newly created component in your app using the <luci-button> element.

You should see the LUCI button component rendered when you start your Angular app locally:

Adding flexibility with Input props

In order to make the <luci-button> component more useful, add Input props to control various aspects of the button.

Add a "text" Input prop that will allow button text to be changed dynamically when calling instances of <luci-button>.

Next, call multiple instances of <luci-button> within your app, using the text attribute to change the Button's test.

Instances of <luci-button> can now have their text set programatically.

Adding Additional Props

Extend this concept further by adding Input props for size and variant. Refer to Button's class reference docs for all the possible button variations and the corresponding CSS classes required to enable them.

Update the button component

Next, update the component calls in the application.

Continue adding Input props and additional functionality to map the LUCI CSS API for Button to the Angular component. Always include accessibility requirements for each component when mapping LUCI's documentation to Angular.