@inaccess-unity/uds

The Inaccess Unity Design System (UDS) library for the Front-end projects

Usage no npm install needed!

<script type="module">
  import inaccessUnityUds from 'https://cdn.skypack.dev/@inaccess-unity/uds';
</script>

README

Unity Design System Library

The Inaccess Unity Design System (UDS) library for the Front-end projects

Overview

A css application for the UI that will be used for all internal front-end projects in Inaccess.

Pre-requisites

  • (Required) Node.js >= 12 installation.
  • (Required) NPM 6.x installation.
  • (Optional) GIT installation.

Targeted Browsers

  • Chrome
  • Firefox
  • Safari
  • Opera
  • Edge

Installing the UDS library

Install the UDS library from NPM, by executing in the terminal at any project's root:

npm install @inaccess-unity/uds --save

Using the UDS library

Use the UDS library, by following the next steps:

  • Import the library in your project's main style file:

    @import '~/@inaccess-unity/uds/uds-ui';

  • Use 'uds-ui' attribute along with either 'light-theme' or 'dark-theme' classes:

    <div uds-ui class='light-theme'>....</div>

  • Done, now you have access to the classes