@phillips/seldon

Easel Design System 🎨 by Phillips Auction House

Seldon is the source for design guidelines, component documentation, and resources for building apps with the Phillips.com Design System.

Installation

# With NPM
npm install @phillips/seldon

# With yarn
yarn add @phillips/seldon

What's included

@phillips/seldon/
├── components
│   └── HeroBanner
│       └── HeroBanner.d.ts
│       └── HeroBanner.js
│   └── ...
├── Pages
│   └── HomePage
│       └── HomePage.d.ts
│       └── HomePage.js
│   └── ...
├── scss
│   └── components
│       └── HeroBanner
│           └── _HeroBanner.scss
│       └── ...
│   └── Pages
│       └── HomePage
│           └── _HomePage.scss
│       └── ...
│   └── _reset.scss
│   └── _typography_.scss
│   └── _vars.scss
│   └── styles.scss (sass entrypoint)
├── utils
├── index.d.ts
├── index.js

Styling

The project contains a scss folder. Here you will find the main export of our sass styles. This will include all the styles bundled with this package, including resets and typography styles.

@use '@phillips/seldon/dist/scss/styles';

If you wish to only import specific component styles you can find them in their respective directories inside the scss folder.

@use '@phillips/seldon/dist/scss/components/Button/button';

Components

Each component can be imported in your project by referencing the named exports from main index file.

import { Button } from '@phillips/seldon';

Contributing Guidelines

Before you start contributing to this project please check out our guidelines found here