Skip to content

Latest commit

 

History

History
113 lines (86 loc) · 2.86 KB

getting-started.md

File metadata and controls

113 lines (86 loc) · 2.86 KB
Raw
title label
Getting Started
Guide

Just want to get your feet wet? Check out the codepen demo.

Install

Install via yarn

$ yarn add @wework/ray-core

Install via npm

$ npm install --save @wework/ray-core

Ray requires both CSS and JavaScript files to be imported into your application. We encourage the use of the Sass source files as they give access to Ray variables and mixins.

SCSS/CSS

@import '@wework/ray-core/scss/ray-core';

JavaScript

Note: For convenience, Ray will automatically instantiate any components that require JavaScript on DOMContentLoaded. If components are generated after this event (i.e. client-side rendered), or if they require additional programming, you can use the APIs available on the component level throughtout the documentation.

import { Select } from '@wework/ray-core';

CDN

Ray can also be installed via CDN for rapid prototyping.

Resource URL
CSS https://unpkg.com/@wework/ray-core@latest/css/ray-core.min.css
ES5 https://unpkg.com/@wework/ray-core@latest/scripts/ray-core.min.js 

<html>
  <head>
    <link
      rel="stylesheet"
      href="https://unpkg.com/@wework/ray-core@latest/css/ray-core.min.css"
    />
  </head>

  <body>
    <div class="ray-select">
      ...
    </div>

    <script src="https://unpkg.com/@wework/ray-core@latest/scripts/ray-core.min.js"></script>
    <script>
      Ray.Core.Select.create(document.querySelector('.ray-select'));
    </script>
  </body>
</html>

Structure

@wework/ray-core is structured as follows:

.
├── es/
│   ├── index.js
│   ├── global/
│   ├── components/
├── umd/
│   ├── index.js
│   ├── global/
│   ├── components/
├── scripts/
│   ├── ray-core.js
│   ├── ray-core.js.map
│   ├── ray-core.min.js
│   ├── ray-core.min.js.map
├── scss/
│   ├── ray-core.scss
│   ├── global/
│   ├── components/
├── css/
│   ├── ray-core.css
│   ├── ray-core.css.map
│   ├── ray-core.min.css
│   ├── ray-core.min.css.map
├── LICENSE
└── README.md

Fonts

You will also need to install the fonts, which can be done via WeWork's CDN. See instructions in the fonts documentation.

Contributing

Feeling ambitious? Good, because we’d love your input and contributions to the design system.