Package Exports

@primer/primitives
@primer/primitives/dist/deprecations/colors
@primer/primitives/dist/json/colors/dark_dimmed.json
@primer/primitives/dist/json/colors/light.json

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@primer/primitives) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Primer Primitives

This repo contains values for color, spacing, and typography primitives for use with Primer, GitHub's design system.

Install

This repository is distributed on npm. After installing npm, you can install @primer/primitives with this command.

$ npm install --save @primer/primitives

Usage

Primitive data is served in several formats from the dist/ folder:

dist/scss contains SCSS files that define CSS variables to be imported into other SCSS files
dist/json contains JSON files for each set of primitives
dist/js contains CommonJS-style JavaScript modules for each set of primitives, as well as an index file that loads all of the primitives for all primitive types; you can access this via require('@primer/primitives'). The JavaScript modules also include TypeScript typings files for use in TypeScript projects.