import { PlumaTestHelpers } from '@customerio/pluma-components/react/test-helpers/pluma-test-helpers'

const icon = PlumaTestHelpers.extract('Icon', screen.getByTestId('data-test-icon'));

Test Helpers

`IconTestHelpers`

`getColor`() `=> "bold" | "button" | "accent" | "base" | "caution" | "critical" | "feature" | "information" | "invert" | "minimal" | "navigation" | "subtle" | "success" | "white" | "disabled" | "inherit" | undefined`

Gets the color of the icon

`getLabel`() `=> string | undefined`

Gets the label of the icon

`getName`() `=> IconName | undefined`

Gets the name of the icon

`getSize`() `=> "xl" | "xs" | "xxs" | "fill" | "sm" | "md" | "lg" | undefined`

Gets the size of the icon

`isColor`
(
`color:"bold" | "button" | "accent" | "base" | "caution" | "critical" | "feature" | "information" | "invert" | "minimal" | "navigation" | "subtle" | "success" | "white" | "disabled" | "inherit" | undefined`
)
`=> boolean`

Whether the color of the icon matches the expected color

`isLabel`
(
`label:string | undefined`
)
`=> boolean`

Whether the label of the icon matches the expected label

`isName`
(
`name:IconName`
)
`=> boolean`

Whether the name of the icon matches the expected name

`isSize`
(
`size:"xl" | "xs" | "xxs" | "fill" | "sm" | "md" | "lg" | undefined`
)
`=> boolean`

Whether the size of the icon matches the expected size

Icon

Usage

Test Helpers

IconTestHelpers

getColor() => "bold" | "button" | "accent" | "base" | "caution" | "critical" | "feature" | "information" | "invert" | "minimal" | "navigation" | "subtle" | "success" | "white" | "disabled" | "inherit" | undefined

getLabel() => string | undefined

getName() => IconName | undefined

getSize() => "xl" | "xs" | "xxs" | "fill" | "sm" | "md" | "lg" | undefined

isColor(color:"bold" | "button" | "accent" | "base" | "caution" | "critical" | "feature" | "information" | "invert" | "minimal" | "navigation" | "subtle" | "success" | "white" | "disabled" | "inherit" | undefined) => boolean

isLabel(label:string | undefined) => boolean

isName(name:IconName) => boolean

isSize(size:"xl" | "xs" | "xxs" | "fill" | "sm" | "md" | "lg" | undefined) => boolean

On this page