# @wces/mdc-typography

> Webcomponent wces-mdc-typography following open-wc recommendations

Latest version **0.5.1** (published 2020-03-31) · MIT license · 0 weekly downloads

## Install

```sh
npm install @wces/mdc-typography
pnpm add @wces/mdc-typography
yarn add @wces/mdc-typography
bun add @wces/mdc-typography
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.5.1 |
| Published | 2020-03-31 |
| First published | 2020-03-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 14.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Pactilis developers |
| Maintainers | jspactilis |

## Links

- npm: https://www.npmjs.com/package/@wces/mdc-typography
- npm.io page: https://npm.io/package/@wces/mdc-typography

## Dependencies (1)

- [lit-element](https://npm.io/package/lit-element.md) ^2.3.1

## Recent versions

- 0.5.1 (latest) — 2020-03-31

## README

# \<wces-mdc-typography>

This webcomponent follows the [open-wc](https://github.com/open-wc/open-wc) recommendation.

## Installation
```bash
npm i @wces/mdc-typography
```

## Usage
```html
<head>
  ...
  <link href="https://fonts.googleapis.com/css?family=Roboto:300,400,500" rel="stylesheet">
  <style>
    html {
      font-family: 'Roboto', sans-serif;
    }

  </style>
  ...
</head>
```
```js
import { LitElement, css, } from 'lit-element';
import typography from '@wces/mdc-typography';

export class AppDemo extends LitElement {

  static get styles() {
    return [
      typography,
      css`
        ...
      `
    ]
  }

  render() {
    ...
```

## Typographic classes

- `headline{1-6}`
- `body{1,2}`
- `caption`
- `overline`

## Linting with ESLint, Prettier, and Types
To scan the project for linting errors, run
```bash
npm run lint
```

You can lint with ESLint and Prettier individually as well
```bash
npm run lint:eslint
```
```bash
npm run lint:prettier
```

To automatically fix many linting errors, run
```bash
npm run format
```

You can format using ESLint and Prettier individually as well
```bash
npm run format:eslint
```
```bash
npm run format:prettier
```

## Demoing with Storybook
To run a local instance of Storybook for your component, run
```bash
npm run storybook
```

To build a production version of Storybook, run
```bash
npm run storybook:build
```


## Tooling configs

For most of the tools, the configuration is in the `package.json` to reduce the amount of files in your project.

If you customize the configuration a lot, you can consider moving them to individual files.

## Local Demo with `es-dev-server`
```bash
npm start
```
To run a local development server that serves the basic demo located in `index.html`

---
_Source: https://npm.io/package/@wces/mdc-typography · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._