No Preview

Sorry, but you either have no stories or none are selected somehow.

If the problem persists, check the browser console, or the terminal you've run Storybook from.

The component failed to render properly, likely due to a configuration issue in Storybook. Here are some common causes and how you can address them:

  1. Missing Context/Providers: You can use decorators to supply specific contexts or providers, which are sometimes necessary for components to render correctly. For detailed instructions on using decorators, please visit the Decorators documentation.
  2. Misconfigured Webpack or Vite: Verify that Storybook picks up all necessary settings for loaders, plugins, and other relevant parameters. You can find step-by-step guides for configuring Webpack or Vite with Storybook.
  3. Missing Environment Variables: Your Storybook may require specific environment variables to function as intended. You can set up custom environment variables as outlined in the Environment Variables documentation.

TextLink

The TextLink component renders an anchor tag <a> that takes users to another page, external or internal to Grafana.

In this documentation you can find:

  1. Usage
  2. Types
  3. Behaviour
    4.1. Inline
    4.2. Standalone
    4.3. Icons
  4. Props table
  5. Related


Usage


When to use

  • To redirect the user to another page, external or internal
  • When redirecting the user through a link in a word or phrase within a paragraph.
  • When redirecting the user through a link in a word or phrase, not within a paragraph but surrounded by other blocks of text.

When not to use

  • When its purpose is to trigger an action, please use a Button or IconButton component
  • When it still redirects the user but it should have the same appearance as a button, please use the LinkButton component.
  • When the link is just comprised by an icon use IconButton component.

Do’s

  • Use the default styles as the first and main option as they are though to be accessible and consistent.
  • Use the external icon (the default one) when the TextLink goes to an external page as its meaning is broadly known.
  • In case the default icon does not fit, please use one of the icons of our library.

Don’ts

  • Do not use ‘primary’ color in a standalone link unless it is a special use case such as the ‘Dashboard list’, menu items or similar.

  • Do not override any styles in any way. Instead, ask the Design System team for an improvement of this component.

  • Do not attempt to add a new icon. You should fulfil a contribution path to first add the icon to our Design System and then use it in this component.



Types

Within Grafana, there are two different types of text links, 'inline' or 'standalone', whether they are wrapped by text or being a standalone element.

  • Inline: It is part of a broader text. It will be surrounded by text, before, after or in both directions. Although it can show an icon at its end, we advise not to do that.
  • Standalone: It is a block not surrounded immediately by more text.

Subtypes

Both inline or standalone text links will redirect the user to a specific page, therefore, depending on this they can be internal or external.

  • Internal: Redirect the user to a page inside Grafana.

  • External: Redirect the user to a page outside Grafana. The page will open on a new window. By default, an external text link will show the ‘external-link-alt’ icon.



Behaviour

The following is the default behaviour and so, it will be applied according to its type.

Inline:

  • Initial appearence: Blue and underlined at first.
  • On hover: blue and not underlined
For more information see Grafana.com

Standalone:

  • Initial appearence: Blue and not underlined at first.
  • On hover: blue and underlined.

Example: We should take into account that through the color prop the user will be able to change this value, but the rest will be kept. So, in this example, if the user renders an external and standalone text link setting the color value to 'primary' the result will be a text link 'white' in dark theme or 'black' in light theme, as set by the user, and not underlined at first while blue and underlined when onhover, as it inherits from the standalone default behaviour.

This an external standalone link example
<TextLink href="https://google.es" color="primary" inline={false} external>
  This an external standalone link example
</TextLink>

Icons:

By default, external text links will show an external-alt-icon. If by design reasons, the user needs to set another icon it can be done through the correspondent prop.

This an external with the default icon
<TextLink href="https://google.es" external>
  This an external with the default icon
</TextLink>

Both, external and internal links can show a specific icon using the icon prop.

This an external with a specific icon
<TextLink href="https://google.es" icon="google" external>
  This an external with a specific icon
</TextLink>

Props table

NameDescriptionDefault
href*
url to which redirect the user, external or internal
string
-
color
Color to use for text
"link""primary""secondary""disabled""maxContrast"
"link"
external
Specify if the link will redirect users to a page in or out Grafana
boolean
false
inline
True when the link will be displayed inline with surrounding text, false if it will be displayed as a block. Depending on this prop correspondant default styles will be applied
boolean
true
variant
The default variant is 'body'. To fit another styles set the correspondent variant as it is necessary also to adjust the icon size. code is excluded, as it is not fit for links.
"body""h1""h2""h3""h4""h5""h6""bodySmall"
"body"
weight
Override the default weight for the used variant
"medium""bold""light""regular"
-
icon
Set the icon to be shown. An external link will show the 'external-link-alt' icon as default.
"play""google""microsoft""github""gitlab""okta""discord""hipchat"
-

Links to related components: