0.5.1 • Published 6 years ago

@wces/mdc-typography

Licence

MIT

Version

0.5.1

Deps

Size

14 kB

Vulns

Weekly

Summary Dependency Versions

<wces-mdc-typography>

This webcomponent follows the open-wc recommendation.

Installation

npm i @wces/mdc-typography

Usage

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

  </style>
  ...
</head>

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

npm run lint

You can lint with ESLint and Prettier individually as well

npm run lint:eslint

npm run lint:prettier

To automatically fix many linting errors, run

npm run format

You can format using ESLint and Prettier individually as well

npm run format:eslint

npm run format:prettier

Demoing with Storybook

To run a local instance of Storybook for your component, run

npm run storybook

To build a production version of Storybook, run

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`

npm start

To run a local development server that serves the basic demo located in index.html