npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@element-public/react-typography

v1.0.0

Published

Typography components for Element React

Downloads

3

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

peon125peon125slowikowskiarkadiuszslowikowskiarkadiuszarkadiusz.slowikowskiarkadiusz.slowikowski

Keywords

Readme

Typography

Description

The Typography component is meant for use in styling type, so the underlying markup is made from a to produce valid markup in the largest number of situations. See TypoBody, TypoButton, TypoHeadline, TypoOverline, and TypoSubtitle.

See live demos on storybook

Storybook Typography Demos

Install bundle from npm-e

npm i @element-public/react-components @element-public/themes

Optional: install the component individually

npm i @element-public/react-typography @element-public/themes

Open ~/.npmrc in an editor and add the following line to enable the @element-public scope:


@element-public:registry=https://npm.platforms.engineering

Troubleshooting

See below if you have never installed a package from Bayer's npm-enterprise or run into the following error:


npm ERR! code E401
npm ERR! Unable to authenticate, your authentication token seems to be invalid.
npm ERR! To correct this please trying logging in again with:
npm ERR!     npm login

Setup an access token

See the devtools npm-e guide to learn how to create an access token if this is the first time you are using a npm-e package at Bayer or you do not have a line that starts with the following in your ~/.npmrc file:

//npm.platforms.engineering/:_authToken=

Notes

The Typography components are meant for use in styling type. The underlying markup is made from a <span> to work in the largest number of situations. Using the 'tag' prop, will allow the user to override the HTML tag if needed.

Usage

Typography is mainly to be used to style characters. Typography is used to ensure all text is styled according to the chosen theme and remain brand compliant.

The 'themeColor' prop allows users to change colors of the text, excluding links. Some accepted values are; primary, secondary, error, textHintOnBackgroud, and many more.

Body, Subtitle, Display have a 'level' props that can be used to adjust the font size and spacing. Display has 'level' values ranging from 1 to 6, while Body and Subtitle have levels 1-2.

Typography Props

| Name | Type | Default | Required | Description | | ---------- | ------------------------------------------ | --------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | bold | boolean | false | false | If true the typography will be bold. Applies to 1body, body2, caption, subtitle1, subtitle2 | | className | string | undefined | false | The css class name to be passed through to the component markup. | | tag | string|React.ElementType|React.Component | 'span' | false | The DOM element to display the typography. | | themeColor | string | undefined | false | Sets theme color for the typography. Does not apply to Link.Accepted Values: primary, secondary, error, text-primary-on-background, text-secondary-on-background, text-hint-on-background, text-disabled-on-background, text-icon-on-background, text-primary-on-light, text-secondary-on-light, text-hint-on-light, text-disabled-on-light, text-icon-on-lightDeprecated Values: textPrimaryOnBackground, textSecondaryOnBackground, textHintOnBackground, textDisabledOnBackground, textIconOnBackground, textPrimaryOnLight, textSecondaryOnLight, textHintOnLight, textDisabledOnLight, textIconOnLight | | type | string | 'body1' | false | Sets typography class for the element.Accepted Values: body1, body1-bold, body2, body2-bold, button, caption, caption-bold, display1, display2, display3, display4, display5, display6, link, overline, subtitle1, subtitle1-bold, subtitle2, subtitle2-boldDeprecated Values: headline1, headline2, headline3, headline4, headline5, headline6 |

Typography Render Props

| Name | Type | Default | Required | Description | | -------- | --------------- | ------- | -------- | ------------------------------------------- | | children | React.ReactNode | null | false | Expects a string, accepts any valid markup. |

Typo Body Props

| Name | Type | Default | Required | Description | | ---------- | ------------------------------------------ | --------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | bold | boolean | false | false | If true the typography will be bold. | | className | string | undefined | false | The css class name to be passed through to the component markup. | | level | number | 1 | false | Sets font properties for body. Acceptable values range from 1 - 2. Higher levels produce smaller type.Accepted Values: 1, 2 | | tag | string|React.ElementType|React.Component | 'span' | false | The DOM element to display the typography. | | themeColor | string | undefined | false | Sets theme color for the typography.Accepted Values: primary, secondary, error, text-primary-on-background, text-secondary-on-background, text-hint-on-background, text-disabled-on-background, text-icon-on-background, text-primary-on-light, text-secondary-on-light, text-hint-on-light, text-disabled-on-light, text-icon-on-lightDeprecated Values: textPrimaryOnBackground, textSecondaryOnBackground, textHintOnBackground, textDisabledOnBackground, textIconOnBackground, textPrimaryOnLight, textSecondaryOnLight, textHintOnLight, textDisabledOnLight, textIconOnLight |

Typo Body Render Props

| Name | Type | Default | Required | Description | | -------- | --------------- | ------- | -------- | ------------------------------------------- | | children | React.ReactNode | null | false | Expects a string, accepts any valid markup. |

Typo Button Props

| Name | Type | Default | Required | Description | | ---------- | ------------------------------------------ | --------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | className | string | undefined | false | The css class name to be passed through to the component markup. | | tag | string|React.ElementType|React.Component | 'span' | false | The DOM element to display the typography. | | themeColor | string | undefined | false | Sets theme color for the typography.Accepted Values: primary, secondary, error, text-primary-on-background, text-secondary-on-background, text-hint-on-background, text-disabled-on-background, text-icon-on-background, text-primary-on-light, text-secondary-on-light, text-hint-on-light, text-disabled-on-light, text-icon-on-lightDeprecated Values: textPrimaryOnBackground, textSecondaryOnBackground, textHintOnBackground, textDisabledOnBackground, textIconOnBackground, textPrimaryOnLight, textSecondaryOnLight, textHintOnLight, textDisabledOnLight, textIconOnLight |

Typo Button Render Props

| Name | Type | Default | Required | Description | | -------- | --------------- | ------- | -------- | ------------------------------------------- | | children | React.ReactNode | null | false | Expects a string, accepts any valid markup. |

Typo Caption Props

| Name | Type | Default | Required | Description | | ---------- | ------------------------------------------ | --------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | bold | boolean | false | false | If true the typography will be bold. | | className | string | undefined | false | The css class name to be passed through to the component markup. | | tag | string|React.ElementType|React.Component | 'span' | false | The DOM element to display the typography. | | themeColor | string | undefined | false | Sets theme color for the typography.Accepted Values: primary, secondary, error, text-primary-on-background, text-secondary-on-background, text-hint-on-background, text-disabled-on-background, text-icon-on-background, text-primary-on-light, text-secondary-on-light, text-hint-on-light, text-disabled-on-light, text-icon-on-lightDeprecated Values: textPrimaryOnBackground, textSecondaryOnBackground, textHintOnBackground, textDisabledOnBackground, textIconOnBackground, textPrimaryOnLight, textSecondaryOnLight, textHintOnLight, textDisabledOnLight, textIconOnLight |

Typo Caption Render Props

| Name | Type | Default | Required | Description | | -------- | --------------- | ------- | -------- | ------------------------------------------- | | children | React.ReactNode | null | false | Expects a string, accepts any valid markup. |

Typo Display Props

| Name | Type | Default | Required | Description | | ---------- | ------------------------------------------ | --------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | className | string | undefined | false | The css class name to be passed through to the component markup. | | level | number|string | 1 | false | Sets font properties for body. Acceptable values range from 1 to 6. Higher levels produce smaller type.Accepted Values: 1, 2, 3, 4, 5, 6, 1, 2, 3, 4, 5, 6 | | tag | string|React.ElementType|React.Component | 'span' | false | The DOM element to display the typography. | | themeColor | string | undefined | false | Sets theme color for the typography.Accepted Values: primary, secondary, error, text-primary-on-background, text-secondary-on-background, text-hint-on-background, text-disabled-on-background, text-icon-on-background, text-primary-on-light, text-secondary-on-light, text-hint-on-light, text-disabled-on-light, text-icon-on-lightDeprecated Values: textPrimaryOnBackground, textSecondaryOnBackground, textHintOnBackground, textDisabledOnBackground, textIconOnBackground, textPrimaryOnLight, textSecondaryOnLight, textHintOnLight, textDisabledOnLight, textIconOnLight |

Typo Display Render Props

| Name | Type | Default | Required | Description | | -------- | --------------- | ------- | -------- | ------------------------------------------- | | children | React.ReactNode | null | false | Expects a string, accepts any valid markup. |

Typo Headline Props

| Name | Type | Default | Required | Description | | ---------- | ------------------------------------------ | --------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | className | string | undefined | false | The css class name to be passed through to the component markup. | | level | number|string | 1 | false | Sets font properties for body. Acceptable values range from 1 to 6. Higher levels produce smaller type.Accepted Values: 1, 2, 3, 4, 5, 6, 1, 2, 3, 4, 5, 6 | | tag | string|React.ElementType|React.Component | 'span' | false | The DOM element to display the typography. | | themeColor | string | undefined | false | Sets theme color for the typography.Accepted Values: primary, secondary, error, text-primary-on-background, text-secondary-on-background, text-hint-on-background, text-disabled-on-background, text-icon-on-background, text-primary-on-light, text-secondary-on-light, text-hint-on-light, text-disabled-on-light, text-icon-on-lightDeprecated Values: textPrimaryOnBackground, textSecondaryOnBackground, textHintOnBackground, textDisabledOnBackground, textIconOnBackground, textPrimaryOnLight, textSecondaryOnLight, textHintOnLight, textDisabledOnLight, textIconOnLight |

Typo Headline Render Props

| Name | Type | Default | Required | Description | | -------- | --------------- | ------- | -------- | ------------------------------------------- | | children | React.ReactNode | null | false | Expects a string, accepts any valid markup. |

Typo Link Props

| Name | Type | Default | Required | Description | | --------- | ------------------------------------------ | --------- | -------- | ---------------------------------------------------------------- | | className | string | undefined | false | The css class name to be passed through to the component markup. | | tag | string|React.ElementType|React.Component | 'a' | false | The DOM element to display the typography. |

Typo Link Render Props

| Name | Type | Default | Required | Description | | -------- | --------------- | ------- | -------- | ------------------------------------------- | | children | React.ReactNode | null | false | Expects a string, accepts any valid markup. |

Typo Overline Props

| Name | Type | Default | Required | Description | | ---------- | ------------------------------------------ | --------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | className | string | undefined | false | The css class name to be passed through to the component markup. | | tag | string|React.ElementType|React.Component | 'span' | false | The DOM element to display the typography. | | themeColor | string | undefined | false | Sets theme color for the typography.Accepted Values: primary, secondary, error, text-primary-on-background, text-secondary-on-background, text-hint-on-background, text-disabled-on-background, text-icon-on-background, text-primary-on-light, text-secondary-on-light, text-hint-on-light, text-disabled-on-light, text-icon-on-lightDeprecated Values: textPrimaryOnBackground, textSecondaryOnBackground, textHintOnBackground, textDisabledOnBackground, textIconOnBackground, textPrimaryOnLight, textSecondaryOnLight, textHintOnLight, textDisabledOnLight, textIconOnLight |

Typo Overline Render Props

| Name | Type | Default | Required | Description | | -------- | --------------- | ------- | -------- | ------------------------------------------- | | children | React.ReactNode | null | false | Expects a string, accepts any valid markup. |

Typo Subtitle Props

| Name | Type | Default | Required | Description | | ---------- | ------------------------------------------ | --------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | bold | boolean | false | false | If true the typography will be bold. | | className | string | undefined | false | The css class name to be passed through to the component markup. | | level | number | 1 | false | Sets font properties for body.Accepted Values: 1, 2 | | tag | string|React.ElementType|React.Component | 'span' | false | The DOM element to display the typography. | | themeColor | string | undefined | false | Sets theme color for the typography.Accepted Values: primary, secondary, error, text-primary-on-background, text-secondary-on-background, text-hint-on-background, text-disabled-on-background, text-icon-on-background, text-primary-on-light, text-secondary-on-light, text-hint-on-light, text-disabled-on-light, text-icon-on-lightDeprecated Values: textPrimaryOnBackground, textSecondaryOnBackground, textHintOnBackground, textDisabledOnBackground, textIconOnBackground, textPrimaryOnLight, textSecondaryOnLight, textHintOnLight, textDisabledOnLight, textIconOnLight |

Typo Subtitle Render Props

| Name | Type | Default | Required | Description | | -------- | --------------- | ------- | -------- | ------------------------------------------- | | children | React.ReactNode | null | false | Expects a string, accepts any valid markup. |