sp-help-text

NPM

0.48.1

Storybook

View Storybook
Examples API Changelog

Attributes and Properties #

Property Attribute Type Default Description icon icon boolean false variant variant HelpTextVariants 'neutral' The visual variant to apply to this help text.

0.48.1 (2024-10-01) #

Note: Version bump only for package @spectrum-web-components/help-text

0.48.0 (2024-09-17) #

Note: Version bump only for package @spectrum-web-components/help-text

0.47.2 (2024-09-03) #

Note: Version bump only for package @spectrum-web-components/help-text

0.47.1 (2024-08-27) #

Note: Version bump only for package @spectrum-web-components/help-text

0.47.0 (2024-08-20) #

Note: Version bump only for package @spectrum-web-components/help-text

0.46.0 (2024-08-08) #

Note: Version bump only for package @spectrum-web-components/help-text

0.45.0 (2024-07-30) #

Note: Version bump only for package @spectrum-web-components/help-text

0.44.0 (2024-07-15) #

Note: Version bump only for package @spectrum-web-components/help-text

0.43.0 (2024-06-11) #

Note: Version bump only for package @spectrum-web-components/help-text

0.42.5 (2024-05-24) #

Note: Version bump only for package @spectrum-web-components/help-text

0.42.4 (2024-05-14) #

Note: Version bump only for package @spectrum-web-components/help-text

0.42.3 (2024-05-01) #

Note: Version bump only for package @spectrum-web-components/help-text

0.42.2 (2024-04-03) #

Note: Version bump only for package @spectrum-web-components/help-text

0.42.1 (2024-04-02) #

Note: Version bump only for package @spectrum-web-components/help-text

0.42.0 (2024-03-19) #

Features #

  • asset: use core tokens (99e76f4)

0.41.2 (2024-03-05) #

Note: Version bump only for package @spectrum-web-components/help-text

0.41.1 (2024-02-22) #

Note: Version bump only for package @spectrum-web-components/help-text

0.41.0 (2024-02-13) #

Note: Version bump only for package @spectrum-web-components/help-text

0.40.5 (2024-02-05) #

Note: Version bump only for package @spectrum-web-components/help-text

0.40.4 (2024-01-29) #

Note: Version bump only for package @spectrum-web-components/help-text

0.40.3 (2024-01-11) #

Note: Version bump only for package @spectrum-web-components/help-text

0.40.2 (2023-12-18) #

Note: Version bump only for package @spectrum-web-components/help-text

0.40.1 (2023-12-05) #

Note: Version bump only for package @spectrum-web-components/help-text

0.40.0 (2023-11-16) #

Note: Version bump only for package @spectrum-web-components/help-text

0.39.4 (2023-11-02) #

Note: Version bump only for package @spectrum-web-components/help-text

0.39.3 (2023-10-18) #

Note: Version bump only for package @spectrum-web-components/help-text

0.39.2 (2023-10-13) #

Note: Version bump only for package @spectrum-web-components/help-text

0.39.1 (2023-10-06) #

Note: Version bump only for package @spectrum-web-components/help-text

0.39.0 (2023-09-25) #

Note: Version bump only for package @spectrum-web-components/help-text

0.38.0 (2023-09-05) #

Note: Version bump only for package @spectrum-web-components/help-text

0.37.0 (2023-08-18) #

Note: Version bump only for package @spectrum-web-components/help-text

0.36.0 (2023-08-18) #

Note: Version bump only for package @spectrum-web-components/help-text

0.35.0 (2023-07-31) #

Note: Version bump only for package @spectrum-web-components/help-text

0.34.0 (2023-07-11) #

Note: Version bump only for package @spectrum-web-components/help-text

0.33.2 (2023-06-14) #

Note: Version bump only for package @spectrum-web-components/help-text

0.33.0 (2023-06-08) #

Note: Version bump only for package @spectrum-web-components/help-text

0.32.0 (2023-06-01) #

Note: Version bump only for package @spectrum-web-components/help-text

0.31.0 (2023-05-17) #

Note: Version bump only for package @spectrum-web-components/help-text

0.30.0 (2023-05-03) #

Bug Fixes #

  • dialog: updates for delivering dialog content accessibly (f0ed33c)

Features #

  • add Help Text pattern (fdbb812)
  • include all Dev Mode files in side effects (f70817c)
  • shared pkg versions, devmode define warning, registry-conflicts docs (6e49565)

0.2.14 (2023-04-24) #

Note: Version bump only for package @spectrum-web-components/help-text

0.2.13 (2023-04-05) #

Note: Version bump only for package @spectrum-web-components/help-text

0.2.12 (2023-03-22) #

Note: Version bump only for package @spectrum-web-components/help-text

0.2.11 (2023-03-08) #

Note: Version bump only for package @spectrum-web-components/help-text

0.2.10 (2023-02-08) #

Note: Version bump only for package @spectrum-web-components/help-text

0.2.9 (2023-01-23) #

Note: Version bump only for package @spectrum-web-components/help-text

0.2.8 (2023-01-09) #

Note: Version bump only for package @spectrum-web-components/help-text

0.2.7 (2022-12-08) #

Note: Version bump only for package @spectrum-web-components/help-text

0.2.6 (2022-11-21) #

Note: Version bump only for package @spectrum-web-components/help-text

0.2.5 (2022-11-14) #

Note: Version bump only for package @spectrum-web-components/help-text

0.2.4 (2022-10-28) #

Note: Version bump only for package @spectrum-web-components/help-text

0.2.3 (2022-10-10) #

Note: Version bump only for package @spectrum-web-components/help-text

0.2.2 (2022-09-14) #

Note: Version bump only for package @spectrum-web-components/help-text

0.2.1 (2022-08-24) #

Note: Version bump only for package @spectrum-web-components/help-text

0.2.0 (2022-08-09) #

Features #

  • include all Dev Mode files in side effects (f70817c)

0.1.11 (2022-08-04) #

Note: Version bump only for package @spectrum-web-components/help-text

0.1.10 (2022-07-18) #

Note: Version bump only for package @spectrum-web-components/help-text

0.1.9 (2022-06-29) #

Note: Version bump only for package @spectrum-web-components/help-text

0.1.8 (2022-06-07) #

Note: Version bump only for package @spectrum-web-components/help-text

0.1.7 (2022-05-27) #

Note: Version bump only for package @spectrum-web-components/help-text

0.1.6 (2022-05-12) #

Note: Version bump only for package @spectrum-web-components/help-text

0.1.5 (2022-04-21) #

Note: Version bump only for package @spectrum-web-components/help-text

0.1.4 (2022-03-08) #

Note: Version bump only for package @spectrum-web-components/help-text

0.1.3 (2022-03-04) #

Note: Version bump only for package @spectrum-web-components/help-text

0.1.2 (2022-02-22) #

Bug Fixes #

  • dialog: updates for delivering dialog content accessibly (f0ed33c)

0.1.1 (2022-01-26) #

Note: Version bump only for package @spectrum-web-components/help-text

0.1.0 (2021-12-13) #

Features #

  • add Help Text pattern (fdbb812)

Description #

An <sp-help-text> provides either an informative description or an error message that gives more context about what a user needs to input. It's commonly used in forms.

Usage #

See it on NPM! How big is this package in your project?

yarn add @spectrum-web-components/help-text

Import the side effectful registration of <sp-help-text> via:

import '@spectrum-web-components/help-text/sp-help-text.js';

When looking to leverage the HelpText base class as a type and/or for extension purposes, do so via:

import { HelpText } from '@spectrum-web-components/help-text';

Sizes #

Small 
<sp-help-text size="s">Passwords must be at least 8 characters.</sp-help-text>
 Medium 
<sp-help-text size="m">Passwords must be at least 8 characters.</sp-help-text>
 Large 
<sp-help-text size="l">Passwords must be at least 8 characters.</sp-help-text>
 Extra Large 
<sp-help-text size="xl">Passwords must be at least 8 characters.</sp-help-text>

Negative #

The negative variant of <sp-help-text> is used to convey error messages. An error message should be different than the informative message otherwise delivers to the visitor and should show a solution for correcting the error that has been encountered.

<sp-help-text variant="negative">
    Create a password with at least 8 characters.
</sp-help-text>

Icon #

When associated with content that does not supply an icon outlining the presence of an error, use the icon attribute to display one as part of the <sp-help-text> element.

<sp-help-text variant="negative" icon>
    Create a password with at least 8 characters.
</sp-help-text>

Disabled #

When associated to content the is disabled, use the disabled attribute to match the delivery of the <sp-help-text> element to that content.

<sp-help-text disabled>Passwords must be at least 8 characters.</sp-help-text>