# clean-tag

> :warning:

Latest version **3.1.1** (published 2019-03-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install clean-tag
pnpm add clean-tag
yarn add clean-tag
bun add clean-tag
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.1.1 |
| Published | 2019-03-28 |
| First published | 2018-02-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 7.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Brent Jackson |
| Maintainers | jxnblk |

## Links

- npm: https://www.npmjs.com/package/clean-tag
- npm.io page: https://npm.io/package/clean-tag

## Dependencies (1)

- [html-tags](https://npm.io/package/html-tags.md) ^2.0.0

## Recent versions

- 3.1.1 (latest) — 2019-03-28
- 3.1.0 — 2019-03-23
- 3.0.0 — 2019-03-22
- 2.0.3 — 2019-02-11
- 2.0.2 — 2018-11-04
- 2.0.1 — 2018-11-04
- 2.0.0 — 2018-07-15
- 1.1.0 — 2018-07-14
- 1.0.4 — 2018-02-23
- 1.0.3 — 2018-02-19
- 1.0.2 — 2018-02-17
- 1.0.1 — 2018-02-16
- 1.0.0 — 2018-02-16
- 1.0.0-0 — 2018-02-12

## README

# clean-tag

:warning:

**NO LONGER MAINTAINED**

If you're wanting to remove style props from HTML output, see [Emotion's `shouldForwardProp` API](https://emotion.sh/docs/styled#customizing-prop-forwarding)
or check the [open issue on styled-components][sc-issue].

---

Removes unwanted style props from the underlying HTML element when using styled-components.

If you see React warnings when using styled-components, this can help.

```sh
npm i clean-tag
```

Styled-components has a [long-standing issue][sc-issue] related to how it whitelists HTML attributes when parsing props.
The whitelist method will cause certain React props to be passed to the underlying HTML element if they happen to be a valid (often legacy) HTML attribute, such as `color` or `fontSize`.

```js
import styled from 'styled-components'
import { space, width, color } from 'styled-system'
import tag from 'clean-tag'

const Box = styled(tag)`
  ${space}
  ${width}
  ${color}
`

export default Box
```

```js
// custom HTML element on component definition
const Heading = styled(tag.h2)`
  ${fontSize}
  ${fontWeight}
  ${lineHeight}
  ${space}
  ${color}
`
```

## `is` prop

Changes the underlying HTML element per component instance.

```js
<Heading is='h1' />
```

## `omitProps` prop

Provide a custom list of prop keys to remove from the backing styled component.

The default list is based on Styled System's propType definitions.

```js
<Heading
  omitProps={[
    'fontSize',
    'color'
  ]}
/>
```

## `innerRef` prop

Pass the `innerRef` prop to the styled-component.

```js
<Heading
  innerRef={ref => this.heading = ref}
/>
```

MIT License

[sc-issue]: https://github.com/styled-components/styled-components/issues/439

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