Skip to content
eds / 14.0.0

eds 14.0.0

Install from the command line:
Learn more about npm packages
$ npm install @chanzuckerberg/eds@14.0.0
Install via package.json:
"@chanzuckerberg/eds": "14.0.0"

About this version

Education Design System

Test CI Release codecov

Education Design System (EDS) is a repository of presentational components used to build React-based products for Chan Zuckerberg Initiative.

Installation

First, install the package.

# using npm
npm install --save @chanzuckerberg/eds

# or using Yarn
yarn add @chanzuckerberg/eds

Setting up EDS in your project

Import the EDS stylesheets somewhere in your app root, e.g. an init.ts or app.ts file:

import '@chanzuckerberg/eds/index.css'; // Includes relevant styles and tokens for EDS
import '@chanzuckerberg/eds/fonts.css'; // Includes font files if using the built in theme fonts

Also, include this in your base / reset styles to allow configuation of the pixel-to-rem ratio:

html {
  font-size: var(--eds-font-size-base); /* Sets the default pixel-to-rem ratio */
}

Theming Setup

For more information and configuration options, read the Theming Overview.

EDS Component Usage

Import any of the components from the top-level package:

// Import components by name at the top of your file
import { Heading } from '@chanzuckerberg/eds';

// ...and then use them in your React components:

<Heading preset="headline-lg">
  Coffee!
</Heading>

EDS provides a suite of components for use, and documentation for available props and overrides.

Development

This project is under active development. See CONTRIBUTING.md for more information on how to contribute to the Design System and IDE (VSCode) setup. Also, read our guidelines for additional information on how we build EDS components.

Instead, if you want to report an issue, you can open an issue.

This project is governed under the Contributor Covenant code of conduct.

Reporting Security Issues

See our Security Readme.

FAQ, More Information, and Support

Please review our Education Design System Site (SSO Required) here.

Details

Assets

  • eds-14.0.0.tgz

Download activity

  • Total downloads 139,422
  • Last 30 days 13,577
  • Last week 3,015
  • Today 303

Recent versions

View all