2.0.0-rc.4 • Published 9 months ago

@asphalt-react/icontuner v2.0.0-rc.4

Weekly downloads
-
License
UNLICENSED
Repository
-
Last release
9 months ago

Icontuner

npm

Icontuner can tune the size and intent of any icon from @asphalt-react/iconpack. Use Icontuner to modify icons that are part of content, for example, to show an icon with "warning" intent when a feature is deprecated, or use a "brand" intent when the icon appears in a hero section.

Supported intents:

  • warning
  • danger
  • info
  • success
  • muted
  • brand
  • disabled
  • primary
  • secondary
  • invalid
  • inverse

Usage

import { Icontuner } from "@asphalt-react/icontuner
import { Trash } from "@asphalt-react/iconpack

<IconTuner>
   <Trash/>
</IconTuner>

Props

children

Icon from @asphalt-react/iconpack.

typerequireddefault
nodetrueN/A

size

Size of the icon. accepts xxs, xs, s, m, l, xl, xxl.

typerequireddefault
enumfalse"m"

danger

Applies danger intent color to icon.

typerequireddefault
boolfalsefalse

warning

Applies warning intent color to icon.

typerequireddefault
boolfalsefalse

info

Applies info intent color to icon.

typerequireddefault
boolfalsefalse

success

Applies success intent color to icon.

typerequireddefault
boolfalsefalse

muted

Applies muted intent color to icon.

typerequireddefault
boolfalsefalse

brand

Applies brand intent color to icon.

typerequireddefault
boolfalsefalse

disabled

Applies disabled intent color to icon.

typerequireddefault
boolfalsefalse

primary

Applies primary intent color to icon.

typerequireddefault
boolfalsefalse

secondary

Applies secondary intent color to icon.

typerequireddefault
boolfalsefalse

invalid

Applies invalid intent color to icon.

typerequireddefault
boolfalsefalse

inverse

Applies inverse intent color to icon.

typerequireddefault
boolfalsefalse

resize

Resizes icon.

typerequireddefault
boolfalsetrue