Skip to content

Properties

PropertyTypeDescription
elementReact.Element(optional) Define what HTML or React element should be used (e.g. element={Link}). Defaults to semantic a element.
hrefstring(optional) Relative or absolute url.
tostring(optional) Use this prop only if you are using a router Link component as the element that uses the to property to declare the navigation url.
targetstring(optional) Defines the opening method. Use _blank to open a new browser window/tab.
targetBlankTitlestring(optional) The title shown as a tooltip when target is set to _blank.
tooltipstring(optional) Provide a string or a React Element to be shown as the tooltip content.
iconReact.Node(optional) Primary Icons can be set as a string (e.g. icon="chevron_right"), other icons should be set as React elements.
iconPositionstring(optional) left (default) or right. Places icon to the left or to the right of the text.
noAnimationboolean(optional) Removes animations if set to true. Defaults to false.
noHoverboolean(optional) Removes hover effects if set to true. Defaults to false.
noStyleboolean(optional) Removes styling if set to true. Defaults to false.
noUnderlineboolean(optional) Removes underline if set to true. Defaults to false.
skeletonboolean(optional) If set to true, an overlaying skeleton with animation will be shown.
Spacestring
object
(optional) Spacing properties like top or bottom are supported.

Router Link

You can make use of the element property in combination with the to property.

import { Link } from 'gatsby'
render(
<Anchor to="/url" element={Link}>
Link
</Anchor>,
)