@visual-framework/vf-link

2.0.1 • Public • Published

Link component

npm version

About

Links are used to help users navigate to new sections, pages or websites. Links have default, hover and selected states which provide visual cues to help the user interact with them or identify visited pages.

Usage

The label of a link should describe clearly the destination of the link. It should make sense to the user with little or no need to check other elements for context. Avoid non descriptive labels such as “click here” and “read more”.

Consider a user who scans through the content or uses a screen reader, how much information can they get from the link’s description alone? Use this principle as a guideline to create more descriptive links.

Avoid opening links in a new tab or window. It can be disorienting and can cause accessibility issues for people who cannot visually perceive that the new tab has opened.

When to use

Links should be used to help a user navigate to pages, sections or external websites.

When not to use

Links should not be used to initiate actions, change or manipulate data. Use vf-button instead for such actions.

Related documentation

For more information on links please consult the following documents:

Accessibility

This component targets WCAG 2.1 AA accessibility.

Install

This component is distributed with npm. After installing npm, you can install the vf-link with this command.

$ yarn add --dev @visual-framework/vf-link

Sass/CSS

The source files included are written in Sass(scss). You can point your Sass include-path at your node_modules directory and import it like this.

@import "@visual-framework/vf-link/index.scss";

Make sure you import Sass requirements along with the modules. You can use a project boilerplate or the vf-sass-starter

Help

Versions

Current Tags

  • Version
    Downloads (Last 7 Days)
    • Tag
  • 2.0.1
    365
    • latest

Version History

Package Sidebar

Install

npm i @visual-framework/vf-link

Weekly Downloads

440

Version

2.0.1

License

Apache 2.0

Unpacked Size

25.8 kB

Total Files

13

Last publish

Collaborators

  • bhushan-ebi
  • pacope92
  • ebiwebdev
  • sandykadam
  • khawkins98