Skip to main content

Quick Start

Follow our simple quick start guide to jumpstart your project.

Quick Start

Tokens​

Install @galaxy-ds/tokens@3.0.1 and consume the published LEAP web tokens directly. Do not copy hex or font values out of Storybook by hand — import the package's CSS, SCSS, or JS exports so values stay in sync with the package.

npm install @galaxy-ds/tokens@3.0.1

CSS variables​

import '@galaxy-ds/tokens/leap/web/tokens.css';
.button {
color: var(--color-primary-main); /* #1C365F */
background-color: var(--color-secondary-main); /* #F89235 */
font-family: var(--font-body1-font-family);
}

SCSS variables​

@use '@galaxy-ds/tokens/leap/web/tokens.scss' as tokens;

.button {
color: tokens.$color-primary-main;
background-color: tokens.$color-secondary-main;
}

JavaScript​

import {
ColorPrimaryMain,
ColorSecondaryMain,
FontBody1FontFamily,
} from '@galaxy-ds/tokens/leap/web';

This docs site follows the same pattern: core colours and typography come from the package CSS. Marketing-only colours that are not in the token set (for example social-network brand colours) live in a separate src/css/marketing-colors.css file as --marketing-* variables, not mixed with the core tokens.

Icons​

Install @galaxy-ds/icons@3.0.1-beta.1 for the Galaxy icon set as React components.

npm install @galaxy-ds/icons@3.0.1-beta.1

Browse the available icons in the Galaxy React Storybook.

React components​

npm install @galaxy-ds/core@3.0.2-beta.3

@galaxy-ds/core@3.0.2-beta.3 lists @galaxy-ds/tokens@3.0.1 and @galaxy-ds/icons@3.0.1-beta.1 as peer dependencies, so install them first (see Tokens and Icons above).

Follow the Galaxy React Storybook for component usage.

LEAP GUI (Bootstrap / Angular)​

For existing Bootstrap or Angular apps that still consume the LEAP GUI stylesheet (not the Galaxy token source of truth):

index.html
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<link rel="stylesheet" href="https://unpkg.com/@leapdev/gui-leap@latest/dist/css/leap.css" />
<title>Hello, world!</title>
</head>
<body>
<h1>Hello, world!</h1>
</body>
</html>