@stellaestudio/css

Ready2order Design System - Foundation global CSS styles library

Install package

After installing npm or yarn, you can install @stellaestudio/css with this command:

# with npm
npm i -S @stellaestudio/css

# with yarn
yarn add @stellaestudio/css

Or you can also install it with a CDN like unpkg.com:

<link rel="stylesheet" href="https://unpkg.com/@stellaestudio/css" />

Install fonts

Roboto & Roboto Condensed

Shown below is a sample link markup used to load from a CDN:

<link
  rel="stylesheet"
  href="https://fonts.googleapis.com/css2?family=Roboto:wght@400;700&family=Roboto+Condensed:ital,wght@0,400;0,700;1,700&display=swap"
/>

You can also do it via CSS Import:

@import url('https://fonts.googleapis.com/css2?family=Roboto:wght@400;700&family=Roboto+Condensed:ital,wght@0,400;0,700;1,700&display=swap');

Otherwise, you can install them with typeface:

# with npm
npm i -S typeface-roboto typeface-roboto-condensed

# with yarn
yarn add typeface-roboto typeface-roboto-condensed

Then, you can import them in your entry-point:

import 'typeface-roboto';
import 'typeface-roboto-condensed';

Install icons (optional)

If you need to display icons, you will need to install @stellaestudio/r2icon package.

# with npm
npm i -S @stellaestudio/r2icon

# with yarn
yarn add @stellaestudio/r2icon

Then follow instructions in README of @stellaestudio/r2icon :

import '@stellaestudio/r2icon/dist/r2icon/font/r2icon.css';

Or you can also import it with a CDN like unpkg.com with this file.

Usage

Once you have installed this package, you just have to import CSS styles!

With a bundler that supports CSS imports in JS files:

import '@stellaestudio/css/dist/index.css';

Otherwise include it in your HTML file:

<link
  rel="stylesheet"
  href="./node_modules/@stellaestudio/css/dist/index.css"
/>

Development

All this package is generated with Tailwind CSS, a utility-first CSS framework that can be composed to build any design, directly in your markup. Be careful, in order to use our library, you will have to prefix all CSS utility classes with r2o-.

For example:

<div
  class="r2o-flex r2o-bg-brand-digital-light-3 r2o-rounded-lg r2o-p-6 r2o-mb-5"
>
  <p class="r2o-text-xl r2o-text-center r2o-font-semibold r2o-text-black">
    Hello
    <span class="r2o-text-brand-digital r2o-text-2xl">World!</span>
    <span role="img" aria-label="Welcome menu"> 🎉 </span>
  </p>
</div>

For more details about CSS utility classes from this package, see Tailwind CSS documentation here.

Tailwind preset

Are you already using Tailwind CSS in your project? Do you want to take full advantage of all its features like functions & directives by building your own classes via @apply for example? Good news, we invit you to have a look at our package @stellaestudio/css-tailwind-preset which will explain you how to use Foundation styles in a Tailwind CSS project.

Optimizing for production

To make the development experience as productive as possible, Tailwind generates thousands of utility classes for you, most of which you probably won't actually use.

When building for production, you should always use PurgeCSS to tree-shake unused styles and optimize your final build size.

Base 10 support

If your project uses the mathematical trick of basing the value of 1rem equals 10px, there is also an index-base10 output within the dist folder of this package.

License

Apache-2.0 ©