Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
@spectrum-web-components/help-text
Advanced tools
Web component implementation of a Spectrum design HelpText
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.
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';
<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>
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>
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>
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>
FAQs
Web component implementation of a Spectrum design HelpText
We found that @spectrum-web-components/help-text demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.