# @weave-design/typography

> Weave Typography components

Latest version **1.0.0** (published 2023-02-23) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @weave-design/typography
pnpm add @weave-design/typography
yarn add @weave-design/typography
bun add @weave-design/typography
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2023-02-23 |
| First published | 2023-02-23 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 29.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 193 |
| Author | Autodesk Inc. |
| Maintainers | hig-bot, wmui51 |

## Links

- npm: https://www.npmjs.com/package/@weave-design/typography
- Repository: https://github.com/Autodesk/hig
- Homepage: https://hig.autodesk.com
- Issues: https://github.com/Autodesk/hig/issues
- npm.io page: https://npm.io/package/@weave-design/typography

## Dependencies (2)

- [emotion](https://npm.io/package/emotion.md) ^10.0.0
- [prop-types](https://npm.io/package/prop-types.md) ^15.7.1

## Recent versions

- 1.0.0 (latest) — 2023-02-23

## README

# Typography

The Typography components apply the Artifakt typeface to text.

## Getting started

```
yarn add @weave-design/typography @weave-design/theme-context @weave-design/theme-data
yarn add @weave-design/fonts
```

## Import the component and CSS

```
import Typography from '@weave-design/typography';
import "@weave-design/fonts/build/ArtifaktElement.css";
```

## Basic usage

```jsx
<Typography>Artifakt Element is the preferred font.</Typography>
```
## Styling

Use the `className` prop to pass in a css class name to the outermost container of the component. The class name will also pass down to most of the other styled elements within the component. 

Typography also has a `stylesheet` prop that accepts a function wherein you can modify its styles. For instance

```jsx
import Typography from '@weave-design/typography';

function YourComponent() {
  // ...
  const customStylesheet = (styles, props, themeData) => ({
    ...styles,
    typography: {
      ...styles.typography,
      color: themeData["colorScheme.errorColor"]
    }
  });

  return (
    <Typography stylesheet={customStylesheet} />
  );
}
```

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