# modular-scale-styled

> An easy-to-use library for creating meaningful typography

Latest version **1.0.1** (published 2021-01-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install modular-scale-styled
pnpm add modular-scale-styled
yarn add modular-scale-styled
bun add modular-scale-styled
```

## Health

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

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2021-01-25 |
| First published | 2021-01-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=10 |
| Dependencies | 2 |
| Unpacked size | 16.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Divino Borges |
| Maintainers | divinoborges |
| Keywords | react, typography, styled |

## Links

- npm: https://www.npmjs.com/package/modular-scale-styled
- Repository: https://github.com/divinoborges/modular-scale-styled
- Issues: https://github.com/divinoborges/modular-scale-styled/issues
- npm.io page: https://npm.io/package/modular-scale-styled

## Dependencies (2)

- [styled-components](https://npm.io/package/styled-components.md) ^5.2.1
- [@types/styled-components](https://npm.io/package/@types/styled-components.md) ^5.1.7

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.0.1 (latest) — 2021-01-25
- 1.0.0 — 2021-01-25

## README

# Modular Scale Styled

> An easy-to-use library for creating meaningful typography

[![NPM](https://img.shields.io/npm/v/modular-scale-styled.svg)](https://www.npmjs.com/package/modular-scale-styled)

## Install

```bash
npm install --save modular-scale-styled
```

## Basic usage

```tsx
import React from 'react'

import MSStyled, { Scale, Text } from 'modular-scale-styled'

const options = {
    base: 16,              // is the base size in px
    ratio: Scale.GOLDEN    // is the chosen scale
}

const App = () => {
    return (
        <MSStyled options={options}>
            {/* the size parameter means the size within the scale */}
            <Text size={5}>Meaningful Typography</Text>
            <Text size={4}>Meaningful Typography</Text>
            <Text size={3}>Meaningful Typography</Text>
            <Text size={2}>Meaningful Typography</Text>
            <Text size={1}>Meaningful Typography</Text>
            <Text size={0}>Meaningful Typography</Text>
            <Text size={-1}>Meaningful Typography</Text>
            <Text size={-2}>Meaningful Typography</Text>
        </MSStyled>
    )
}
```

## Creating a custom component

```tsx
import React from 'react'

import MSStyled, { Scale, Text } from 'modular-scale-styled'
import styled from "styled-components";

const options = {
    base: 16,   
    ratio: Scale.GOLDEN
}

const MyCustomText= styled(Text)`
  color: #e51818;
  background-color: rebeccapurple;
`;

const App = () => {
    return (
        <MSStyled options={options}>
            <MyCustomText size={4}>Meaningful Typography</MyCustomText>
        </MSStyled>
    )
}
```

## Supported scales


| Scale  |  Value  |
| ------------------- | ------------------- |
| Minor Second |  1.067 | 
| Major Second |  1.125 | 
| Minor Third |  1.2 | 
| Major Third |  1.25 | 
| Perfect Fourth |  1.333 | 
| Aug Fourth / Dim Fifth |  1.414 | 
| Perfect Fifth |  1.5 | 
| Minor Sixth |  1.6 | 
| Golden Section |  1.618 | 
| Major Sixth |  1.667 | 
| Minor Seventh |  1.778 | 
| Major Seventh |  1.875 | 
| Octave |  2 | 
| Major Tenth |  2.5 | 
| Major Eleventh |  2.667 | 
| Major Twelfth |  3 | 
| Double Octave |  4 | 

## License

MIT © [divinoborges](https://github.com/divinoborges)

Follow me on Twitter [@divinoborges_](https://twitter.com/divinoborges_)

---
_Source: https://npm.io/package/modular-scale-styled · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._