npm package: @stead/type
Description: Typography for digital and software products using the Stead Design System
Latest version: 0.1.1

# @stead/type

> Typography for digital and software products using the Stead Design System

## Getting started

To install `@stead/type` in your project, you will need to run the following
command using [npm](https://www.npmjs.com/):

```bash
npm install -S @stead/type
```

If you prefer [Yarn](https://yarnpkg.com/en/), use the following command
instead:

```bash
yarn add @stead/type
```

## Usage

`@stead/type` provides a variety of ways to work with typography from the Stead
Design Language. You can use all of these features either in JavaScript or Sass.
These features include:

| Feature                       | Description                                                                                                  |
| ----------------------------- | ------------------------------------------------------------------------------------------------------------ |
| [Font face](#font-face)       | Include inbuilt font faces in your application. Uses Google fonts                                          |
| [Type classes](#type-classes) | Helpers to use type styles directly. Not included by default                                                 |
| [Font family](#font-family)   | Defines the font stack for inbuild in your application, provides helpers for working with font definitions |
| [Reset](#reset)               | Provides a high-level CSS Reset to use in your project                                                       |
| [Scale](#type-scale)          | Provides the type scale. Can access the size at any given step (step 1, 2, 3, etc)                           |
| [Styles](#type-styles)        | Provides type styles for your application (heading-01, body-long-01, etc)                                    |

To include `@stead/type` in your project, you can write the following in your
Sass file:

```scss
@import '@stead/type/scss/type';
@import '@stead/type/scss/font-face/mono';
@import '@stead/type/scss/font-face/sans';

@include stead-type-reset();
@include stead-font-face-mono();
@include stead-font-face-sans();
```

This should include the default type reset from the project, in addition to
font-face definitions for Inconsolata and Nunito that come from Google
Fonts.

If you are using `@stead/elements`, the import paths become:

```scss
@import '@stead/elements/scss/type/path-to-import';
```

For example:

```scss
@import '@stead/elements/scss/type/styles';
```

In addition, you will need to setup `node-sass` so that `node_modules` is
included in the `includePaths` option. Often times, the tool that you are using
to build Sass files in your project should expose this option for you to set.

For example, if you are using Webpack you would use `node-sass` and
`sass-loader` with the following configuration for `includePaths`:

```js
{
  loader: 'sass-loader',
  options: {
    includePaths: ['node_modules'],
  },
}
```

### Type styles

Instead of using a type scale, `@stead/type` provides tokens that represent
what we call type styles. These tokens have a variety of properties for styling
how text is rendered on a page.

You can include a token in your Sass file by writing:

```scss
@import '@stead/type/scss/styles';

@include stead-type-style('token-name');
```

In addition, if the type style you are using has a fluid style then you can pass
in `true` as the second argument to `stead-type-style` to enable fluid styles.
For example:

```scss
@import '@stead/type/scss/styles';

@include stead-type-style('token-name', true);
```

### Font-face

`@stead/type` supports three font-face definitions that you can use. These font-face definitions include support for:

- Mono
- Sans
- Serif

These font-face definitions are pulling the above fonts from Google Fonts. As a
result, they are not intended to be used as a production asset for your project.
While you can depend on these for bootstrapping your project.

You can include each font-face definition by including the corresponding file
and calling its mixin. For example, if you wanted to include Inconsolata in
your project you would write the following in your Sass file:

```scss
@import '@stead/type/scss/font-face/mono';

@include stead-font-face-mono();
```

Similarly, you can include The default fonts by writing:

```scss
@import '@stead/type/scss/font-face/mono';
@import '@stead/type/scss/font-face/sans';
@import '@stead/type/scss/font-face/serif';

@include stead-font-face-mono();
@include stead-font-face-sans();
@include stead-font-face-serif();
```

### Type classes

The recommended way to style your application will be to use our
[type styles](#type-styles). However, we also offer helper CSS classes for
specific use-cases. These are also helpful when quickly prototyping a project.

You can include type classes in your project by writing the following in your
Sass file:

```scss
@import '@stead/type/scss/classes';
```

| Selector                 | Description                               |
| ------------------------ | ----------------------------------------- |
| `.st-type-mono`         | Specify the font face as Inconsolata    |
| `.st-type-sans`         | Specify the font face as Nunito    |
| `.st-type-serif`        | Specify the font face as Merriweather   |
| `.st-type-light`        | Specify the font weight as light (300)    |
| `.st-type-regular`      | Specify the font weight as regular (400)  |
| `.st-type-semibold`     | Specify the font weight as semibold (600) |
| `.st-type-italic`       | Specify the font style as italic          |
| `.st-type-<type-style>` | Set styles for the given type style       |

### Font family

`@stead/type` provides the font stacks for all the inbuild fonts available.
You can access the font family information by including the following import in
your Sass file:

```scss
@import '@stead/type/scss/font-family';
```

The font stacks are available under the `$stead-font-families` variable. You
can also access a specific font family by using the `stead-font-family`
function by doing:

```scss
.my-selector {
  font-family: stead-font-family('mono');
}
```

You can also use the `stead-font-family` mixin to automatically set the
`font-family` property for you:

```scss
.my-selector {
  @include stead-font-family('mono');
}
```

You can see all the available font families in `$stead-font-families` .

### Reset

An optional type reset is provided under the `stead-type-reset` mixin. You can
include this mixin by writing the following in your Sass file:

```scss
@import '@stead/type/scss/reset';

@include stead-type-reset();
```

This reset sets some top-level properties on `html` and `body`, namely
`font-size`, `font-family`, and some `text-rendering` options. We also map the
`strong` tag to the semibold font weight.

### Type scale

A type scale is provided through the `$stead-type-scale` variable and
corresponding `stead-type-scale` function and mixin. However, for specifying
type styles, the recommendation is to use [type styles](#type-styles) .

If you are looking to use the type scale, you can include all the scale-related
utilities and variables by writing the following in your Sass file:

```scss
@import '@stead/type/scss/scale';
```

You can access a specific step in the type scale by using the
`stead-type-scale` function:

```scss
@import '@stead/type/scss/scale';

.my-selector {
  font-size: stead-type-scale(1);
}
```

There is also a `type-scale` mixin that will set `font-size` for your directly:

```scss
@import '@stead/type/scss/scale';

.my-selector {
  @include stead-type-scale(1);
}
```

## 📖 API Documentation

If you're looking for `@stead/type` API documentation, check out:

- [Sass](./docs/sass.md)

## 📚 Examples

If you're looking for more examples on how to use `@stead/type`, we have some
examples that you can check out:

- [styled-components](./examples/styled-components)

## 🙌 Contributing

We're always looking for contributors to help us fix bugs, build new features,
or help us improve the project documentation. If you're interested, definitely
check out our [Contributing Guide](/.github/CONTRIBUTING.md)! 👀

## 📝 License

Licensed under the [Apache 2.0 License](/LICENSE).